@faasjs/ant-design 8.0.0-beta.15 → 8.0.0-beta.16

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
@@ -23,6 +23,7 @@
23
23
  - [Title](functions/Title.md)
24
24
  - [transferOptions](functions/transferOptions.md)
25
25
  - [transferValue](functions/transferValue.md)
26
+ - [useApp](functions/useApp.md)
26
27
  - [useConfigContext](functions/useConfigContext.md)
27
28
  - [useDrawer](functions/useDrawer.md)
28
29
  - [useFaas](functions/useFaas.md)
@@ -85,5 +86,5 @@
85
86
 
86
87
  ## Variables
87
88
 
89
+ - [AppContext](variables/AppContext.md)
88
90
  - [ConfigContext](variables/ConfigContext.md)
89
- - [useApp](variables/useApp.md)
package/dist/index.cjs CHANGED
@@ -272,7 +272,7 @@ function useModal(init) {
272
272
  };
273
273
  }
274
274
  //#endregion
275
- //#region src/App.tsx
275
+ //#region src/useApp.ts
276
276
  const AppContext = (0, _faasjs_react.createSplittingContext)([
277
277
  "message",
278
278
  "notification",
@@ -281,6 +281,20 @@ const AppContext = (0, _faasjs_react.createSplittingContext)([
281
281
  "drawerProps",
282
282
  "setDrawerProps"
283
283
  ]);
284
+ /**
285
+ * Get app context.
286
+ *
287
+ * ```ts
288
+ * import { useApp } from '@faasjs/ant-design'
289
+ *
290
+ * const { message, notification, setModalProps, setDrawerProps } = useApp()
291
+ * ```
292
+ */
293
+ function useApp() {
294
+ return AppContext.use();
295
+ }
296
+ //#endregion
297
+ //#region src/App.tsx
284
298
  function RoutesApp(props) {
285
299
  const location = (0, react_router_dom.useLocation)();
286
300
  const { drawerProps, setDrawerProps, modalProps, setModalProps } = useApp();
@@ -365,17 +379,6 @@ function App(props) {
365
379
  })
366
380
  });
367
381
  }
368
- /**
369
- * Get app context.
370
- *
371
- * ```ts
372
- * import { useApp } from '@faasjs/ant-design'
373
- *
374
- * const { message, notification, setModalProps, setDrawerProps } = useApp()
375
- * ```
376
- */
377
- const useApp = AppContext.use;
378
- App.useApp = useApp;
379
382
  //#endregion
380
383
  //#region src/Blank.tsx
381
384
  /**
@@ -1614,6 +1617,7 @@ function useThemeToken() {
1614
1617
  }
1615
1618
  //#endregion
1616
1619
  exports.App = App;
1620
+ exports.AppContext = AppContext;
1617
1621
  exports.Blank = Blank;
1618
1622
  exports.ConfigContext = ConfigContext;
1619
1623
  exports.ConfigProvider = ConfigProvider;
package/dist/index.d.ts CHANGED
@@ -1,7 +1,5 @@
1
1
  import * as react_jsx_runtime0 from "react/jsx-runtime";
2
2
  import { ButtonProps, ConfigProviderProps as ConfigProviderProps$1, DatePickerProps, DescriptionsProps, Drawer, DrawerProps as DrawerProps$1, FormInstance, FormItemProps as FormItemProps$1, FormProps as FormProps$1, GlobalToken, InputNumberProps, InputProps, Modal, ModalProps as ModalProps$1, RadioProps, SelectProps, SwitchProps, TableColumnProps, TablePaginationConfig, TableProps as TableProps$1, TabsProps as TabsProps$1 } from "antd";
3
- import { MessageInstance } from "antd/es/message/interface";
4
- import { NotificationInstance } from "antd/es/notification/interface";
5
3
  import { BrowserRouterProps, RouteProps } from "react-router-dom";
6
4
  import * as react from "react";
7
5
  import { CSSProperties, ComponentType, Dispatch, FC, JSX, LazyExoticComponent, ReactElement, ReactNode, SetStateAction, lazy } from "react";
@@ -16,6 +14,8 @@ import * as antd_es_form_hooks_useFormInstance0 from "antd/es/form/hooks/useForm
16
14
  import * as _rc_component_form0 from "@rc-component/form";
17
15
  import * as antd_es_form_context0 from "antd/es/form/context";
18
16
  import { Tab } from "@rc-component/tabs/lib/interface";
17
+ import { MessageInstance } from "antd/es/message/interface";
18
+ import { NotificationInstance } from "antd/es/notification/interface";
19
19
 
20
20
  //#region ../types/src/index.d.ts
21
21
  /**
@@ -206,64 +206,12 @@ declare const ConfigContext: react.Context<ConfigContextValue>;
206
206
  declare function ConfigProvider(props: ConfigProviderProps): react_jsx_runtime0.JSX.Element | null;
207
207
  declare function useConfigContext(): ConfigContextValue;
208
208
  //#endregion
209
- //#region src/Drawer.d.ts
210
- interface DrawerProps extends DrawerProps$1 {
211
- children?: JSX.Element | JSX.Element[];
212
- }
213
- type setDrawerProps = Dispatch<SetStateAction<DrawerProps>>;
214
- /**
215
- * Hook style drawer
216
- *
217
- * ```tsx
218
- * function Example() {
219
- * const { drawer, setDrawerProps } = useDrawer()
220
- *
221
- * return <>
222
- * <Button onClick={ () => setDrawerProps(prev => ({ open: !prev.open})) }>
223
- * Toggle
224
- * </Button>
225
- * {drawer}
226
- * </>
227
- * }
228
- * ```
229
- */
230
- declare function useDrawer(init?: DrawerProps): {
231
- drawer: react_jsx_runtime0.JSX.Element;
232
- drawerProps: DrawerProps;
233
- setDrawerProps: setDrawerProps;
234
- };
235
- //#endregion
236
209
  //#region src/ErrorBoundary.d.ts
237
210
  /**
238
211
  * Styled error boundary.
239
212
  */
240
213
  declare function ErrorBoundary(props: ErrorBoundaryProps): react_jsx_runtime0.JSX.Element;
241
214
  //#endregion
242
- //#region src/Modal.d.ts
243
- interface ModalProps extends ModalProps$1 {
244
- children?: JSX.Element | JSX.Element[] | string;
245
- }
246
- type setModalProps = Dispatch<SetStateAction<ModalProps>>;
247
- /**
248
- * Hook style modal
249
- *
250
- * ```tsx
251
- * function Example() {
252
- * const { modal, setModalProps } = useModal()
253
- *
254
- * return <>
255
- * <Button onClick={() => setModalProps({ open: true })}>Open Modal</Button>
256
- * {modal}
257
- * </>
258
- * }
259
- * ```
260
- */
261
- declare function useModal(init?: ModalProps): {
262
- modal: react_jsx_runtime0.JSX.Element;
263
- modalProps: ModalProps;
264
- setModalProps: setModalProps;
265
- };
266
- //#endregion
267
215
  //#region src/App.d.ts
268
216
  interface AppProps {
269
217
  children: React.ReactNode;
@@ -282,14 +230,6 @@ interface AppProps {
282
230
  /** @see https://faasjs.com/doc/ant-design/#configprovider */
283
231
  faasConfigProviderProps?: Omit<ConfigProviderProps, 'children'> | false;
284
232
  }
285
- interface useAppProps {
286
- message: MessageInstance;
287
- notification: NotificationInstance;
288
- modalProps: ModalProps;
289
- setModalProps: setModalProps;
290
- drawerProps: DrawerProps;
291
- setDrawerProps: setDrawerProps;
292
- }
293
233
  /**
294
234
  * App component with Ant Design & FaasJS
295
235
  *
@@ -318,19 +258,6 @@ interface useAppProps {
318
258
  * ```
319
259
  */
320
260
  declare function App(props: AppProps): react_jsx_runtime0.JSX.Element;
321
- declare namespace App {
322
- var useApp: any;
323
- }
324
- /**
325
- * Get app context.
326
- *
327
- * ```ts
328
- * import { useApp } from '@faasjs/ant-design'
329
- *
330
- * const { message, notification, setModalProps, setDrawerProps } = useApp()
331
- * ```
332
- */
333
- declare const useApp: any;
334
261
  //#endregion
335
262
  //#region src/Blank.d.ts
336
263
  interface BlankProps {
@@ -576,7 +503,7 @@ type UnionFaasItemInjection<Value = any, Values = any> = {
576
503
  * @param value - The value of the current item.
577
504
  * @param values - The entire list of values.
578
505
  * @param index - The index of the current item in the list.
579
- * @param scene {@link UnionScene} - The scene in which the rendering is taking place.
506
+ * @param scene - The scene in which the rendering is taking place. See {@link UnionScene}.
580
507
  *
581
508
  * @example
582
509
  * ```tsx
@@ -796,6 +723,33 @@ declare namespace Description {
796
723
  var displayName: string;
797
724
  }
798
725
  //#endregion
726
+ //#region src/Drawer.d.ts
727
+ interface DrawerProps extends DrawerProps$1 {
728
+ children?: JSX.Element | JSX.Element[];
729
+ }
730
+ type setDrawerProps = Dispatch<SetStateAction<DrawerProps>>;
731
+ /**
732
+ * Hook style drawer
733
+ *
734
+ * ```tsx
735
+ * function Example() {
736
+ * const { drawer, setDrawerProps } = useDrawer()
737
+ *
738
+ * return <>
739
+ * <Button onClick={ () => setDrawerProps(prev => ({ open: !prev.open})) }>
740
+ * Toggle
741
+ * </Button>
742
+ * {drawer}
743
+ * </>
744
+ * }
745
+ * ```
746
+ */
747
+ declare function useDrawer(init?: DrawerProps): {
748
+ drawer: react_jsx_runtime0.JSX.Element;
749
+ drawerProps: DrawerProps;
750
+ setDrawerProps: setDrawerProps;
751
+ };
752
+ //#endregion
799
753
  //#region src/Form.d.ts
800
754
  type FormSubmitProps = {
801
755
  /** Default: Submit */text?: string;
@@ -886,6 +840,31 @@ interface LinkProps {
886
840
  */
887
841
  declare function Link(props: LinkProps): react_jsx_runtime0.JSX.Element;
888
842
  //#endregion
843
+ //#region src/Modal.d.ts
844
+ interface ModalProps extends ModalProps$1 {
845
+ children?: JSX.Element | JSX.Element[] | string;
846
+ }
847
+ type setModalProps = Dispatch<SetStateAction<ModalProps>>;
848
+ /**
849
+ * Hook style modal
850
+ *
851
+ * ```tsx
852
+ * function Example() {
853
+ * const { modal, setModalProps } = useModal()
854
+ *
855
+ * return <>
856
+ * <Button onClick={() => setModalProps({ open: true })}>Open Modal</Button>
857
+ * {modal}
858
+ * </>
859
+ * }
860
+ * ```
861
+ */
862
+ declare function useModal(init?: ModalProps): {
863
+ modal: react_jsx_runtime0.JSX.Element;
864
+ modalProps: ModalProps;
865
+ setModalProps: setModalProps;
866
+ };
867
+ //#endregion
889
868
  //#region src/Routers.d.ts
890
869
  declare function PageNotFound(): react_jsx_runtime0.JSX.Element;
891
870
  interface RoutesProps {
@@ -990,6 +969,27 @@ interface TitleProps {
990
969
  */
991
970
  declare function Title(props: TitleProps): JSX.Element | null;
992
971
  //#endregion
972
+ //#region src/useApp.d.ts
973
+ interface useAppProps {
974
+ message: MessageInstance;
975
+ notification: NotificationInstance;
976
+ modalProps: ModalProps;
977
+ setModalProps: setModalProps;
978
+ drawerProps: DrawerProps;
979
+ setDrawerProps: setDrawerProps;
980
+ }
981
+ declare const AppContext: any;
982
+ /**
983
+ * Get app context.
984
+ *
985
+ * ```ts
986
+ * import { useApp } from '@faasjs/ant-design'
987
+ *
988
+ * const { message, notification, setModalProps, setDrawerProps } = useApp()
989
+ * ```
990
+ */
991
+ declare function useApp<NewT extends useAppProps = useAppProps>(this: void): Readonly<NewT>;
992
+ //#endregion
993
993
  //#region src/useThemeToken.d.ts
994
994
  /**
995
995
  * Hook to retrieve the theme token from the Ant Design theme configuration.
@@ -1001,4 +1001,4 @@ declare function Title(props: TitleProps): JSX.Element | null;
1001
1001
  */
1002
1002
  declare function useThemeToken(): GlobalToken;
1003
1003
  //#endregion
1004
- export { App, AppProps, BaseItemProps, BaseOption, Blank, BlankProps, ConfigContext, ConfigProvider, ConfigProviderProps, Description, DescriptionItemContentProps, DescriptionItemProps, DescriptionProps, Drawer, DrawerProps, ErrorBoundary, type ErrorBoundaryProps, ExtendDescriptionItemProps, ExtendDescriptionTypeProps, type ExtendFormItemProps, type ExtendFormTypeProps, ExtendTableItemProps, ExtendTableTypeProps, ExtendTypes, FaasDataInjection, FaasDataWrapper, FaasDataWrapperProps, type FaasDataWrapperRef, FaasItemProps, FaasItemType, FaasItemTypeValue, FaasReactClient, type FaasReactClientOptions, Form, FormItem, FormItemProps, FormProps, FormSubmitProps, Link, LinkProps, Loading, LoadingProps, Modal, ModalProps, PageNotFound, ResolvedTheme, Routes, RoutesProps, TabProps, Table, TableFaasDataParams, TableFaasDataResponse, TableItemProps, TableProps, Tabs, TabsProps, Title, TitleProps, UnionFaasItemElement, UnionFaasItemInjection, UnionFaasItemProps, UnionFaasItemRender, UnionScene, cloneUnionFaasItemElement, faas, idToTitle, lazy, setDrawerProps, setModalProps, transferOptions, transferValue, useApp, useAppProps, useConfigContext, useDrawer, useFaas, useModal, useThemeToken, withFaasData };
1004
+ export { App, AppContext, AppProps, BaseItemProps, BaseOption, Blank, BlankProps, ConfigContext, ConfigProvider, ConfigProviderProps, Description, DescriptionItemContentProps, DescriptionItemProps, DescriptionProps, Drawer, DrawerProps, ErrorBoundary, type ErrorBoundaryProps, ExtendDescriptionItemProps, ExtendDescriptionTypeProps, type ExtendFormItemProps, type ExtendFormTypeProps, ExtendTableItemProps, ExtendTableTypeProps, ExtendTypes, FaasDataInjection, FaasDataWrapper, FaasDataWrapperProps, type FaasDataWrapperRef, FaasItemProps, FaasItemType, FaasItemTypeValue, FaasReactClient, type FaasReactClientOptions, Form, FormItem, FormItemProps, FormProps, FormSubmitProps, Link, LinkProps, Loading, LoadingProps, Modal, ModalProps, PageNotFound, ResolvedTheme, Routes, RoutesProps, TabProps, Table, TableFaasDataParams, TableFaasDataResponse, TableItemProps, TableProps, Tabs, TabsProps, Title, TitleProps, UnionFaasItemElement, UnionFaasItemInjection, UnionFaasItemProps, UnionFaasItemRender, UnionScene, cloneUnionFaasItemElement, faas, idToTitle, lazy, setDrawerProps, setModalProps, transferOptions, transferValue, useApp, useAppProps, useConfigContext, useDrawer, useFaas, useModal, useThemeToken, withFaasData };
package/dist/index.mjs CHANGED
@@ -248,7 +248,7 @@ function useModal(init) {
248
248
  };
249
249
  }
250
250
  //#endregion
251
- //#region src/App.tsx
251
+ //#region src/useApp.ts
252
252
  const AppContext = createSplittingContext([
253
253
  "message",
254
254
  "notification",
@@ -257,6 +257,20 @@ const AppContext = createSplittingContext([
257
257
  "drawerProps",
258
258
  "setDrawerProps"
259
259
  ]);
260
+ /**
261
+ * Get app context.
262
+ *
263
+ * ```ts
264
+ * import { useApp } from '@faasjs/ant-design'
265
+ *
266
+ * const { message, notification, setModalProps, setDrawerProps } = useApp()
267
+ * ```
268
+ */
269
+ function useApp() {
270
+ return AppContext.use();
271
+ }
272
+ //#endregion
273
+ //#region src/App.tsx
260
274
  function RoutesApp(props) {
261
275
  const location = useLocation();
262
276
  const { drawerProps, setDrawerProps, modalProps, setModalProps } = useApp();
@@ -341,17 +355,6 @@ function App(props) {
341
355
  })
342
356
  });
343
357
  }
344
- /**
345
- * Get app context.
346
- *
347
- * ```ts
348
- * import { useApp } from '@faasjs/ant-design'
349
- *
350
- * const { message, notification, setModalProps, setDrawerProps } = useApp()
351
- * ```
352
- */
353
- const useApp = AppContext.use;
354
- App.useApp = useApp;
355
358
  //#endregion
356
359
  //#region src/Blank.tsx
357
360
  /**
@@ -1589,4 +1592,4 @@ function useThemeToken() {
1589
1592
  return theme.useToken().token;
1590
1593
  }
1591
1594
  //#endregion
1592
- export { App, Blank, ConfigContext, ConfigProvider, Description, Drawer, ErrorBoundary, FaasDataWrapper, FaasReactClient, Form, FormItem, Link, Loading, Modal, PageNotFound, Routes, Table, Tabs, Title, cloneUnionFaasItemElement, faas, idToTitle, lazy, transferOptions, transferValue, useApp, useConfigContext, useDrawer, useFaas, useModal, useThemeToken, withFaasData };
1595
+ export { App, AppContext, Blank, ConfigContext, ConfigProvider, Description, Drawer, ErrorBoundary, FaasDataWrapper, FaasReactClient, Form, FormItem, Link, Loading, Modal, PageNotFound, Routes, Table, Tabs, Title, cloneUnionFaasItemElement, faas, idToTitle, lazy, transferOptions, transferValue, useApp, useConfigContext, useDrawer, useFaas, useModal, useThemeToken, withFaasData };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@faasjs/ant-design",
3
- "version": "8.0.0-beta.15",
3
+ "version": "8.0.0-beta.16",
4
4
  "homepage": "https://faasjs.com/doc/ant-design",
5
5
  "bugs": {
6
6
  "url": "https://github.com/faasjs/faasjs/issues"
@@ -28,7 +28,7 @@
28
28
  },
29
29
  "devDependencies": {
30
30
  "@ant-design/icons": "*",
31
- "@faasjs/react": ">=8.0.0-beta.15",
31
+ "@faasjs/react": ">=8.0.0-beta.16",
32
32
  "@types/lodash-es": "*",
33
33
  "@types/react": "^19.0.0",
34
34
  "@types/react-dom": "^19.0.0",
@@ -40,7 +40,7 @@
40
40
  },
41
41
  "peerDependencies": {
42
42
  "@ant-design/icons": "*",
43
- "@faasjs/react": ">=8.0.0-beta.15",
43
+ "@faasjs/react": ">=8.0.0-beta.16",
44
44
  "antd": "^6.0.0",
45
45
  "lodash-es": "*",
46
46
  "react": "^19.0.0",