@faasjs/ant-design 0.0.3-beta.23 → 0.0.3-beta.25

package/README.md

@@ -71,6 +71,8 @@ Form are based on [Ant Design's Form.Item component](https://ant.design/componen
 - [ExtendTableItemProps](#extendtableitemprops)
 - [ExtendTableTypeProps](#extendtabletypeprops)
 - [ExtendTypes](#extendtypes)
+- [FaasDataInjection](#faasdatainjection)
+- [FaasDataWrapperProps](#faasdatawrapperprops)
 - [FaasItemType](#faasitemtype)
 - [FaasItemTypeValue](#faasitemtypevalue)
 - [TableProps](#tableprops)
@@ -86,9 +88,11 @@ Form are based on [Ant Design's Form.Item component](https://ant.design/componen
 - [Blank](#blank)
 - [ConfigProvider](#configprovider)
 - [Description](#description)
+- [FaasDataWrapper](#faasdatawrapper)
 - [Form](#form)
 - [FormItem](#formitem)
 - [Link](#link)
+- [Loading](#loading)
 - [PageNotFound](#pagenotfound)
 - [Routes](#routes)
 - [Table](#table)
@@ -166,6 +170,61 @@ ___
 
 ___
 
+### FaasDataInjection
+
+Ƭ **FaasDataInjection**<`Data`\>: `Object`
+
+Injects FaasData props.
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Data` | `any` |
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `action` | `string` \| `any` |
+| `data` | `Data` |
+| `error` | `any` |
+| `loading` | `boolean` |
+| `params` | `Record`<`string`, `any`\> |
+| `promise` | `Promise`<`Response`<`Data`\>\> |
+| `setData` | `React.Dispatch`<`React.SetStateAction`<`Data`\>\> |
+| `setError` | `React.Dispatch`<`React.SetStateAction`<`any`\>\> |
+| `setLoading` | `React.Dispatch`<`React.SetStateAction`<`boolean`\>\> |
+| `setPromise` | `React.Dispatch`<`React.SetStateAction`<`Promise`<`Response`<`Data`\>\>\>\> |
+| `reload` | (`params?`: `Record`<`string`, `any`\>) => `Promise`<`Response`<`Data`\>\> |
+
+___
+
+### FaasDataWrapperProps
+
+Ƭ **FaasDataWrapperProps**<`PathOrData`\>: `Object`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `PathOrData` | extends `FaasAction` |
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `action` | `string` | - |
+| `children?` | `JSX.Element` | - |
+| `data?` | `FaasData`<`PathOrData`\> | use custom data, should work with setData |
+| `fallback?` | `JSX.Element` \| ``false`` | - |
+| `params?` | `FaasParams`<`PathOrData`\> | - |
+| `setData?` | `React.Dispatch`<`React.SetStateAction`<`FaasData`<`PathOrData`\>\>\> | use custom setData, should work with data |
+| `onDataChange?` | (`args`: [`FaasDataInjection`](#faasdatainjection)<`FaasData`<`PathOrData`\>\>) => `void` | - |
+| `render?` | (`args`: [`FaasDataInjection`](#faasdatainjection)<`FaasData`<`PathOrData`\>\>) => `Element` \| `Element`[] | - |
+
+___
+
 ### FaasItemType
 
 Ƭ **FaasItemType**: ``"string"`` \| ``"string[]"`` \| ``"number"`` \| ``"number[]"`` \| ``"boolean"`` \| ``"date"`` \| ``"time"`` \| ``"object"`` \| ``"object[]"``
@@ -196,7 +255,7 @@ ___
 
 ### TableProps
 
-Ƭ **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`\>
+Ƭ **TableProps**<`T`, `ExtendTypes`\>: { `extendTypes?`: { `[key: string]`: [`ExtendTableTypeProps`](#extendtabletypeprops);  } ; `faasData?`: [`FaasDataWrapperProps`](#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
 
@@ -257,6 +316,8 @@ ___
 
 ▸ **Blank**(`options?`): `JSX.Element`
 
+Blank component.
+
 If value is undefined or null, return text, otherwise return value.
 
 #### Parameters
@@ -309,6 +370,8 @@ ___
 
 ▸ **Description**<`T`\>(`props`): `Element`
 
+Description component.
+
 #### Type parameters
 
 | Name | Type |
@@ -327,6 +390,30 @@ ___
 
 ___
 
+### FaasDataWrapper
+
+▸ **FaasDataWrapper**<`T`\>(`props`): `JSX.Element`
+
+FaasDataWrapper component with Loading and ErrorBoundary
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | `any` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `props` | [`FaasDataWrapperProps`](#faasdatawrapperprops)<`T`\> |
+
+#### Returns
+
+`JSX.Element`
+
+___
+
 ### Form
 
 ▸ **Form**<`Values`\>(`props`): `Element`
@@ -393,12 +480,14 @@ ___
 
 ▸ **Link**(`«destructured»`): `Element`
 
+Link component with button.
+
 ```ts
 // pure link
 <Link href="/">Home</Link>
 
 // link with button
-<Link href="/" button={{type:'primary'}}>Home</Link>
+<Link href="/" button={{ type:'primary' }}>Home</Link>
 ```
 
 #### Parameters
@@ -413,6 +502,26 @@ ___
 
 ___
 
+### Loading
+
+▸ **Loading**(`props`): `Element`
+
+Loading component based on Spin
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `props` | `Object` |
+| `props.size?` | ``"small"`` \| ``"default"`` \| ``"large"`` |
+| `props.style?` | `CSSProperties` |
+
+#### Returns
+
+`Element`
+
+___
+
 ### PageNotFound
 
 ▸ **PageNotFound**(): `Element`

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { Dayjs } from 'dayjs';
 import { DescriptionsProps, DrawerProps as DrawerProps$1, FormItemProps as FormItemProps$1, InputProps, InputNumberProps, SwitchProps, SelectProps, DatePickerProps, TimePickerProps, FormInstance, FormProps as FormProps$1, ButtonProps, ModalProps as ModalProps$1, TableColumnProps, TablePaginationConfig, TableProps as TableProps$1 } from 'antd';
 export { Drawer, Modal } from 'antd';
 import { FaasDataWrapperProps } from '@faasjs/react';
+export { FaasDataInjection, FaasDataWrapperProps } from '@faasjs/react';
 import * as antd_es_form_Form from 'antd/es/form/Form';
 import { RuleObject } from 'rc-field-form/lib/interface';
 import { RouteProps } from 'react-router-dom';
@@ -14,6 +15,8 @@ interface BlankProps {
     text?: string;
 }
 /**
+ * Blank component.
+ *
  * If value is undefined or null, return text, otherwise return value.
  *
  * @param options {object}
@@ -114,6 +117,11 @@ declare function transferOptions(options: BaseOption[]): {
 }[];
 declare function transferValue(type: FaasItemType, value: any): any;
 
+/**
+ * FaasDataWrapper component with Loading and ErrorBoundary
+ */
+declare function FaasDataWrapper<T = any>(props: FaasDataWrapperProps<T>): JSX.Element;
+
 interface ExtendDescriptionTypeProps {
     children?: JSX.Element;
     render?: (value: any, values: any) => JSX.Element;
@@ -142,6 +150,9 @@ interface DescriptionItemContentProps<T = any> {
         [key: string]: ExtendDescriptionTypeProps;
     };
 }
+/**
+ * Description component.
+ */
 declare function Description<T = any>(props: DescriptionProps<T>): JSX.Element;
 
 interface DrawerProps extends DrawerProps$1 {
@@ -150,6 +161,7 @@ interface DrawerProps extends DrawerProps$1 {
 type setDrawerProps = (changes: Partial<DrawerProps>) => void;
 /**
  * Hook style drawer.
+ *
  * @param init initial props
  *
  * ```ts
@@ -273,6 +285,8 @@ interface LinkProps {
     button?: ButtonProps;
 }
 /**
+ * Link component with button.
+ *
  * ```ts
  * // pure link
  * <Link href="/">Home</Link>
@@ -283,6 +297,14 @@ interface LinkProps {
  */
 declare function Link({ href, target, text, children, style, button, }: LinkProps): JSX.Element;
 
+/**
+ * Loading component based on Spin
+ */
+declare function Loading(props: {
+    style?: React.CSSProperties;
+    size?: 'small' | 'default' | 'large';
+}): JSX.Element;
+
 interface ModalProps extends ModalProps$1 {
     children?: JSX.Element | JSX.Element[] | string;
 }
@@ -400,4 +422,4 @@ interface TitleProps {
  */
 declare function Title(props: TitleProps): JSX.Element;
 
-export { BaseItemProps, BaseOption, Blank, BlankProps, ConfigContext, ConfigProvider, ConfigProviderProps, Description, DescriptionItemContentProps, DescriptionItemProps, DescriptionProps, DrawerProps, ExtendDescriptionItemProps, ExtendDescriptionTypeProps, ExtendFormItemProps, ExtendFormTypeProps, ExtendTableItemProps, ExtendTableTypeProps, ExtendTypes, FaasItemProps, FaasItemType, FaasItemTypeValue, Form, FormItem, FormItemProps, FormProps, Link, LinkProps, ModalProps, PageNotFound, Routes, RoutesProps, Table, TableItemProps, TableProps, Title, TitleProps, setDrawerProps, setModalProps, transferOptions, transferValue, useConfigContext, useDrawer, useModal };
+export { BaseItemProps, BaseOption, Blank, BlankProps, ConfigContext, ConfigProvider, ConfigProviderProps, Description, DescriptionItemContentProps, DescriptionItemProps, DescriptionProps, DrawerProps, ExtendDescriptionItemProps, ExtendDescriptionTypeProps, ExtendFormItemProps, ExtendFormTypeProps, ExtendTableItemProps, ExtendTableTypeProps, ExtendTypes, FaasDataWrapper, FaasItemProps, FaasItemType, FaasItemTypeValue, Form, FormItem, FormItemProps, FormProps, Link, LinkProps, Loading, ModalProps, PageNotFound, Routes, RoutesProps, Table, TableItemProps, TableProps, Title, TitleProps, setDrawerProps, setModalProps, transferOptions, transferValue, useConfigContext, useDrawer, useModal };