@beisen-phoenix/field-select-list

@beisen-phoenix/field-select-list

Usage no npm install needed!

<script type="module">
  import beisenPhoenixFieldSelectList from 'https://cdn.skypack.dev/@beisen-phoenix/field-select-list';
</script>

README

选择列表

@beisen-phoenix/field-select-list

API

参数 说明 类型 默认值 必须
getPopupContainer 弹层挂载的容器(默认是挂载到 body 下,通过此函数可以改变弹层挂载的节点) Funtion () => document.body No
layerWidth 如果不选择下拉宽度自适应,可以使用此属性自己控制宽度 number -- No
size 选择框大小可配置 small 、large 、normal string normal No
zIndex 弹层的 z-index 值 number 1200 No
hasError 是否显示错误 boolean false No
isPreview 是否用于表单展示态 boolean false No
options 当前列表数据 IOption[] Yes
value 当前选中项列表,注意:onChange时需要同步此参数 IOption / IOption[] No
useSelectorSearch 是否使用选择器搜索 boolean false No
useListSearch 是否使用列表中搜索框,注意:如设置了useSelectorSearch为true,该属性则不生效 boolean false No
placeholder 显示搜索框时使用:搜索框中的默认提示文字 String 搜索 No
autoFocus useListSearch为true时使用:展开弹层时列表中搜索框是否自动获取焦点 boolean false
isLocalSearch 是否启用本地搜索,即在当前数据源中搜索 boolean true No
caseSensitive 搜索时是否大小写敏感 boolean false
multiple 是否多选 boolean false No
isGroup 是否分组 boolean false No
showCheckAll 非分组列表时使用:是否开启全选功能 boolean true No
loading 数据是否正在加载中 boolean false No
onChange 选择器值变化时的回调函数,注意:此回调中需要将返回的IOption / IOption[]赋值给value (IOption / IOption[]) => void Yes
onSearch 搜索框内容变化时调用 (value: string ) => void No
onListOpen 展开弹层时调用 () => void No
validateSearch 搜索值自定义验证器 (val: string) => { value: string, info: string,clearTipAfter?:number } No

IOption

传人的列表数据是数组,每一项的结构如下:

参数 说明 类型 默认值 必须
label 实际显示的文案 String Yes
value 选项的实际值 String 或 Number Yes
disabled 禁止该选项 boolean false No
selected 是否选中 String No
children 分组时使用 当前分组下的数据 String 或 Number No

多语言

参数 说明 类型 默认值
translation 语言包 用于翻译组件内置常量 {empty: "这里什么都没有...",confirm: '确定',checkAll: '全选', checkSearchAll: '全选搜索结果', placeholder: '搜索'}