@faasjs/ant-design 0.0.3-beta.15 → 0.0.3-beta.17

package/README.md

@@ -43,33 +43,37 @@ Form are based on [Ant Design's Form.Item component](https://ant.design/componen
 
 - [Form](modules/Form.md)
 
+### Interfaces
+
+- [BaseItemProps](interfaces/BaseItemProps.md)
+- [BlankProps](interfaces/BlankProps.md)
+- [ConfigProviderProps](interfaces/ConfigProviderProps.md)
+- [DescriptionItemContentProps](interfaces/DescriptionItemContentProps.md)
+- [DescriptionItemProps](interfaces/DescriptionItemProps.md)
+- [DescriptionProps](interfaces/DescriptionProps.md)
+- [DrawerProps](interfaces/DrawerProps.md)
+- [ExtendDescriptionTypeProps](interfaces/ExtendDescriptionTypeProps.md)
+- [FaasItemProps](interfaces/FaasItemProps.md)
+- [FormItemProps](interfaces/FormItemProps.md)
+- [FormProps](interfaces/FormProps.md)
+- [LinkProps](interfaces/LinkProps.md)
+- [ModalProps](interfaces/ModalProps.md)
+- [RoutesProps](interfaces/RoutesProps.md)
+- [TableItemProps](interfaces/TableItemProps.md)
+- [TitleProps](interfaces/TitleProps.md)
+
 ### Type Aliases
 
-- [BaseItemProps](#baseitemprops)
 - [BaseOption](#baseoption)
-- [BlankProps](#blankprops)
-- [ConfigProviderProps](#configproviderprops)
-- [DescriptionItemProps](#descriptionitemprops)
-- [DescriptionProps](#descriptionprops)
-- [DrawerProps](#drawerprops)
 - [ExtendDescriptionItemProps](#extenddescriptionitemprops)
-- [ExtendDescriptionTypeProps](#extenddescriptiontypeprops)
 - [ExtendFormItemProps](#extendformitemprops)
 - [ExtendFormTypeProps](#extendformtypeprops)
 - [ExtendTableItemProps](#extendtableitemprops)
 - [ExtendTableTypeProps](#extendtabletypeprops)
 - [ExtendTypes](#extendtypes)
-- [FaasItemProps](#faasitemprops)
 - [FaasItemType](#faasitemtype)
 - [FaasItemTypeValue](#faasitemtypevalue)
-- [FormItemProps](#formitemprops)
-- [FormProps](#formprops)
-- [LinkProps](#linkprops)
-- [ModalProps](#modalprops)
-- [RoutesProps](#routesprops)
-- [TableItemProps](#tableitemprops)
 - [TableProps](#tableprops)
-- [TitleProps](#titleprops)
 - [setDrawerProps](#setdrawerprops)
 - [setModalProps](#setmodalprops)
 
@@ -97,126 +101,21 @@ Form are based on [Ant Design's Form.Item component](https://ant.design/componen
 
 ## Type Aliases
 
-### BaseItemProps
-
-Ƭ **BaseItemProps**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `id` | `string` |
-| `options?` | [`BaseOption`](#baseoption)[] |
-| `title?` | `string` |
-
-___
-
 ### BaseOption
 
 Ƭ **BaseOption**: `string` \| `number` \| { `label`: `string` ; `value?`: `string` \| `number`  }
 
 ___
 
-### BlankProps
-
-Ƭ **BlankProps**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `text?` | `string` |
-| `value?` | `any` |
-
-___
-
-### ConfigProviderProps
-
-Ƭ **ConfigProviderProps**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `Blank?` | { `text?`: `string`  } |
-| `Blank.text?` | `string` |
-| `Form?` | { `submit?`: { `text?`: `string`  }  } |
-| `Form.submit?` | { `text?`: `string`  } |
-| `Form.submit.text?` | `string` |
-| `Link?` | { `style?`: `CSSProperties` ; `target?`: `string`  } |
-| `Link.style?` | `CSSProperties` |
-| `Link.target?` | `string` |
-| `Title?` | { `separator?`: `string` ; `suffix?`: `string`  } |
-| `Title.separator?` | `string` |
-| `Title.suffix?` | `string` |
-| `antd?` | `AntdConfigProviderProps` |
-| `common?` | { `add?`: `string` ; `all?`: `string` ; `blank?`: `string` ; `delete?`: `string` ; `pageNotFound?`: `string` ; `required?`: `string` ; `reset?`: `string` ; `search?`: `string` ; `submit?`: `string`  } |
-| `common.add?` | `string` |
-| `common.all?` | `string` |
-| `common.blank?` | `string` |
-| `common.delete?` | `string` |
-| `common.pageNotFound?` | `string` |
-| `common.required?` | `string` |
-| `common.reset?` | `string` |
-| `common.search?` | `string` |
-| `common.submit?` | `string` |
-| `lang?` | `string` |
-
-___
-
-### DescriptionItemProps
-
-Ƭ **DescriptionItemProps**<`T`\>: { `children?`: `JSX.Element` ; `if?`: (`values`: `Record`<`string`, `any`\>) => `boolean` ; `render?`: (`value`: `T`, `values`: `any`) => `ReactNode` \| `JSX.Element`  } & [`FaasItemProps`](#faasitemprops) & { `object?`: [`DescriptionItemProps`](#descriptionitemprops)[]  }
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | `any` |
-
-___
-
-### DescriptionProps
-
-Ƭ **DescriptionProps**<`T`, `ExtendItemProps`\>: { `dataSource?`: `T` ; `extendTypes?`: { `[key: string]`: [`ExtendDescriptionTypeProps`](#extenddescriptiontypeprops);  } ; `faasData?`: `FaasDataWrapperProps`<`T`\> ; `items`: ([`DescriptionItemProps`](#descriptionitemprops) \| `ExtendItemProps`)[] ; `renderTitle?`: (`values`: `T`) => `ReactNode` \| `JSX.Element`  } & `DescriptionsProps`
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | `any` |
-| `ExtendItemProps` | `any` |
-
-___
-
-### DrawerProps
-
-Ƭ **DrawerProps**: `AntdDrawerProps` & { `children?`: `JSX.Element` \| `JSX.Element`[]  }
-
-___
-
 ### ExtendDescriptionItemProps
 
-Ƭ **ExtendDescriptionItemProps**: [`BaseItemProps`](#baseitemprops)
-
-___
-
-### ExtendDescriptionTypeProps
-
-Ƭ **ExtendDescriptionTypeProps**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `children?` | `JSX.Element` \| ``null`` |
-| `render?` | (`value`: `any`, `values`: `any`) => `ReactNode` \| `JSX.Element` |
+Ƭ **ExtendDescriptionItemProps**: [`BaseItemProps`](interfaces/BaseItemProps.md)
 
 ___
 
 ### ExtendFormItemProps
 
-Ƭ **ExtendFormItemProps**: [`BaseItemProps`](#baseitemprops) & `AntdFormItemProps`
+Ƭ **ExtendFormItemProps**: [`BaseItemProps`](interfaces/BaseItemProps.md) & `AntdFormItemProps`
 
 ___
 
@@ -234,7 +133,7 @@ ___
 
 ### ExtendTableItemProps
 
-Ƭ **ExtendTableItemProps**<`T`\>: [`BaseItemProps`](#baseitemprops) & `Omit`<`AntdTableColumnProps`<`T`\>, ``"children"``\>
+Ƭ **ExtendTableItemProps**<`T`\>: [`BaseItemProps`](interfaces/BaseItemProps.md) & `Omit`<`AntdTableColumnProps`<`T`\>, ``"children"``\>
 
 #### Type parameters
 
@@ -252,7 +151,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `children?` | `JSX.Element` \| ``null`` |
+| `children?` | `JSX.Element` |
 | `render?` | (`value`: `any`, `values`: `any`, `index`: `number`) => `JSX.Element` \| `string` \| `number` \| `boolean` \| ``null`` |
 
 ___
@@ -267,12 +166,6 @@ ___
 
 ___
 
-### FaasItemProps
-
-Ƭ **FaasItemProps**: [`BaseItemProps`](#baseitemprops) & { `type?`: [`FaasItemType`](#faasitemtype)  }
-
-___
-
 ### FaasItemType
 
 Ƭ **FaasItemType**: ``"string"`` \| ``"string[]"`` \| ``"number"`` \| ``"number[]"`` \| ``"boolean"`` \| ``"date"`` \| ``"time"`` \| ``"object"`` \| ``"object[]"``
@@ -301,83 +194,9 @@ FaasItemType's value type
 
 ___
 
-### FormItemProps
-
-Ƭ **FormItemProps**<`T`\>: { `children?`: `ReactNode` ; `extendTypes?`: [`ExtendTypes`](#extendtypes) ; `if?`: (`values`: `Record`<`string`, `any`\>) => `boolean` ; `label?`: `string` \| ``false`` ; `onValueChange?`: (`value`: `T`, `values`: `any`, `form`: `FormInstance`) => `void` ; `render?`: (`value?`: `T`) => `ReactNode` \| `JSX.Element` ; `rules?`: `RuleObject`[]  } & `FormItemInputProps` & [`FaasItemProps`](#faasitemprops) & `Omit`<`AntdFormItemProps`<`T`\>, ``"children"``\>
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | `any` |
-
-___
-
-### FormProps
-
-Ƭ **FormProps**<`Values`, `ExtendItemProps`\>: { `beforeItems?`: `JSX.Element` \| `JSX.Element`[] ; `children?`: `ReactNode` ; `extendTypes?`: [`ExtendTypes`](#extendtypes) ; `footer?`: `JSX.Element` \| `JSX.Element`[] ; `initialValues?`: `Values` ; `items?`: ([`FormItemProps`](#formitemprops) \| `ExtendItemProps` \| `JSX.Element`)[] ; `onFinish?`: (`values`: `Values`, `submit?`: (`values`: `any`) => `Promise`<`any`\>) => `Promise`<`any`\> ; `submit?`: ``false`` \| { `text?`: `string` ; `to?`: { `action`: `string` ; `params?`: `Record`<`string`, `any`\>  }  }  } & `Omit`<`AntdFormProps`<`Values`\>, ``"onFinish"`` \| ``"children"`` \| ``"initialValues"``\>
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `Values` | extends `Record`<`string`, `any`\> = `any` |
-| `ExtendItemProps` | `any` |
-
-___
-
-### LinkProps
-
-Ƭ **LinkProps**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `button?` | `ButtonProps` |
-| `children?` | `ReactNode` |
-| `href` | `string` |
-| `style?` | `CSSProperties` |
-| `target?` | `string` |
-| `text?` | `string` \| `number` |
-
-___
-
-### ModalProps
-
-Ƭ **ModalProps**: `AntdModalProps` & { `children?`: `JSX.Element` \| `JSX.Element`[] \| `string`  }
-
-___
-
-### RoutesProps
-
-Ƭ **RoutesProps**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `fallback?` | `JSX.Element` |
-| `notFound?` | `JSX.Element` |
-| `routes` | `RouteProps` & { `page?`: `LazyExoticComponent`<`ComponentType`<`any`\>\>  }[] |
-
-___
-
-### TableItemProps
-
-Ƭ **TableItemProps**<`T`\>: { `children?`: `JSX.Element` \| ``null`` ; `object?`: [`TableItemProps`](#tableitemprops)[] ; `optionsType?`: ``"auto"``  } & [`FaasItemProps`](#faasitemprops) & `Omit`<`AntdTableColumnProps`<`T`\>, ``"children"``\>
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | `any` |
-
-___
-
 ### TableProps
 
-Ƭ **TableProps**<`T`, `ExtendTypes`\>: { `extendTypes?`: { `[key: string]`: [`ExtendTableTypeProps`](#extendtabletypeprops);  } ; `faasData?`: `FaasDataWrapperProps`<`T`\> ; `items`: ([`TableItemProps`](#tableitemprops) \| `ExtendTypes` & [`ExtendTableItemProps`](#extendtableitemprops))[] ; `onChange?`: (`pagination`: `TablePaginationConfig`, `filters`: `Record`<`string`, `FilterValue` \| ``null``\>, `sorter`: `SorterResult`<`T`\> \| `SorterResult`<`T`\>[], `extra`: `TableCurrentDataSource`<`T`\>) => { `extra`: `TableCurrentDataSource`<`T`\> ; `filters`: `Record`<`string`, `FilterValue` \| ``null``\> ; `pagination`: `TablePaginationConfig` ; `sorter`: `SorterResult`<`T`\> \| `SorterResult`<`T`\>[]  }  } & `AntdTableProps`<`T`\>
+Ƭ **TableProps**<`T`, `ExtendTypes`\>: { `extendTypes?`: { `[key: string]`: [`ExtendTableTypeProps`](#extendtabletypeprops);  } ; `faasData?`: `FaasDataWrapperProps`<`T`\> ; `items`: ([`TableItemProps`](interfaces/TableItemProps.md) \| `ExtendTypes` & [`ExtendTableItemProps`](#extendtableitemprops))[] ; `onChange?`: (`pagination`: `TablePaginationConfig`, `filters`: `Record`<`string`, `FilterValue` \| ``null``\>, `sorter`: `SorterResult`<`T`\> \| `SorterResult`<`T`\>[], `extra`: `TableCurrentDataSource`<`T`\>) => { `extra`: `TableCurrentDataSource`<`T`\> ; `filters`: `Record`<`string`, `FilterValue` \| ``null``\> ; `pagination`: `TablePaginationConfig` ; `sorter`: `SorterResult`<`T`\> \| `SorterResult`<`T`\>[]  }  } & `AntdTableProps`<`T`\>
 
 #### Type parameters
 
@@ -388,26 +207,9 @@ ___
 
 ___
 
-### TitleProps
-
-Ƭ **TitleProps**: `Object`
-
-#### Type declaration
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `children?` | `JSX.Element` | return children |
-| `h1?` | `boolean` \| { `className?`: `string` ; `style?`: `React.CSSProperties`  } | return a h1 element |
-| `plain?` | `boolean` | return a pure text element |
-| `separator?` | `string` | ` - ` as default |
-| `suffix?` | `string` | - |
-| `title` | `string` \| `string`[] | - |
-
-___
-
 ### setDrawerProps
 
-Ƭ **setDrawerProps**: (`changes`: `Partial`<[`DrawerProps`](#drawerprops)\>) => `void`
+Ƭ **setDrawerProps**: (`changes`: `Partial`<[`DrawerProps`](interfaces/DrawerProps.md)\>) => `void`
 
 #### Type declaration
 
@@ -417,7 +219,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `changes` | `Partial`<[`DrawerProps`](#drawerprops)\> |
+| `changes` | `Partial`<[`DrawerProps`](interfaces/DrawerProps.md)\> |
 
 ##### Returns
 
@@ -427,7 +229,7 @@ ___
 
 ### setModalProps
 
-Ƭ **setModalProps**: (`changes`: `Partial`<[`ModalProps`](#modalprops)\>) => `void`
+Ƭ **setModalProps**: (`changes`: `Partial`<[`ModalProps`](interfaces/ModalProps.md)\>) => `void`
 
 #### Type declaration
 
@@ -437,7 +239,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `changes` | `Partial`<[`ModalProps`](#modalprops)\> |
+| `changes` | `Partial`<[`ModalProps`](interfaces/ModalProps.md)\> |
 
 ##### Returns
 
@@ -447,7 +249,7 @@ ___
 
 ### ConfigContext
 
-• `Const` **ConfigContext**: `Context`<[`ConfigProviderProps`](#configproviderprops)\>
+• `Const` **ConfigContext**: `Context`<[`ConfigProviderProps`](interfaces/ConfigProviderProps.md)\>
 
 ## Functions
 
@@ -461,7 +263,7 @@ If value is undefined or null, return text, otherwise return value.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `options?` | [`BlankProps`](#blankprops) | {object} |
+| `options?` | [`BlankProps`](interfaces/BlankProps.md) | {object} |
 
 #### Returns
 
@@ -495,7 +297,7 @@ Config for @faasjs/ant-design components.
 | :------ | :------ |
 | `«destructured»` | `Object` |
 | › `children` | `ReactNode` |
-| › `config` | [`ConfigProviderProps`](#configproviderprops) |
+| › `config` | [`ConfigProviderProps`](interfaces/ConfigProviderProps.md) |
 
 #### Returns
 
@@ -517,7 +319,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `props` | [`DescriptionProps`](#descriptionprops)<`T`, `any`\> |
+| `props` | [`DescriptionProps`](interfaces/DescriptionProps.md)<`T`, `any`\> |
 
 #### Returns
 
@@ -545,7 +347,7 @@ https://ant.design/components/form/
 
 | Name | Type |
 | :------ | :------ |
-| `props` | [`FormProps`](#formprops)<`Values`, `any`\> |
+| `props` | [`FormProps`](interfaces/FormProps.md)<`Values`, `any`\> |
 
 #### Returns
 
@@ -579,7 +381,7 @@ FormItem, can be used without Form.
 
 | Name | Type |
 | :------ | :------ |
-| `props` | [`FormItemProps`](#formitemprops)<`T`\> |
+| `props` | [`FormItemProps`](interfaces/FormItemProps.md)<`T`\> |
 
 #### Returns
 
@@ -603,7 +405,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `«destructured»` | [`LinkProps`](#linkprops) |
+| `«destructured»` | [`LinkProps`](interfaces/LinkProps.md) |
 
 #### Returns
 
@@ -647,7 +449,7 @@ export function App () {
 
 | Name | Type |
 | :------ | :------ |
-| `props` | [`RoutesProps`](#routesprops) |
+| `props` | [`RoutesProps`](interfaces/RoutesProps.md) |
 
 #### Returns
 
@@ -708,7 +510,7 @@ Return null by default.
 
 | Name | Type |
 | :------ | :------ |
-| `props` | [`TitleProps`](#titleprops) |
+| `props` | [`TitleProps`](interfaces/TitleProps.md) |
 
 #### Returns
 
@@ -751,11 +553,11 @@ ___
 
 ### useConfigContext
 
-▸ **useConfigContext**(): [`ConfigProviderProps`](#configproviderprops)
+▸ **useConfigContext**(): [`ConfigProviderProps`](interfaces/ConfigProviderProps.md)
 
 #### Returns
 
-[`ConfigProviderProps`](#configproviderprops)
+[`ConfigProviderProps`](interfaces/ConfigProviderProps.md)
 
 ___
 
@@ -769,7 +571,7 @@ Hook style drawer.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `init?` | [`DrawerProps`](#drawerprops) | initial props ```ts function Example() { const { drawer, setDrawerProps } = useDrawer() return <> <Button onClick={ () => setDrawerProps(prev => ({ open: !prev.open})) }> Toggle </Button> {drawer} </> } ``` |
+| `init?` | [`DrawerProps`](interfaces/DrawerProps.md) | initial props ```ts function Example() { const { drawer, setDrawerProps } = useDrawer() return <> <Button onClick={ () => setDrawerProps(prev => ({ open: !prev.open})) }> Toggle </Button> {drawer} </> } ``` |
 
 #### Returns
 
@@ -778,8 +580,8 @@ Hook style drawer.
 | Name | Type |
 | :------ | :------ |
 | `drawer` | `Element` |
-| `drawerProps` | [`DrawerProps`](#drawerprops) |
-| `setDrawerProps` | (`changes`: `Partial`<[`DrawerProps`](#drawerprops)\>) => `void` |
+| `drawerProps` | [`DrawerProps`](interfaces/DrawerProps.md) |
+| `setDrawerProps` | (`changes`: `Partial`<[`DrawerProps`](interfaces/DrawerProps.md)\>) => `void` |
 
 ___
 
@@ -793,7 +595,7 @@ Hook style modal.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `init?` | [`ModalProps`](#modalprops) | initial props ```ts function Example() { const { modal, setModalProps } = useModal() return <> <Button onClick={() => setModalProps({ open: true })}>Open Modal</Button> {modal}</> } ``` |
+| `init?` | [`ModalProps`](interfaces/ModalProps.md) | initial props ```ts function Example() { const { modal, setModalProps } = useModal() return <> <Button onClick={() => setModalProps({ open: true })}>Open Modal</Button> {modal}</> } ``` |
 
 #### Returns
 
@@ -802,5 +604,5 @@ Hook style modal.
 | Name | Type |
 | :------ | :------ |
 | `modal` | `Element` |
-| `modalProps` | [`ModalProps`](#modalprops) |
-| `setModalProps` | (`changes`: `Partial`<[`ModalProps`](#modalprops)\>) => `void` |
+| `modalProps` | [`ModalProps`](interfaces/ModalProps.md) |
+| `setModalProps` | (`changes`: `Partial`<[`ModalProps`](interfaces/ModalProps.md)\>) => `void` |