mobile-more
Version:
基于 antd-mobile v5 扩展移动端 UI 组件
48 lines (47 loc) • 1.63 kB
TypeScript
import { CheckboxGroupProps, CheckboxProps, SpaceProps } from 'antd-mobile';
import * as React from 'react';
import { BizFormItemProps } from '../FormItem';
import './index.less';
declare const squareIcon: (checked: boolean) => React.JSX.Element;
type Option = {
label?: React.ReactNode;
value?: CheckboxProps['value'];
disabled?: boolean;
[key: string]: any;
};
export interface BizFormItemCheckboxProps extends Omit<BizFormItemProps, 'children'>, Pick<CheckboxProps, 'block' | 'icon'> {
/**
* @description 可选项。
*/
options: Option[];
/**
* @description 自定义 `label` `value` `disabled` 字段名。
*/
fieldNames?: {
label?: string;
value?: string;
disabled?: string;
};
/**
* @description 透传 Space 组件属性。
* @see {@link https://mobile.ant.design/zh/components/space#属性|SpaceProps}
*/
spaceProps?: SpaceProps;
/**
* @description 透传 Checkbox 组件属性。
* @see {@link https://mobile.ant.design/zh/components/checkbox#checkbox|CheckboxProps}
*/
checkboxProps?: CheckboxProps;
/**
* @description 透传 Checkbox.Group 组件属性。
* @see {@link https://mobile.ant.design/zh/components/checkbox#checkboxgroup|CheckboxGroupProps}
*/
checkboxGroupProps?: CheckboxGroupProps;
}
declare const BizFormItemCheckbox: React.FC<BizFormItemCheckboxProps> & {
/**
* @description 内置方形选框，便于自定义图标。可以直接传给 `icon` 属性配置。
*/
squareIcon: typeof squareIcon;
};
export default BizFormItemCheckbox;