@faasjs/ant-design 8.0.0-beta.3 → 8.0.0-beta.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +15 -39
  2. package/dist/index.d.ts +1177 -690
  3. package/dist/index.mjs +1822 -1497
  4. package/package.json +26 -30
  5. package/dist/index.cjs +0 -1625
package/README.md CHANGED
@@ -1,46 +1,12 @@
1
1
  # @faasjs/ant-design
2
2
 
3
- UI components based on [FaasJS](https://faasjs.com), [Ant Design](https://ant.design) and [React Router](https://reactrouter.com).
4
-
5
- [![License: MIT](https://img.shields.io/npm/l/@faasjs/ant-design.svg)](https://github.com/faasjs/faasjs/blob/main/packages/ant-design/LICENSE)
6
- [![NPM Version](https://img.shields.io/npm/v/@faasjs/ant-design.svg)](https://www.npmjs.com/package/@faasjs/ant-design)
7
-
8
- ## Features
9
-
10
- - [App](https://faasjs.com/doc/ant-design/functions/App.html) component with Ant Design & FaasJS.
11
- - [UnionFaasItemElement](https://faasjs.com/doc/ant-design/type-aliases/UnionFaasItemElement.html) and [UnionFaasItemRender](https://faasjs.com/doc/ant-design/type-aliases/UnionFaasItemRender.html) for custom union rendering.
12
-
13
- ## Install
14
-
15
- ```sh
16
- npm install @faasjs/ant-design
17
- ```
18
-
19
- ## Usage
20
-
21
- In `@faasjs/ant-design`, we use `FaasItemProps` to provide data structures for components.
22
-
23
- ```ts
24
- type FaasItemType =
25
- 'string' | 'string[]' |
26
- 'number' | 'number[]' |
27
- 'boolean' |
28
- 'date' | 'time' |
29
- 'object' | 'object[]'
30
-
31
- type FaasItemProps = {
32
- type: FaasItemTypes
33
- id: string
34
- title?: string
35
- }
36
- ```
37
-
38
3
  ## Functions
39
4
 
40
5
  - [App](functions/App.md)
41
6
  - [Blank](functions/Blank.md)
42
7
  - [cloneUnionFaasItemElement](functions/cloneUnionFaasItemElement.md)
43
8
  - [ConfigProvider](functions/ConfigProvider.md)
9
+ - [createOnErrorHandler](functions/createOnErrorHandler.md)
44
10
  - [Description](functions/Description.md)
45
11
  - [ErrorBoundary](functions/ErrorBoundary.md)
46
12
  - [faas](functions/faas.md)
@@ -52,12 +18,14 @@ type FaasItemProps = {
52
18
  - [Link](functions/Link.md)
53
19
  - [Loading](functions/Loading.md)
54
20
  - [PageNotFound](functions/PageNotFound.md)
21
+ - [renderDisplayValue](functions/renderDisplayValue.md)
55
22
  - [Routes](functions/Routes.md)
56
23
  - [Table](functions/Table.md)
57
24
  - [Tabs](functions/Tabs.md)
58
25
  - [Title](functions/Title.md)
59
26
  - [transferOptions](functions/transferOptions.md)
60
27
  - [transferValue](functions/transferValue.md)
28
+ - [useApp](functions/useApp.md)
61
29
  - [useConfigContext](functions/useConfigContext.md)
62
30
  - [useDrawer](functions/useDrawer.md)
63
31
  - [useFaas](functions/useFaas.md)
@@ -71,17 +39,17 @@ type FaasItemProps = {
71
39
  - [BaseItemProps](interfaces/BaseItemProps.md)
72
40
  - [BlankProps](interfaces/BlankProps.md)
73
41
  - [ConfigProviderProps](interfaces/ConfigProviderProps.md)
42
+ - [DescriptionCommonProps](interfaces/DescriptionCommonProps.md)
74
43
  - [DescriptionItemContentProps](interfaces/DescriptionItemContentProps.md)
75
44
  - [DescriptionItemProps](interfaces/DescriptionItemProps.md)
76
- - [DescriptionProps](interfaces/DescriptionProps.md)
45
+ - [DescriptionWithFaasProps](interfaces/DescriptionWithFaasProps.md)
46
+ - [DescriptionWithoutFaasProps](interfaces/DescriptionWithoutFaasProps.md)
77
47
  - [DrawerProps](interfaces/DrawerProps.md)
78
48
  - [ErrorBoundaryProps](interfaces/ErrorBoundaryProps.md)
79
- - [ExtendDescriptionTypeProps](interfaces/ExtendDescriptionTypeProps.md)
80
49
  - [ExtendFormItemProps](interfaces/ExtendFormItemProps.md)
81
50
  - [FaasDataWrapperProps](interfaces/FaasDataWrapperProps.md)
82
51
  - [FaasItemProps](interfaces/FaasItemProps.md)
83
52
  - [FormItemProps](interfaces/FormItemProps.md)
84
- - [FormProps](interfaces/FormProps.md)
85
53
  - [LinkProps](interfaces/LinkProps.md)
86
54
  - [ModalProps](interfaces/ModalProps.md)
87
55
  - [RoutesProps](interfaces/RoutesProps.md)
@@ -94,8 +62,11 @@ type FaasItemProps = {
94
62
 
95
63
  ## Type Aliases
96
64
 
65
+ - [BaseExtendTypeProps](type-aliases/BaseExtendTypeProps.md)
97
66
  - [BaseOption](type-aliases/BaseOption.md)
67
+ - [DescriptionProps](type-aliases/DescriptionProps.md)
98
68
  - [ExtendDescriptionItemProps](type-aliases/ExtendDescriptionItemProps.md)
69
+ - [ExtendDescriptionTypeProps](type-aliases/ExtendDescriptionTypeProps.md)
99
70
  - [ExtendFormTypeProps](type-aliases/ExtendFormTypeProps.md)
100
71
  - [ExtendTableItemProps](type-aliases/ExtendTableItemProps.md)
101
72
  - [ExtendTableTypeProps](type-aliases/ExtendTableTypeProps.md)
@@ -105,8 +76,13 @@ type FaasItemProps = {
105
76
  - [FaasItemType](type-aliases/FaasItemType.md)
106
77
  - [FaasItemTypeValue](type-aliases/FaasItemTypeValue.md)
107
78
  - [FaasReactClientOptions](type-aliases/FaasReactClientOptions.md)
79
+ - [FormFaasProps](type-aliases/FormFaasProps.md)
80
+ - [FormProps](type-aliases/FormProps.md)
108
81
  - [FormSubmitProps](type-aliases/FormSubmitProps.md)
82
+ - [FormWithFaasProps](type-aliases/FormWithFaasProps.md)
83
+ - [FormWithoutFaasProps](type-aliases/FormWithoutFaasProps.md)
109
84
  - [LoadingProps](type-aliases/LoadingProps.md)
85
+ - [ResolvedTheme](type-aliases/ResolvedTheme.md)
110
86
  - [setDrawerProps](type-aliases/setDrawerProps.md)
111
87
  - [setModalProps](type-aliases/setModalProps.md)
112
88
  - [TableFaasDataParams](type-aliases/TableFaasDataParams.md)
@@ -119,5 +95,5 @@ type FaasItemProps = {
119
95
 
120
96
  ## Variables
121
97
 
98
+ - [AppContext](variables/AppContext.md)
122
99
  - [ConfigContext](variables/ConfigContext.md)
123
- - [useApp](variables/useApp.md)