banma-fusion-form
TypeScript icon, indicating that this package has built-in type declarations

1.3.1 • Public • Published

数字化门户-表单

说明

  • select类型默认设置有清除按钮
  • switch类型支持使用defaultValue、value设值
  • date、dateRange设值默认输出格式为YYYY-MM-DD,若设置 showTime 属性,输出格式为YYYY-MM-DD HH:mm:ss

备注: 日期、时间类型内部使用的组件是DatePicker2、TimePicker2组件

使用

banma-fusion-form

安装

npm install banma-fusion-form

API

BanmaForm

参数名 说明 必填 类型 默认值 备注
items 表单项 Item
columns 一行多少列 Number/ResponsiveGrid 1
gutter 列间距 Number 0
useLabelForErrorMessage 是否使用 label 替换校验信息的 name 字段 Boolean true
fullWidth 单个 Item 中表单类组件宽度是否是100% Boolean true
parseName 是否将name中.的字符串转换成对象,表单项items存在dynamic且未使用filed属性时必须设置true Boolean false
children 自定义 ReactNode

其他属性参考Fusion Form

ResponsiveGrid

参数名 说明 必填 类型 默认值 备注
l >=1200px 一行列数 Number
xl >=1500px 一行列数 Number
span 一行列数 Number

Item

参数名 说明 必填 类型 默认值 备注
label label 标签的文本 ReactNode
name 字段名 String
children 自定义 ReactNode
type 表单输入组件 input,select,switch,checkox,radio,textArea,password,date,dateRange,timePicker,timePickerRange,numberPicker input
showTime 是否使用时间控件,type=date/dateRange生效 Boolean false
dataSource type=select/checkbox/radio类型时数据源 Array
labelKey 使用dataSource时,展示的label取值 String label
valueKey 使用dataSource时,value key 值 String value
defaultValue 初始值 String/Number/Boolean type=switch使用时也生效
value 当前值 String/Number/Boolean type=switch使用时也生效
onChange 表单输入组件改变时触发此事件 Function
placeholder 输入提示 String
innerBefore 文字前附加内容,type=input时支持 ReactNode
innerAfter 文字后附加内容,type=input时支持 ReactNode
hint 输入框后提示信息 ReactNode
hidden 是否隐藏表单项 Boolean (item) => Boolean
addonAfter 表单后面添加自定义内容 ReactNode
items 表单项集合,表单项中渲染多个表单元素 Item v1.1.0
showSeparator 展示分隔符,存在items属性有效 Boolean v1.1.0
gutter 表单项之间间隔,存在items属性有效 Number 8 v1.1.0
dynamic 动态表单 Boolean false v1.2.0
minNum 动态表单最小数量,dynamic=true有效 Number v1.3.0
maxNum 动态表单最大数量,dynamic=true有效 Number v1.3.0
span 列宽度,使用方式同Grid.Col span Number v1.1.0
mode 选择器模式,type=select时支持 single', 'multiple', 'tag' single
typeProps 默认提取表单输入组件常用属性,使用该属性扩展表单输入组件其他属性 Object type=checkbox/radio时,属性设置到Checkbox.Group,Radio.Group
showSearch 展开后是否能搜索,type=select有效 Boolean
trim 去除头尾空字符,type=input有效 Boolean
hasClear 是否出现clear按钮,type=input有效 Boolean
minDate 最小日期,type=date、dateRange有效 Dayjs
maxDate 最大日期,type=date、dateRange有效 Dayjs
singleLine 一行多列情况下(columns > 1),设置当前项是否单独一行显示 Boolean

其他属性参考Fusion Form.Item

Readme

Keywords

Package Sidebar

Install

npm i banma-fusion-form

Weekly Downloads

0

Version

1.3.1

License

MIT

Unpacked Size

3.43 MB

Total Files

79

Last publish

Collaborators

  • chenpx