导航参数
-
nav_title
- 类型:
- String
- 描述:
- 导航标题。
- 示例:
-
nav_title : "欢迎使用 uguide"
-
nav_content
- 类型:
- String
- 描述:
- 导航说明文字。
- 示例:
-
nav_content : "查看引导请点击“开始浏览”,略过引导请点击“忽略”。"
-
nav_step_txt *
- 类型:
- Array 数组元素类型:String
- 描述:
- 导航步骤文字。这是一个核心参数。
- 示例:
-
nav_step_txt : [ "第一步", "第二步", "第三步" ]
-
nav_css
- 类型:
- Object
- 描述:
- 导航 css 样式。
- 示例:
-
nav_css : {
"width" : "860px",
"height" : "65px",
"padding" : "15px 20px",
"margin-left" : "-451px"
}
-
nav_slide_speed
- 类型:
- Number
- 描述:
- 导航下滑/上升持续时间(毫秒)。
- 示例:
-
nav_slide_speed : 600
-
nav_margin
- 类型:
- Number
- 描述:
- 导航与 <body> 的间距(当 body_down 为 true 时有效)。
- 示例:
-
nav_margin : 15
对话框参数
-
box_title
- 类型:
- Array 数组元素类型:String
- 描述:
- 每一步对话框标题。
- 示例:
-
box_title : [ "第一步的标题", "第二步的标题", "第三步的标题" ]
-
box_content
- 类型:
- Array 数组元素类型:String
- 描述:
- 每一步对话框内容数。
- 示例:
-
box_content : [
"<p>第一步的内容"</p>",
"<p>第二步的内容"</p>",
"<p>第三步的内容"</p>"
]
-
box_css
- 类型:
- Object
- 描述:
- 对话框的 css 样式。
- 示例:
-
box_css : {
"width" : "400px",
"background" : "#fff"
}
-
box_alone_css
- 类型:
- Array 数组元素类型:Object
- 描述:
- 单独设置一个或多个对话框的 css 样式。
- 示例:
-
// 设置第二个和第四个对话框为 fixed
box_alone_css : [ {}, {"position":"fixed"}, {}, {"position":"fixed"} ]
-
box_arrow
- 类型:
- Array 数组元素类型:String
- 描述:
-
对话框的箭头指向。
数组元素可选值:"top_left", "top_right", "right_top", "right_bottom", "bottom_right", "bottom_left", "left_bottom", "left_top"
数组元素默认值:"top_left"
设置为 "top_left" 或 "top_right" 时,箭头指向目标的左下角;
设置为 "right_top" 或 "right_bottom" 或 "bottom_right" 或 "bottom_left" 时,箭头指向目标的左上角;
设置为 "left_bottom" 或 left_top 时,箭头指向目标的右上角;
- 示例:
-
box_arrow : [ "", "top_right", "right_top", "", "right_bottom" ]
-
box_top
- 类型:
- Array 数组元素类型:Number
- 描述:
- 对话框的上偏移量。对话框会根据 box_arrow 给定粗略的位置,在这里可以设置更精确的上偏移量。
- 示例:
-
box_top : [ 0, 50, 100, 0 ]
-
box_left
- 类型:
- Array 数组元素类型:Number
- 描述:
- 对话框的左偏移量。对话框会根据 box_arrow 给定粗略的位置,在这里可以设置更精确的左偏移量。
- 示例:
-
box_top : [ 0, 50, 100, 0 ]
-
box_target *
- 类型:
- Array 数组元素类型:String
- 描述:
- 对话框指向的目标元素。必须是页面上唯一的元素,建议通过元素 id 获取。这是一个核心参数。
- 示例:
-
box_target : [ "#test h3:eq(0)", "#test2", "#test3" ]
-
box_template
- 类型:
- String
- 描述:
-
对话框皮肤。
可选值:"default", "diy"
默认值:"default"
- 示例:
-
box_template : [ "diy" ]
其他参数
-
autorun
- 类型:
- Boolean 默认值:false
- 描述:
- 自动开始第一步,不需要点击导航上的“开始浏览”。
- 示例:
-
autorun : true
-
show_nav
- 类型:
- Boolean 默认值:true
- 描述:
- 显示导航。
- 示例:
-
show_nav : false
-
body_down
- 类型:
- Boolean 默认值:true
- 描述:
- 显示导航。
- 示例:
-
show_nav : false
-
quick_close
- 类型:
- Boolean 默认值:false
- 描述:
- 点击“结束浏览”时直接关闭导航,不显示“重新浏览”。
- 示例:
-
show_nav : false
-
mask_z_index
- 类型:
- Number
- 描述:
-
遮罩层的 z-index 深度。同时,对话框的 z-index 将根据此值 + 11,导航的 z-index 将根据此值 + 21 .
例如,mask_z_index 值为 10,那么对话框的 z-index 为 21,导航的 z-index 为 31。
如果不希望如此,可以在 nav_css 和 box_css 参数中设置 z-index .
- 示例:
-
mask_z_index : 90
-
ugStart()
- 类型:
- Function
- 描述:
- 点击“开始浏览”时执行的函数(在对话框显示之前执行)。
- 示例:
-
ugStart : function () {
alert("start");
}
-
ugOver() *
- 类型:
- Function
- 描述:
- 点击“结束浏览”时执行的函数。可以在这里处理 ajax,或者 cookie,或者其他方式,以便下次浏览时不再显示引导。这是一个重要参数。
- 示例:
-
ugOver : function () {
alert("over");
}