C-FED / intro-plugin

This a plugin of introduce website

intro-plugin

This a plugin of introduce website

Example

check this file dist/index.html

Import

    <!-- import css  -->
    <link href=./dist/css/Intro.min.css rel=stylesheet />
    <!-- import js -->
    <script src=./dist/Intro.min.js></script>
    <div id="app" class="container">
        <!-- data-step 序号 (从1开始) -->
        <!-- data-intro 提示信息 -->
        <!-- data-required 必须（设置此项后，无法跳过此步引导，需要手动触发next方法） -->
        <div class="item" data-step="1" data-intro="为了更好地推荐成果、学者、群组，请您填写基本信息！">
            啦啦啦啦
        </div>
        <div class="item" data-step="2" data-intro="为了更好地推荐成果、学者、群组，请您填写基本信息！">
            啦啦啦啦
        </div>
    </div>
    <script>
        let intro=new Intro("#app",{
            refreshToTop:true
        });
    <script>

API

new Intro(el[,config]);

参数	说明	类型	默认值
el	容器	string	--
config	配置	object	见下面的config

config

参数	说明	类型	默认值
except	不参与引导的元素白名单，(默认是不可点击页面上的任何元素)	string[]	[]
isCanScroll	是否可以滚动	boolean	false
refreshToTop	刷新页面后是否回到页面顶部	boolean	false

method

方法名	说明	参数
next	无参数默认进行下一步，(参数 从1开始)	Function(index?)
skip	跳过引导	--
destory	销毁Intro实例	--

MIT license

Copyright (c) 2018 yangfan2016 <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---

built upon love by docor v0.3.0