@riil-frontend/component-column-configurator-drawer

1.0.14-a.2 • Public • Published

ColumnConfiguratorDrawer

column-configurator-drawer

列配置抽屉组件(UI) 经配置器配置后的列数据,每条列数据内将被注入 hidden:boolean 属性,用以标识是否显示该列;列数据中写入 hiddenDisabled:true 属性,标记该列为禁止隐藏操作列。

onChange 返回数据集为全部数据集,由使用者通过 hidden 自行过滤显示项

###注意 maxSelectCount,minSelectCount 不支持同时使用

API

参数名 说明 必填 类型 默认值 备注
columns 列配置数据 必填 Array - Table 所需的列数据
onChange 点击确认后回调 必填 (columns:array)=>{} - 点击 ok 后的回调函
group 待选列表分组信息 - array - [{name:'xxx',children:[dataIndex1,dataIndex2,...]}]
hasSearch 是否启用待选搜索功能 - boolean true
hasSelectAll 是否启用全选/全部取消 - boolean true
maxSelectCount 最大选择个数,不能和 minSelectCount 同时使用。设置此项,强制不显示全部选择/全部取消按钮 - number - 最多可勾选几项,达到后其他项禁用勾选。启动此属性后,全选按钮将被取消
minSelectCount 最少选择个数 ,不能和 maxSelectCount 同时使用。设置此项,强制不显示全部选择/全部取消按钮 - number - 最少可勾选几项,达到后其他项禁用取消勾选。启动此属性后,全选按钮将被取消
hasDefault 是否显示恢复默认按钮 - boolean true
onDefaultClick 点击恢复默认按钮回调 - ()=>{} -
hasReset 是否显示重置按钮 - boolean true
visible 是否显示抽屉组件 必填 boolean false
title 抽屉标题 - string "配置显示字段"
onClose 抽屉关闭按钮回调 - ()=>{}
drawerProps 透传覆写抽屉属性 - object { closeMode:'close' }
defaultColumns 用来作为恢复默认和待选项排序用的初始列配置数据,若不设置,则已选项按照 columns 顺序显示,点击恢复默认出发回调函数 onDefaultClick - array - [{dataIndex:"xxx"},...]
innerTitle 内部标题文案 - string '显示字段'

column 数据

参数名 说明 必填 类型 默认值 备注
hidden 隐藏/显示 - boolean false 不填写此属性,默认为显示该列
hiddenDisabled 禁用隐藏/显示操作 - boolean false 不填写此属性,默认为可以进行隐藏/显示操作
fixedIndex 设置此值的项,不参与排序 - number -
dataIndex 列唯一标示符 必填 string -
title 列显示名称 必填 string -
mode 组件展示形态 - string normal normal 正常展示形态 simple 简单展示形态

Readme

Keywords

Package Sidebar

Install

npm i @riil-frontend/component-column-configurator-drawer

Weekly Downloads

5

Version

1.0.14-a.2

License

MIT

Unpacked Size

2.16 MB

Total Files

27

Last publish

Collaborators

  • riil-frontend