@faasjs/ant-design 0.0.3-beta.64 → 0.0.3-beta.66

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 CHANGED
@@ -41,6 +41,7 @@ Form are based on [Ant Design's Form.Item component](https://ant.design/componen
41
41
 
42
42
  ### Namespaces
43
43
 
44
+ - [App](modules/App.md)
44
45
  - [Form](modules/Form.md)
45
46
  - [FormItem](modules/FormItem.md)
46
47
 
@@ -50,6 +51,7 @@ Form are based on [Ant Design's Form.Item component](https://ant.design/componen
50
51
 
51
52
  ### Interfaces
52
53
 
54
+ - [AppProps](interfaces/AppProps.md)
53
55
  - [BaseItemProps](interfaces/BaseItemProps.md)
54
56
  - [BlankProps](interfaces/BlankProps.md)
55
57
  - [ConfigProviderProps](interfaces/ConfigProviderProps.md)
@@ -59,7 +61,6 @@ Form are based on [Ant Design's Form.Item component](https://ant.design/componen
59
61
  - [DrawerProps](interfaces/DrawerProps.md)
60
62
  - [ErrorBoundaryProps](interfaces/ErrorBoundaryProps.md)
61
63
  - [ExtendDescriptionTypeProps](interfaces/ExtendDescriptionTypeProps.md)
62
- - [FaasDataInjection](interfaces/FaasDataInjection.md)
63
64
  - [FaasDataWrapperProps](interfaces/FaasDataWrapperProps.md)
64
65
  - [FaasItemProps](interfaces/FaasItemProps.md)
65
66
  - [FormItemProps](interfaces/FormItemProps.md)
@@ -70,6 +71,7 @@ Form are based on [Ant Design's Form.Item component](https://ant.design/componen
70
71
  - [TableItemProps](interfaces/TableItemProps.md)
71
72
  - [TitleProps](interfaces/TitleProps.md)
72
73
  - [UnionFaasItemProps](interfaces/UnionFaasItemProps.md)
74
+ - [useAppProps](interfaces/useAppProps.md)
73
75
 
74
76
  ### Type Aliases
75
77
 
@@ -80,6 +82,7 @@ Form are based on [Ant Design's Form.Item component](https://ant.design/componen
80
82
  - [ExtendTableItemProps](#extendtableitemprops)
81
83
  - [ExtendTableTypeProps](#extendtabletypeprops)
82
84
  - [ExtendTypes](#extendtypes)
85
+ - [FaasDataInjection](#faasdatainjection)
83
86
  - [FaasItemType](#faasitemtype)
84
87
  - [FaasItemTypeValue](#faasitemtypevalue)
85
88
  - [FormSubmitProps](#formsubmitprops)
@@ -98,6 +101,7 @@ Form are based on [Ant Design's Form.Item component](https://ant.design/componen
98
101
 
99
102
  ### Functions
100
103
 
104
+ - [App](#app)
101
105
  - [Blank](#blank)
102
106
  - [ConfigProvider](#configprovider)
103
107
  - [Description](#description)
@@ -112,6 +116,7 @@ Form are based on [Ant Design's Form.Item component](https://ant.design/componen
112
116
  - [Title](#title)
113
117
  - [transferOptions](#transferoptions)
114
118
  - [transferValue](#transfervalue)
119
+ - [useApp](#useapp)
115
120
  - [useConfigContext](#useconfigcontext)
116
121
  - [useDrawer](#usedrawer)
117
122
  - [useModal](#usemodal)
@@ -195,6 +200,18 @@ ___
195
200
 
196
201
  ___
197
202
 
203
+ ### FaasDataInjection
204
+
205
+ Ƭ **FaasDataInjection**<`T`\>: `Partial`<`OriginFaasDataInjection`<`T`\>\>
206
+
207
+ #### Type parameters
208
+
209
+ | Name | Type |
210
+ | :------ | :------ |
211
+ | `T` | `any` |
212
+
213
+ ___
214
+
198
215
  ### FaasItemType
199
216
 
200
217
  Ƭ **FaasItemType**: ``"string"`` \| ``"string[]"`` \| ``"number"`` \| ``"number[]"`` \| ``"boolean"`` \| ``"date"`` \| ``"time"`` \| ``"object"`` \| ``"object[]"``
@@ -386,6 +403,22 @@ ___
386
403
 
387
404
  ## Functions
388
405
 
406
+ ### App
407
+
408
+ ▸ **App**(`props`): `Element`
409
+
410
+ #### Parameters
411
+
412
+ | Name | Type |
413
+ | :------ | :------ |
414
+ | `props` | [`AppProps`](interfaces/AppProps.md) |
415
+
416
+ #### Returns
417
+
418
+ `Element`
419
+
420
+ ___
421
+
389
422
  ### Blank
390
423
 
391
424
  ▸ **Blank**(`options?`): `JSX.Element`
@@ -470,6 +503,18 @@ ___
470
503
 
471
504
  FaasDataWrapper component with Loading
472
505
 
506
+ ```tsx
507
+ function MyComponent (props: FaasDataInjection) {
508
+ return <div>{ props.data }</div>
509
+ }
510
+
511
+ function MyPage () {
512
+ return <FaasDataWrapper action="test" params={{ a: 1 }}>
513
+ <MyComponent />
514
+ </FaasDataWrapper>
515
+ }
516
+ ```
517
+
473
518
  #### Type parameters
474
519
 
475
520
  | Name | Type |
@@ -619,7 +664,7 @@ ___
619
664
  Routes with lazy loading and 404 page.
620
665
 
621
666
  ```tsx
622
- import { lazy } from 'react'
667
+ import { Routes, lazy } from '@faasjs/ant-design'
623
668
  import { BrowserRouter } from 'react-router-dom'
624
669
 
625
670
  export function App () {
@@ -742,6 +787,16 @@ ___
742
787
 
743
788
  ___
744
789
 
790
+ ### useApp
791
+
792
+ ▸ **useApp**(): [`useAppProps`](interfaces/useAppProps.md)
793
+
794
+ #### Returns
795
+
796
+ [`useAppProps`](interfaces/useAppProps.md)
797
+
798
+ ___
799
+
745
800
  ### useConfigContext
746
801
 
747
802
  ▸ **useConfigContext**(): [`ConfigProviderProps`](interfaces/ConfigProviderProps.md)
package/dist/index.d.ts CHANGED
@@ -360,7 +360,7 @@ type UnionFaasItemInjection<Value = any, Values = any> = {
360
360
  values?: Values;
361
361
  index?: number;
362
362
  };
363
- type UnionFaasItemRender<Value = any, Values = any> = (value: Value, values: Values, index: number, scene: UnionScene) => JSX.Element | null;
363
+ type UnionFaasItemRender<Value = any, Values = any> = (value: Value, values: Values, index: number, scene: UnionScene) => React.ReactNode;
364
364
  type UnionFaasItemElement<Value = any, Values = any> = ReactElement<UnionFaasItemInjection<Value, Values>> | null;
365
365
  interface UnionFaasItemProps<Value = any, Values = any> extends FormItemProps, DescriptionItemProps, TableItemProps {
366
366
  children?: UnionFaasItemElement<UnionFaasItemProps<Value, Values>> | null;