@faasjs/ant-design 0.0.3-beta.2 → 0.0.3-beta.21

package/dist/index.d.ts

@@ -1,8 +1,7 @@
 import * as react from 'react';
 import { CSSProperties, ReactNode, LazyExoticComponent, ComponentType } from 'react';
-import { ConfigProviderProps as ConfigProviderProps$1 } from 'antd/es/config-provider';
 import { Dayjs } from 'dayjs';
-import { DescriptionsProps, DrawerProps as DrawerProps$1, FormItemProps as FormItemProps$1, FormInstance, InputProps, InputNumberProps, SwitchProps, DatePickerProps, TimePickerProps, SelectProps, FormProps as FormProps$1, ButtonProps, ModalProps as ModalProps$1, TableColumnProps, TablePaginationConfig, TableProps as TableProps$1 } from 'antd';
+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';
 import * as antd_es_form_Form from 'antd/es/form/Form';
@@ -10,10 +9,10 @@ import { RuleObject } from 'rc-field-form/lib/interface';
 import { RouteProps } from 'react-router-dom';
 import { FilterValue, SorterResult, TableCurrentDataSource } from 'antd/es/table/interface';
 
-type BlankProps = {
+interface BlankProps {
     value?: any;
     text?: string;
-};
+}
 /**
  * If value is undefined or null, return text, otherwise return value.
  *
@@ -28,8 +27,7 @@ type BlankProps = {
  */
 declare function Blank(options?: BlankProps): JSX.Element;
 
-type ConfigProviderProps = {
-    antd?: ConfigProviderProps$1;
+interface ConfigProviderProps {
     lang?: string;
     common?: {
         blank?: string;
@@ -60,7 +58,7 @@ type ConfigProviderProps = {
         target?: string;
         style?: CSSProperties;
     };
-};
+}
 declare const ConfigContext: react.Context<ConfigProviderProps>;
 /**
  * Config for @faasjs/ant-design components.
@@ -98,50 +96,57 @@ type BaseOption = string | number | {
     label: string;
     value?: string | number;
 };
-type BaseItemProps = {
+interface BaseItemProps {
     id: string;
     title?: string;
     options?: BaseOption[];
-};
-type FaasItemProps = BaseItemProps & {
+}
+interface FaasItemProps extends BaseItemProps {
     /**
-     * Support string, string[], number, number[], boolean
+     * Support string, string[], number, number[], boolean, date, time, object, object[]
      * @default 'string'
      */
     type?: FaasItemType;
-};
+}
 declare function transferOptions(options: BaseOption[]): {
     label: string;
     value?: string | number;
 }[];
 declare function transferValue(type: FaasItemType, value: any): any;
 
-type ExtendDescriptionTypeProps = {
-    children?: JSX.Element | null;
-    render?: (value: any, values: any) => ReactNode | JSX.Element;
-};
+interface ExtendDescriptionTypeProps {
+    children?: JSX.Element;
+    render?: (value: any, values: any) => JSX.Element;
+}
 type ExtendDescriptionItemProps = BaseItemProps;
-type DescriptionItemProps<T = any> = {
+interface DescriptionItemProps<T = any> extends FaasItemProps {
     children?: JSX.Element;
-    render?: (value: T, values: any) => ReactNode | JSX.Element;
+    render?: (value: T, values: any) => JSX.Element;
     if?: (values: Record<string, any>) => boolean;
-} & FaasItemProps & {
     object?: DescriptionItemProps[];
-};
-type DescriptionProps<T = any, ExtendItemProps = any> = {
-    renderTitle?: ((values: T) => ReactNode | JSX.Element);
+}
+interface DescriptionProps<T = any, ExtendItemProps = any> extends DescriptionsProps {
+    renderTitle?: ((values: T) => ReactNode);
     items: (DescriptionItemProps | ExtendItemProps)[];
     extendTypes?: {
         [key: string]: ExtendDescriptionTypeProps;
     };
     dataSource?: T;
     faasData?: FaasDataWrapperProps<T>;
-} & DescriptionsProps;
+}
+interface DescriptionItemContentProps<T = any> {
+    item: DescriptionItemProps;
+    value: T;
+    values?: any;
+    extendTypes?: {
+        [key: string]: ExtendDescriptionTypeProps;
+    };
+}
 declare function Description<T = any>(props: DescriptionProps<T>): JSX.Element;
 
-type DrawerProps = DrawerProps$1 & {
+interface DrawerProps extends DrawerProps$1 {
     children?: JSX.Element | JSX.Element[];
-};
+}
 type setDrawerProps = (changes: Partial<DrawerProps>) => void;
 /**
  * Hook style drawer.
@@ -166,57 +171,6 @@ declare function useDrawer(init?: DrawerProps): {
     setDrawerProps(changes: Partial<DrawerProps>): void;
 };
 
-type StringProps = {
-    type?: 'string';
-    input?: InputProps;
-};
-type StringListProps = {
-    type: 'string[]';
-    input?: InputProps;
-    maxCount?: number;
-};
-type NumberProps = {
-    type: 'number';
-    input?: InputNumberProps;
-};
-type NumberListProps = {
-    type: 'number[]';
-    input?: InputNumberProps;
-    maxCount?: number;
-};
-type BooleanProps = {
-    type: 'boolean';
-    input?: SwitchProps;
-};
-type DateProps = {
-    type: 'date';
-    input?: DatePickerProps;
-};
-type TimeProps = {
-    type: 'time';
-    input?: TimePickerProps;
-};
-type ObjectProps = {
-    type: 'object';
-    object: FormItemProps[];
-};
-type ObjectListProps = {
-    type: 'object[]';
-    object: (FormItemProps & {
-        /** default is 6 */
-        col?: number;
-    })[];
-    maxCount?: number;
-};
-type OptionsProps = {
-    options?: BaseOption[];
-    type?: 'string' | 'string[]' | 'number' | 'number[]';
-    input?: SelectProps<any>;
-};
-type FormItemInputProps = (StringProps | StringListProps | NumberProps | NumberListProps | BooleanProps | OptionsProps | DateProps | TimeProps | ObjectProps | ObjectListProps) & {
-    disabled?: boolean;
-    required?: boolean;
-};
 type ExtendFormTypeProps = {
     children?: ReactNode;
 };
@@ -224,9 +178,15 @@ type ExtendTypes = {
     [type: string]: ExtendFormTypeProps;
 };
 type ExtendFormItemProps = BaseItemProps & FormItemProps$1;
-type FormItemProps<T = any> = {
-    children?: ReactNode;
-    render?: (value?: T) => ReactNode | JSX.Element;
+interface FormItemProps<T = any> extends FaasItemProps, Omit<FormItemProps$1<T>, 'id' | 'children'> {
+    input?: InputProps | InputNumberProps | SwitchProps | SelectProps<T> | DatePickerProps | TimePickerProps;
+    maxCount?: number;
+    object?: FormItemProps[];
+    disabled?: boolean;
+    required?: boolean;
+    col?: number;
+    children?: JSX.Element;
+    render?: () => JSX.Element;
     rules?: RuleObject[];
     label?: string | false;
     extendTypes?: ExtendTypes;
@@ -234,24 +194,24 @@ type FormItemProps<T = any> = {
     onValueChange?: (value: T, values: any, form: FormInstance) => void;
     /** trigger when any item's value changed */
     if?: (values: Record<string, any>) => boolean;
-} & FormItemInputProps & FaasItemProps & Omit<FormItemProps$1<T>, 'children'>;
+}
 /**
  * FormItem, can be used without Form.
  *
  * ```ts
  * // use inline type
- * <FormItem item={{ type: 'string', id: 'name' }} />
+ * <FormItem type='string' id='name' />
  *
  * // use custom type
- * <FormItem item={{ id: 'password' }}>
+ * <FormItem id='password'>
  *   <Input.Password />
  * </>
  * ```
  */
 declare function FormItem<T = any>(props: FormItemProps<T>): JSX.Element;
 
-type FormProps<Values extends Record<string, any> = any, ExtendItemProps = any> = {
-    items?: (FormItemProps | ExtendItemProps)[];
+interface FormProps<Values extends Record<string, any> = any, ExtendItemProps = any> extends Omit<FormProps$1<Values>, 'onFinish' | 'children' | 'initialValues'> {
+    items?: (FormItemProps | ExtendItemProps | JSX.Element)[];
     /** Default: { text: 'Submit' }, set false to disable it */
     submit?: false | {
         /** Default: Submit */
@@ -293,7 +253,7 @@ type FormProps<Values extends Record<string, any> = any, ExtendItemProps = any>
     extendTypes?: ExtendTypes;
     children?: ReactNode;
     initialValues?: Values;
-} & Omit<FormProps$1<Values>, 'onFinish' | 'children' | 'initialValues'>;
+}
 /**
  * Form component with Ant Design & FaasJS
  *
@@ -304,28 +264,28 @@ declare namespace Form {
     var useForm: typeof antd_es_form_Form.useForm;
 }
 
-type LinkProps = {
+interface LinkProps {
     href: string;
     target?: string;
     text?: string | number;
     children?: ReactNode;
     style?: CSSProperties;
     button?: ButtonProps;
-};
+}
 /**
  * ```ts
  * // pure link
  * <Link href="/">Home</Link>
  *
  * // link with button
- * <Link href="/" button={{type:'primary'}}>Home</Link>
+ * <Link href="/" button={{ type:'primary' }}>Home</Link>
  * ```
  */
 declare function Link({ href, target, text, children, style, button, }: LinkProps): JSX.Element;
 
-type ModalProps = ModalProps$1 & {
+interface ModalProps extends ModalProps$1 {
     children?: JSX.Element | JSX.Element[] | string;
-};
+}
 type setModalProps = (changes: Partial<ModalProps>) => void;
 /**
  * Hook style modal.
@@ -348,13 +308,13 @@ declare function useModal(init?: ModalProps): {
 };
 
 declare function PageNotFound(): JSX.Element;
-type RoutesProps = {
+interface RoutesProps {
     routes: (RouteProps & {
         page?: LazyExoticComponent<ComponentType<any>>;
     })[];
     fallback?: JSX.Element;
     notFound?: JSX.Element;
-};
+}
 /**
  * Routes with lazy loading and 404 page.
  *
@@ -376,14 +336,13 @@ type RoutesProps = {
  */
 declare function Routes(props: RoutesProps): JSX.Element;
 
-type TableItemProps<T = any> = {
+interface TableItemProps<T = any> extends FaasItemProps, Omit<TableColumnProps<T>, 'title' | 'children'> {
     optionsType?: 'auto';
-    /** @deprecated use render */
-    children?: JSX.Element | null;
+    children?: JSX.Element;
     object?: TableItemProps[];
-} & FaasItemProps & Omit<TableColumnProps<T>, 'children'>;
+}
 type ExtendTableTypeProps = {
-    children?: JSX.Element | null;
+    children?: JSX.Element;
     render?: (value: any, values: any, index: number) => JSX.Element | string | number | boolean | null;
 };
 type ExtendTableItemProps<T = any> = BaseItemProps & Omit<TableColumnProps<T>, 'children'>;
@@ -407,7 +366,7 @@ type TableProps<T = any, ExtendTypes = any> = {
  */
 declare function Table<T = any, ExtendTypes = any>(props: TableProps<T, ExtendTypes>): JSX.Element;
 
-type TitleProps = {
+interface TitleProps {
     title: string | string[];
     /** ` - ` as default */
     separator?: string;
@@ -421,7 +380,7 @@ type TitleProps = {
     plain?: boolean;
     /** return children */
     children?: JSX.Element;
-};
+}
 /**
  * Title is used to change the title of the page.
  * Return null by default.
@@ -441,4 +400,4 @@ type TitleProps = {
  */
 declare function Title(props: TitleProps): JSX.Element;
 
-export { BaseItemProps, BaseOption, Blank, BlankProps, ConfigContext, ConfigProvider, ConfigProviderProps, Description, 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, 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 };