@faasjs/ant-design 0.0.4-beta.9 → 0.0.5-beta.1

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { FaasDataInjection as FaasDataInjection$1, FaasDataWrapperProps as FaasDataWrapperProps$1, ErrorBoundaryProps } from '@faasjs/react';
+import { ErrorBoundaryProps, FaasReactClientOptions, FaasDataInjection as FaasDataInjection$1, FaasDataWrapperProps as FaasDataWrapperProps$1 } from '@faasjs/react';
 export { ErrorBoundaryProps, faas, useFaas } from '@faasjs/react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ConfigProviderProps as ConfigProviderProps$1 } from 'antd/es/config-provider';
@@ -73,11 +73,64 @@ declare function useDrawer(init?: DrawerProps): {
     setDrawerProps(changes: Partial<DrawerProps>): void;
 };
 
+declare function ErrorBoundary(props: ErrorBoundaryProps): react_jsx_runtime.JSX.Element;
+
+interface ConfigProviderProps {
+    faasClientOptions?: FaasReactClientOptions;
+    children: React.ReactNode;
+    theme?: {
+        lang?: string;
+        common?: {
+            blank?: string;
+            all?: string;
+            submit?: string;
+            pageNotFound?: string;
+            add?: string;
+            delete?: string;
+            required?: string;
+            search?: string;
+            reset?: string;
+        };
+        Blank?: {
+            text?: string;
+        };
+        Form?: {
+            submit?: {
+                text?: string;
+            };
+        };
+        Title?: {
+            /** ' - ' as default */
+            separator?: string;
+            suffix?: string;
+        };
+        Link?: {
+            /** '_blank' as default */
+            target?: string;
+            style?: CSSProperties;
+        };
+    };
+}
+declare const ConfigContext: react.Context<Partial<ConfigProviderProps>>;
+/**
+ * Config for @faasjs/ant-design components.
+ *
+ * ```ts
+ * <ConfigProvider theme={{ common: { blank: 'Empty' } }}>
+ *   <Blank />
+ * </ConfigProvider>
+ * ```
+ */
+declare function ConfigProvider(props: ConfigProviderProps): react_jsx_runtime.JSX.Element;
+declare function useConfigContext(): Partial<ConfigProviderProps>;
+
 interface AppProps {
     children: React.ReactNode;
     styleProviderProps?: StyleProviderProps;
     configProviderProps?: ConfigProviderProps$1;
     browserRouterProps?: BrowserRouterProps;
+    errorBoundaryProps?: Omit<ErrorBoundaryProps, 'children'>;
+    faasConfigProviderProps?: Omit<ConfigProviderProps, 'children'>;
 }
 interface useAppProps {
     message: MessageInstance;
@@ -89,6 +142,15 @@ declare function App(props: AppProps): react_jsx_runtime.JSX.Element;
 declare namespace App {
     var useApp: typeof useApp;
 }
+/**
+ * Get app context.
+ *
+ * ```ts
+ * import { useApp } from '@faasjs/ant-design'
+ *
+ * const { message, notification, setModalProps, setDrawerProps } = useApp()
+ * ```
+ */
 declare function useApp(): useAppProps;
 
 interface BlankProps {
@@ -111,58 +173,6 @@ interface BlankProps {
  */
 declare function Blank(options?: BlankProps): JSX.Element;
 
-interface ConfigProviderProps {
-    lang?: string;
-    common?: {
-        blank?: string;
-        all?: string;
-        submit?: string;
-        pageNotFound?: string;
-        add?: string;
-        delete?: string;
-        required?: string;
-        search?: string;
-        reset?: string;
-    };
-    Blank?: {
-        text?: string;
-    };
-    Form?: {
-        submit?: {
-            text?: string;
-        };
-    };
-    Title?: {
-        /** ' - ' as default */
-        separator?: string;
-        suffix?: string;
-    };
-    Link?: {
-        /** '_blank' as default */
-        target?: string;
-        style?: CSSProperties;
-    };
-}
-declare const ConfigContext: react.Context<ConfigProviderProps>;
-/**
- * Config for @faasjs/ant-design components.
- *
- * ```ts
- * <ConfigProvider config={{
- *   common: {
- *     blank: 'Empty',
- *   },
- * }}>
- *   <Blank />
- * </ConfigProvider>
- * ```
- */
-declare function ConfigProvider({ config, children, }: {
-    config: ConfigProviderProps;
-    children: React.ReactNode;
-}): react_jsx_runtime.JSX.Element;
-declare function useConfigContext(): ConfigProviderProps;
-
 type ExtendFormTypeProps<T = any> = {
     children?: UnionFaasItemElement<T>;
 };
@@ -316,6 +326,11 @@ type TableProps<T = any, ExtendTypes = any> = {
 /**
  * Table component with Ant Design & FaasJS
  *
+ * - Support all Ant Design Table props.
+ * - Support FaasJS injection.
+ * - Auto generate filter dropdown (disable with `filterDropdown: false`).
+ * - Auto generate sorter (disable with `sorter: false`).
+ *
  * @ref https://ant.design/components/table/
  */
 declare function Table<T extends Record<string, any>, ExtendTypes = any>(props: TableProps<T, ExtendTypes>): react_jsx_runtime.JSX.Element;
@@ -350,7 +365,7 @@ interface FaasItemProps extends BaseItemProps {
     type?: FaasItemType;
 }
 /**
- * convert options to { label, value }[]
+ * convert string[] or number[] to { label, value }[]
  */
 declare function transferOptions(options: BaseOption[]): {
     label: string;
@@ -372,8 +387,6 @@ interface UnionFaasItemProps<Value = any, Values = any> extends FormItemProps, D
     object?: UnionFaasItemProps<Value, Values>[];
 }
 
-declare function ErrorBoundary(props: ErrorBoundaryProps): react_jsx_runtime.JSX.Element;
-
 type FormSubmitProps = {
     /** Default: Submit */
     text?: string;
@@ -542,4 +555,4 @@ interface TitleProps {
  */
 declare function Title(props: TitleProps): JSX.Element;
 
-export { App, AppProps, BaseItemProps, BaseOption, Blank, BlankProps, ConfigContext, ConfigProvider, ConfigProviderProps, Description, DescriptionItemContentProps, DescriptionItemProps, DescriptionProps, DrawerProps, ErrorBoundary, ExtendDescriptionItemProps, ExtendDescriptionTypeProps, ExtendFormItemProps, ExtendFormTypeProps, ExtendTableItemProps, ExtendTableTypeProps, ExtendTypes, FaasDataInjection, FaasDataWrapper, FaasDataWrapperProps, FaasItemProps, FaasItemType, FaasItemTypeValue, Form, FormItem, FormItemProps, FormProps, FormSubmitProps, Link, LinkProps, Loading, LoadingProps, ModalProps, PageNotFound, Routes, RoutesProps, TabProps, Table, TableItemProps, TableProps, Tabs, TabsProps, Title, TitleProps, UnionFaasItemElement, UnionFaasItemInjection, UnionFaasItemProps, UnionFaasItemRender, UnionScene, setDrawerProps, setModalProps, transferOptions, transferValue, useApp, useAppProps, useConfigContext, useDrawer, useModal };
+export { App, type AppProps, type BaseItemProps, type BaseOption, Blank, type BlankProps, ConfigContext, ConfigProvider, type ConfigProviderProps, Description, type DescriptionItemContentProps, type DescriptionItemProps, type DescriptionProps, type DrawerProps, ErrorBoundary, type ExtendDescriptionItemProps, type ExtendDescriptionTypeProps, type ExtendFormItemProps, type ExtendFormTypeProps, type ExtendTableItemProps, type ExtendTableTypeProps, type ExtendTypes, type FaasDataInjection, FaasDataWrapper, type FaasDataWrapperProps, type FaasItemProps, type FaasItemType, type FaasItemTypeValue, Form, FormItem, type FormItemProps, type FormProps, type FormSubmitProps, Link, type LinkProps, Loading, type LoadingProps, type ModalProps, PageNotFound, Routes, type RoutesProps, type TabProps, Table, type TableItemProps, type TableProps, Tabs, type TabsProps, Title, type TitleProps, type UnionFaasItemElement, type UnionFaasItemInjection, type UnionFaasItemProps, type UnionFaasItemRender, type UnionScene, type setDrawerProps, type setModalProps, transferOptions, transferValue, useApp, type useAppProps, useConfigContext, useDrawer, useModal };