@faasjs/ant-design 8.0.0-beta.2 → 8.0.0-beta.21
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.
- package/README.md +5 -39
- package/dist/index.d.ts +1314 -598
- package/dist/index.mjs +1948 -1513
- package/package.json +25 -29
- package/dist/index.cjs +0 -1636
package/README.md
CHANGED
|
@@ -1,40 +1,5 @@
|
|
|
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
|
-
[](https://github.com/faasjs/faasjs/blob/main/packages/ant-design/LICENSE)
|
|
6
|
-
[](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)
|
|
@@ -58,6 +23,7 @@ type FaasItemProps = {
|
|
|
58
23
|
- [Title](functions/Title.md)
|
|
59
24
|
- [transferOptions](functions/transferOptions.md)
|
|
60
25
|
- [transferValue](functions/transferValue.md)
|
|
26
|
+
- [useApp](functions/useApp.md)
|
|
61
27
|
- [useConfigContext](functions/useConfigContext.md)
|
|
62
28
|
- [useDrawer](functions/useDrawer.md)
|
|
63
29
|
- [useFaas](functions/useFaas.md)
|
|
@@ -81,7 +47,6 @@ type FaasItemProps = {
|
|
|
81
47
|
- [FaasDataWrapperProps](interfaces/FaasDataWrapperProps.md)
|
|
82
48
|
- [FaasItemProps](interfaces/FaasItemProps.md)
|
|
83
49
|
- [FormItemProps](interfaces/FormItemProps.md)
|
|
84
|
-
- [FormProps](interfaces/FormProps.md)
|
|
85
50
|
- [LinkProps](interfaces/LinkProps.md)
|
|
86
51
|
- [ModalProps](interfaces/ModalProps.md)
|
|
87
52
|
- [RoutesProps](interfaces/RoutesProps.md)
|
|
@@ -105,8 +70,11 @@ type FaasItemProps = {
|
|
|
105
70
|
- [FaasItemType](type-aliases/FaasItemType.md)
|
|
106
71
|
- [FaasItemTypeValue](type-aliases/FaasItemTypeValue.md)
|
|
107
72
|
- [FaasReactClientOptions](type-aliases/FaasReactClientOptions.md)
|
|
73
|
+
- [FormFaasProps](type-aliases/FormFaasProps.md)
|
|
74
|
+
- [FormProps](type-aliases/FormProps.md)
|
|
108
75
|
- [FormSubmitProps](type-aliases/FormSubmitProps.md)
|
|
109
76
|
- [LoadingProps](type-aliases/LoadingProps.md)
|
|
77
|
+
- [ResolvedTheme](type-aliases/ResolvedTheme.md)
|
|
110
78
|
- [setDrawerProps](type-aliases/setDrawerProps.md)
|
|
111
79
|
- [setModalProps](type-aliases/setModalProps.md)
|
|
112
80
|
- [TableFaasDataParams](type-aliases/TableFaasDataParams.md)
|
|
@@ -119,7 +87,5 @@ type FaasItemProps = {
|
|
|
119
87
|
|
|
120
88
|
## Variables
|
|
121
89
|
|
|
90
|
+
- [AppContext](variables/AppContext.md)
|
|
122
91
|
- [ConfigContext](variables/ConfigContext.md)
|
|
123
|
-
- [Drawer](variables/Drawer.md)
|
|
124
|
-
- [Modal](variables/Modal.md)
|
|
125
|
-
- [useApp](variables/useApp.md)
|