@faasjs/ant-design 0.0.2-beta.405 → 0.0.2-beta.407

package/README.md

@@ -4,7 +4,7 @@
 [![NPM Stable Version](https://img.shields.io/npm/v/@faasjs/browser/stable.svg)](https://www.npmjs.com/package/@faasjs/browser)
 [![NPM Beta Version](https://img.shields.io/npm/v/@faasjs/browser/beta.svg)](https://www.npmjs.com/package/@faasjs/browser)
 
-UI components based on [FaasJS](https://faasjs.com) and [Ant Design](https://ant.design).
+UI components based on [FaasJS](https://faasjs.com), [Ant Design](https://ant.design) and [React Router](https://reactrouter.com).
 
 ## Install
 

package/dist/index.d.ts

@@ -3,7 +3,8 @@ import { Dayjs } from 'dayjs';
 import { CalendarProps as CalendarProps$1, DescriptionsProps, DrawerProps as DrawerProps$1, FormItemProps as FormItemProps$1, InputProps, InputNumberProps, SwitchProps, DatePickerProps as DatePickerProps$1, TimePickerProps as TimePickerProps$1, SelectProps, FormProps as FormProps$1, ModalProps as ModalProps$1, TableColumnProps, TablePaginationConfig, TableProps as TableProps$1 } from 'antd';
 export { Drawer, Modal } from 'antd';
 import * as react from 'react';
-import { ReactNode, LazyExoticComponent, ComponentType } from 'react';
+import { CSSProperties, ReactNode, LazyExoticComponent, ComponentType } from 'react';
+import { ConfigProviderProps as ConfigProviderProps$1 } from 'antd/lib/config-provider';
 import * as antd_es_date_picker_generatePicker_interface from 'antd/es/date-picker/generatePicker/interface';
 import * as antd_es_date_picker_generatePicker from 'antd/es/date-picker/generatePicker';
 import { PickerDateProps, PickerTimeProps } from 'antd/es/date-picker/generatePicker';
@@ -34,31 +35,38 @@ declare function Blank(options?: BlankProps): any;
 declare type CalendarProps = CalendarProps$1<Dayjs>;
 declare const Calendar: (props: antd_es_calendar_generateCalendar_js.CalendarProps<Dayjs>) => JSX.Element;
 
-declare type FaasState = {
-    lang: string;
-    common: {
-        blank: string;
-        all: string;
-        submit: string;
-        pageNotFound: string;
-        add: string;
-        delete: string;
-        required: string;
+declare type ConfigProviderProps = {
+    antd?: ConfigProviderProps$1;
+    lang?: string;
+    common?: {
+        blank?: string;
+        all?: string;
+        submit?: string;
+        pageNotFound?: string;
+        add?: string;
+        delete?: string;
+        required?: string;
     };
-    Blank: {
-        text: string;
+    Blank?: {
+        text?: string;
     };
-    Form: {
-        submit: {
-            text: string;
+    Form?: {
+        submit?: {
+            text?: string;
         };
     };
-    Title: {
-        separator: string;
-        suffix: string;
+    Title?: {
+        /** ' - ' as default */
+        separator?: string;
+        suffix?: string;
+    };
+    Link?: {
+        /** '_blank' as default */
+        target?: string;
+        style?: CSSProperties;
     };
 };
-declare const ConfigContext: react.Context<FaasState>;
+declare const ConfigContext: react.Context<ConfigProviderProps>;
 /**
  * Config for @faasjs/ant-design components.
  *
@@ -73,10 +81,10 @@ declare const ConfigContext: react.Context<FaasState>;
  * ```
  */
 declare function ConfigProvider({ config, children }: {
-    config: Partial<FaasState>;
+    config: ConfigProviderProps;
     children: React.ReactNode;
 }): JSX.Element;
-declare function useConfigContext(): FaasState;
+declare function useConfigContext(): ConfigProviderProps;
 
 declare type FaasItemType = 'string' | 'string[]' | 'number' | 'number[]' | 'boolean' | 'date' | 'time' | 'object' | 'object[]';
 declare type FaasItemTypeValue = {
@@ -222,15 +230,16 @@ declare type FormItemInputProps = StringProps | StringListProps | NumberProps |
 declare type ExtendFormTypeProps = {
     children?: JSX.Element | null;
 };
+declare type ExtendTypes = {
+    [type: string]: ExtendFormTypeProps;
+};
 declare type ExtendFormItemProps = BaseItemProps & FormItemProps$1;
 declare type FormItemProps<T = any> = {
     children?: JSX.Element | null;
     render?: () => JSX.Element | null;
     rules?: RuleObject[];
     label?: string | false;
-    extendTypes?: {
-        [type: string]: ExtendFormTypeProps;
-    };
+    extendTypes?: ExtendTypes;
 } & FormItemInputProps & FaasItemProps & Omit<FormItemProps$1<T>, 'children'>;
 /**
  * FormItem, can be used without Form.
@@ -287,9 +296,7 @@ declare type FormProps<Values = any, ExtendItemProps = any> = {
     onFinish?: (values: Values, submit?: (values: any) => Promise<any>) => Promise<any>;
     beforeItems?: JSX.Element | JSX.Element[];
     footer?: JSX.Element | JSX.Element[];
-    extendTypes?: {
-        [type: string]: ExtendFormTypeProps;
-    };
+    extendTypes?: ExtendTypes;
     children?: ReactNode;
 } & Omit<FormProps$1<Values>, 'onFinish' | 'children'>;
 declare function Form<Values = any>(props: FormProps<Values>): JSX.Element;
@@ -298,6 +305,14 @@ declare namespace Form {
     var Item: typeof FormItem;
 }
 
+declare function Link({ href, target, text, children, style }: {
+    href: string;
+    target?: string;
+    text?: string | number;
+    children?: ReactNode;
+    style?: CSSProperties;
+}): JSX.Element;
+
 declare type ModalProps = ModalProps$1 & {
     children?: JSX.Element | JSX.Element[] | string;
 };
@@ -329,6 +344,25 @@ declare type RoutesProps = {
     fallback?: JSX.Element;
     notFound?: JSX.Element;
 };
+/**
+ * Routes with lazy loading and 404 page.
+ *
+ * ```tsx
+ * import { lazy } from 'react'
+ * import { BrowserRouter } from 'react-router-dom'
+ *
+ * export function App () {
+ *   return <BrowserRouter>
+ *     <Routes routes={[
+ *       {
+ *         path: '/',
+ *         page: lazy(() => import('./pages/home'))
+ *       }
+ *     ]} />
+ *   </BrowserRouter>
+ * }
+ * ```
+ */
 declare function Routes(props: RoutesProps): JSX.Element;
 
 declare type TableItemProps<T = any> = {
@@ -390,4 +424,4 @@ declare type TitleProps = {
  */
 declare function Title(props: TitleProps): JSX.Element;
 
-export { BaseItemProps, BaseOption, Blank, BlankProps, Calendar, CalendarProps, ConfigContext, ConfigProvider, DatePicker, DatePickerProps, Description, DescriptionItemProps, DescriptionProps, DrawerProps, ExtendDescriptionItemProps, ExtendDescriptionTypeProps, ExtendFormItemProps, ExtendFormTypeProps, ExtendTableItemProps, ExtendTableTypeProps, FaasItemProps, FaasItemType, FaasItemTypeValue, FaasState, Form, FormItem, FormItemProps, FormProps, ModalProps, Routes, RoutesProps, Table, TableItemProps, TableProps, TimePicker, TimePickerProps, Title, TitleProps, setDrawerProps, setModalProps, transferOptions, useConfigContext, useDrawer, useModal };
+export { BaseItemProps, BaseOption, Blank, BlankProps, Calendar, CalendarProps, ConfigContext, ConfigProvider, ConfigProviderProps, DatePicker, DatePickerProps, Description, DescriptionItemProps, DescriptionProps, DrawerProps, ExtendDescriptionItemProps, ExtendDescriptionTypeProps, ExtendFormItemProps, ExtendFormTypeProps, ExtendTableItemProps, ExtendTableTypeProps, ExtendTypes, FaasItemProps, FaasItemType, FaasItemTypeValue, Form, FormItem, FormItemProps, FormProps, Link, ModalProps, Routes, RoutesProps, Table, TableItemProps, TableProps, TimePicker, TimePickerProps, Title, TitleProps, setDrawerProps, setModalProps, transferOptions, useConfigContext, useDrawer, useModal };