固定条组件

固定条组件 fixbar 是指当滚动条滑动时,始终固定在页面一侧的工具条元素,除了内置的 TOP 条功能外,还可以灵活地扩展任意自定义的工具条。在 2.x 版本中,fixbar 属于 util 模块的子集。

示例

  

API

API 描述
var util = layui.util 获得 util 模块。
util.fixbar(options) fixbar 组件渲染,核心方法。

渲染

util.fixbar(options);

属性

属性名 描述 类型 默认值
bars 2.8+

设置固定工具条列表。可支持定义以下子属性:

bars: [
  {
    type: '', // bar 类型名,用于事件区分
    icon: '', // bar 图标的 className
    content: '', // bar 任意内容
    style: '' // bar 任意样式
  },
  // …
]

该属性比较灵活,具体用法可参考:#示例

array

default 2.8+

是否显示默认的固定条 ,如 top (点击可让滚动条置顶)等

boolean

true

bgcolor

固定条的默认背景色

string -
css

工具条外层容器的任意 css 属性。如设置工具条的坐标:

css: {right: 32, bottom: 32}
object -
target 2.8+

插入固定条的目标元素选择器

object

body

scroll 2.8+

固定条最外层容器滚动条所在的元素,若不设置则默认取 target 属性值

object

body

margin 2.8+

用于设置默认 TOP 条出现滚动条的高度临界值

number

200

duration 2.8+

用于默认 TOP 条等动画时长

number

200

on 2.8+

用于定义固定条列表的任意事件,触发事件时的回调将返回 bars 属性的 type 值。

on: {
  // 点击事件
  click: function(type){
    // bars 对属性应的 type 值
    console.log(type);
  },
  // …
}

该属性一般与 bars 属性搭配使用,具体用法可参考:#示例

object -

贴士

灵活运用 bars 属性的 content,style 子属性,可实现更多丰富多样的固定条。