@refinedev/antd 5.0.0
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/CHANGELOG.md +1689 -0
- package/README.md +285 -0
- package/dist/components/breadcrumb/index.d.ts +6 -0
- package/dist/components/breadcrumb/index.d.ts.map +1 -0
- package/dist/components/buttons/clone/index.d.ts +11 -0
- package/dist/components/buttons/clone/index.d.ts.map +1 -0
- package/dist/components/buttons/create/index.d.ts +11 -0
- package/dist/components/buttons/create/index.d.ts.map +1 -0
- package/dist/components/buttons/delete/index.d.ts +10 -0
- package/dist/components/buttons/delete/index.d.ts.map +1 -0
- package/dist/components/buttons/edit/index.d.ts +11 -0
- package/dist/components/buttons/edit/index.d.ts.map +1 -0
- package/dist/components/buttons/export/index.d.ts +10 -0
- package/dist/components/buttons/export/index.d.ts.map +1 -0
- package/dist/components/buttons/import/index.d.ts +11 -0
- package/dist/components/buttons/import/index.d.ts.map +1 -0
- package/dist/components/buttons/index.d.ts +12 -0
- package/dist/components/buttons/index.d.ts.map +1 -0
- package/dist/components/buttons/list/index.d.ts +11 -0
- package/dist/components/buttons/list/index.d.ts.map +1 -0
- package/dist/components/buttons/refresh/index.d.ts +10 -0
- package/dist/components/buttons/refresh/index.d.ts.map +1 -0
- package/dist/components/buttons/save/index.d.ts +10 -0
- package/dist/components/buttons/save/index.d.ts.map +1 -0
- package/dist/components/buttons/show/index.d.ts +11 -0
- package/dist/components/buttons/show/index.d.ts.map +1 -0
- package/dist/components/buttons/types.d.ts +24 -0
- package/dist/components/buttons/types.d.ts.map +1 -0
- package/dist/components/crud/create/index.d.ts +10 -0
- package/dist/components/crud/create/index.d.ts.map +1 -0
- package/dist/components/crud/edit/index.d.ts +10 -0
- package/dist/components/crud/edit/index.d.ts.map +1 -0
- package/dist/components/crud/index.d.ts +6 -0
- package/dist/components/crud/index.d.ts.map +1 -0
- package/dist/components/crud/list/index.d.ts +10 -0
- package/dist/components/crud/list/index.d.ts.map +1 -0
- package/dist/components/crud/show/index.d.ts +10 -0
- package/dist/components/crud/show/index.d.ts.map +1 -0
- package/dist/components/crud/types.d.ts +10 -0
- package/dist/components/crud/types.d.ts.map +1 -0
- package/dist/components/fields/boolean/index.d.ts +9 -0
- package/dist/components/fields/boolean/index.d.ts.map +1 -0
- package/dist/components/fields/date/index.d.ts +9 -0
- package/dist/components/fields/date/index.d.ts.map +1 -0
- package/dist/components/fields/email/index.d.ts +10 -0
- package/dist/components/fields/email/index.d.ts.map +1 -0
- package/dist/components/fields/file/index.d.ts +9 -0
- package/dist/components/fields/file/index.d.ts.map +1 -0
- package/dist/components/fields/image/index.d.ts +9 -0
- package/dist/components/fields/image/index.d.ts.map +1 -0
- package/dist/components/fields/index.d.ts +12 -0
- package/dist/components/fields/index.d.ts.map +1 -0
- package/dist/components/fields/markdown/index.d.ts +9 -0
- package/dist/components/fields/markdown/index.d.ts.map +1 -0
- package/dist/components/fields/number/index.d.ts +9 -0
- package/dist/components/fields/number/index.d.ts.map +1 -0
- package/dist/components/fields/tag/index.d.ts +9 -0
- package/dist/components/fields/tag/index.d.ts.map +1 -0
- package/dist/components/fields/text/index.d.ts +9 -0
- package/dist/components/fields/text/index.d.ts.map +1 -0
- package/dist/components/fields/types.d.ts +20 -0
- package/dist/components/fields/types.d.ts.map +1 -0
- package/dist/components/fields/url/index.d.ts +10 -0
- package/dist/components/fields/url/index.d.ts.map +1 -0
- package/dist/components/index.d.ts +13 -0
- package/dist/components/index.d.ts.map +1 -0
- package/dist/components/layout/header/index.d.ts +4 -0
- package/dist/components/layout/header/index.d.ts.map +1 -0
- package/dist/components/layout/index.d.ts +4 -0
- package/dist/components/layout/index.d.ts.map +1 -0
- package/dist/components/layout/sider/index.d.ts +4 -0
- package/dist/components/layout/sider/index.d.ts.map +1 -0
- package/dist/components/layout/sider/styles.d.ts +3 -0
- package/dist/components/layout/sider/styles.d.ts.map +1 -0
- package/dist/components/layout/title/index.d.ts +4 -0
- package/dist/components/layout/title/index.d.ts.map +1 -0
- package/dist/components/layout/types.d.ts +3 -0
- package/dist/components/layout/types.d.ts.map +1 -0
- package/dist/components/pageHeader/index.d.ts +5 -0
- package/dist/components/pageHeader/index.d.ts.map +1 -0
- package/dist/components/pages/auth/components/forgotPassword/index.d.ts +12 -0
- package/dist/components/pages/auth/components/forgotPassword/index.d.ts.map +1 -0
- package/dist/components/pages/auth/components/index.d.ts +5 -0
- package/dist/components/pages/auth/components/index.d.ts.map +1 -0
- package/dist/components/pages/auth/components/login/index.d.ts +12 -0
- package/dist/components/pages/auth/components/login/index.d.ts.map +1 -0
- package/dist/components/pages/auth/components/register/index.d.ts +12 -0
- package/dist/components/pages/auth/components/register/index.d.ts.map +1 -0
- package/dist/components/pages/auth/components/styles.d.ts +5 -0
- package/dist/components/pages/auth/components/styles.d.ts.map +1 -0
- package/dist/components/pages/auth/components/updatePassword/index.d.ts +12 -0
- package/dist/components/pages/auth/components/updatePassword/index.d.ts.map +1 -0
- package/dist/components/pages/auth/index.d.ts +11 -0
- package/dist/components/pages/auth/index.d.ts.map +1 -0
- package/dist/components/pages/error/index.d.ts +10 -0
- package/dist/components/pages/error/index.d.ts.map +1 -0
- package/dist/components/pages/index.d.ts +7 -0
- package/dist/components/pages/index.d.ts.map +1 -0
- package/dist/components/pages/login/index.d.ts +15 -0
- package/dist/components/pages/login/index.d.ts.map +1 -0
- package/dist/components/pages/login/styles.d.ts +6 -0
- package/dist/components/pages/login/styles.d.ts.map +1 -0
- package/dist/components/pages/ready/index.d.ts +10 -0
- package/dist/components/pages/ready/index.d.ts.map +1 -0
- package/dist/components/pages/welcome/index.d.ts +6 -0
- package/dist/components/pages/welcome/index.d.ts.map +1 -0
- package/dist/components/table/components/filterDropdown/index.d.ts +13 -0
- package/dist/components/table/components/filterDropdown/index.d.ts.map +1 -0
- package/dist/components/table/components/index.d.ts +2 -0
- package/dist/components/table/components/index.d.ts.map +1 -0
- package/dist/components/table/index.d.ts +2 -0
- package/dist/components/table/index.d.ts.map +1 -0
- package/dist/components/undoableNotification/index.d.ts +10 -0
- package/dist/components/undoableNotification/index.d.ts.map +1 -0
- package/dist/definitions/index.d.ts +3 -0
- package/dist/definitions/index.d.ts.map +1 -0
- package/dist/definitions/table/index.d.ts +10 -0
- package/dist/definitions/table/index.d.ts.map +1 -0
- package/dist/definitions/upload/index.d.ts +4 -0
- package/dist/definitions/upload/index.d.ts.map +1 -0
- package/dist/esm/index.js +2 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/hooks/fields/index.d.ts +4 -0
- package/dist/hooks/fields/index.d.ts.map +1 -0
- package/dist/hooks/fields/useCheckboxGroup/index.d.ts +24 -0
- package/dist/hooks/fields/useCheckboxGroup/index.d.ts.map +1 -0
- package/dist/hooks/fields/useRadioGroup/index.d.ts +24 -0
- package/dist/hooks/fields/useRadioGroup/index.d.ts.map +1 -0
- package/dist/hooks/fields/useSelect/index.d.ts +21 -0
- package/dist/hooks/fields/useSelect/index.d.ts.map +1 -0
- package/dist/hooks/form/index.d.ts +5 -0
- package/dist/hooks/form/index.d.ts.map +1 -0
- package/dist/hooks/form/useDrawerForm/index.d.ts +2 -0
- package/dist/hooks/form/useDrawerForm/index.d.ts.map +1 -0
- package/dist/hooks/form/useDrawerForm/useDrawerForm.d.ts +33 -0
- package/dist/hooks/form/useDrawerForm/useDrawerForm.d.ts.map +1 -0
- package/dist/hooks/form/useForm.d.ts +31 -0
- package/dist/hooks/form/useForm.d.ts.map +1 -0
- package/dist/hooks/form/useModalForm/index.d.ts +2 -0
- package/dist/hooks/form/useModalForm/index.d.ts.map +1 -0
- package/dist/hooks/form/useModalForm/useModalForm.d.ts +39 -0
- package/dist/hooks/form/useModalForm/useModalForm.d.ts.map +1 -0
- package/dist/hooks/form/useStepsForm/index.d.ts +2 -0
- package/dist/hooks/form/useStepsForm/index.d.ts.map +1 -0
- package/dist/hooks/form/useStepsForm/useStepsForm.d.ts +35 -0
- package/dist/hooks/form/useStepsForm/useStepsForm.d.ts.map +1 -0
- package/dist/hooks/import/index.d.ts +18 -0
- package/dist/hooks/import/index.d.ts.map +1 -0
- package/dist/hooks/index.d.ts +8 -0
- package/dist/hooks/index.d.ts.map +1 -0
- package/dist/hooks/list/index.d.ts +2 -0
- package/dist/hooks/list/index.d.ts.map +1 -0
- package/dist/hooks/list/useSimpleList/index.d.ts +2 -0
- package/dist/hooks/list/useSimpleList/index.d.ts.map +1 -0
- package/dist/hooks/list/useSimpleList/useSimpleList.d.ts +23 -0
- package/dist/hooks/list/useSimpleList/useSimpleList.d.ts.map +1 -0
- package/dist/hooks/modal/index.d.ts +2 -0
- package/dist/hooks/modal/index.d.ts.map +1 -0
- package/dist/hooks/modal/useModal/index.d.ts +18 -0
- package/dist/hooks/modal/useModal/index.d.ts.map +1 -0
- package/dist/hooks/table/index.d.ts +3 -0
- package/dist/hooks/table/index.d.ts.map +1 -0
- package/dist/hooks/table/useEditableTable/index.d.ts +2 -0
- package/dist/hooks/table/useEditableTable/index.d.ts.map +1 -0
- package/dist/hooks/table/useEditableTable/useEditableTable.d.ts +28 -0
- package/dist/hooks/table/useEditableTable/useEditableTable.d.ts.map +1 -0
- package/dist/hooks/table/useTable/index.d.ts +2 -0
- package/dist/hooks/table/useTable/index.d.ts.map +1 -0
- package/dist/hooks/table/useTable/paginationLink.d.ts +8 -0
- package/dist/hooks/table/useTable/paginationLink.d.ts.map +1 -0
- package/dist/hooks/table/useTable/useTable.d.ts +18 -0
- package/dist/hooks/table/useTable/useTable.d.ts.map +1 -0
- package/dist/hooks/useFileUploadState/index.d.ts +7 -0
- package/dist/hooks/useFileUploadState/index.d.ts.map +1 -0
- package/dist/iife/index.js +56 -0
- package/dist/iife/index.js.map +1 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -0
- package/dist/interfaces/field.d.ts +4 -0
- package/dist/interfaces/field.d.ts.map +1 -0
- package/dist/interfaces/index.d.ts +19 -0
- package/dist/interfaces/index.d.ts.map +1 -0
- package/dist/interfaces/upload.d.ts +10 -0
- package/dist/interfaces/upload.d.ts.map +1 -0
- package/dist/providers/index.d.ts +2 -0
- package/dist/providers/index.d.ts.map +1 -0
- package/dist/providers/notificationProvider/index.d.ts +3 -0
- package/dist/providers/notificationProvider/index.d.ts.map +1 -0
- package/dist/reset.css +254 -0
- package/package.json +72 -0
- package/refine.config.js +604 -0
- package/src/assets/styles/reset.css +254 -0
- package/src/components/breadcrumb/index.tsx +70 -0
- package/src/components/buttons/clone/index.tsx +104 -0
- package/src/components/buttons/create/index.tsx +103 -0
- package/src/components/buttons/delete/index.tsx +122 -0
- package/src/components/buttons/edit/index.tsx +105 -0
- package/src/components/buttons/export/index.tsx +32 -0
- package/src/components/buttons/import/index.tsx +36 -0
- package/src/components/buttons/index.ts +11 -0
- package/src/components/buttons/list/index.tsx +122 -0
- package/src/components/buttons/refresh/index.tsx +61 -0
- package/src/components/buttons/save/index.tsx +32 -0
- package/src/components/buttons/show/index.tsx +104 -0
- package/src/components/buttons/types.ts +44 -0
- package/src/components/crud/create/index.tsx +135 -0
- package/src/components/crud/edit/index.tsx +221 -0
- package/src/components/crud/index.ts +6 -0
- package/src/components/crud/list/index.tsx +105 -0
- package/src/components/crud/show/index.tsx +215 -0
- package/src/components/crud/types.ts +63 -0
- package/src/components/fields/boolean/index.tsx +26 -0
- package/src/components/fields/date/index.tsx +33 -0
- package/src/components/fields/email/index.tsx +20 -0
- package/src/components/fields/file/index.tsx +21 -0
- package/src/components/fields/image/index.tsx +17 -0
- package/src/components/fields/index.ts +11 -0
- package/src/components/fields/markdown/index.tsx +16 -0
- package/src/components/fields/number/index.tsx +36 -0
- package/src/components/fields/tag/index.tsx +13 -0
- package/src/components/fields/text/index.tsx +15 -0
- package/src/components/fields/types.ts +49 -0
- package/src/components/fields/url/index.tsx +24 -0
- package/src/components/index.ts +14 -0
- package/src/components/layout/header/index.tsx +37 -0
- package/src/components/layout/index.tsx +41 -0
- package/src/components/layout/sider/index.tsx +261 -0
- package/src/components/layout/sider/styles.ts +9 -0
- package/src/components/layout/title/index.tsx +48 -0
- package/src/components/layout/types.ts +11 -0
- package/src/components/pageHeader/index.tsx +52 -0
- package/src/components/pages/auth/components/forgotPassword/index.tsx +167 -0
- package/src/components/pages/auth/components/index.tsx +4 -0
- package/src/components/pages/auth/components/login/index.tsx +239 -0
- package/src/components/pages/auth/components/register/index.tsx +210 -0
- package/src/components/pages/auth/components/styles.ts +23 -0
- package/src/components/pages/auth/components/updatePassword/index.tsx +158 -0
- package/src/components/pages/auth/index.tsx +35 -0
- package/src/components/pages/error/index.tsx +77 -0
- package/src/components/pages/index.tsx +6 -0
- package/src/components/pages/login/index.tsx +172 -0
- package/src/components/pages/login/styles.ts +25 -0
- package/src/components/pages/ready/index.tsx +96 -0
- package/src/components/pages/welcome/index.tsx +87 -0
- package/src/components/table/components/filterDropdown/index.tsx +112 -0
- package/src/components/table/components/index.ts +1 -0
- package/src/components/table/index.ts +1 -0
- package/src/components/undoableNotification/index.tsx +46 -0
- package/src/definitions/index.ts +2 -0
- package/src/definitions/table/index.ts +113 -0
- package/src/definitions/upload/index.ts +29 -0
- package/src/hooks/fields/index.ts +3 -0
- package/src/hooks/fields/useCheckboxGroup/index.ts +85 -0
- package/src/hooks/fields/useRadioGroup/index.ts +85 -0
- package/src/hooks/fields/useSelect/index.ts +47 -0
- package/src/hooks/form/index.ts +17 -0
- package/src/hooks/form/useDrawerForm/index.ts +6 -0
- package/src/hooks/form/useDrawerForm/useDrawerForm.ts +241 -0
- package/src/hooks/form/useForm.ts +168 -0
- package/src/hooks/form/useModalForm/index.ts +5 -0
- package/src/hooks/form/useModalForm/useModalForm.ts +286 -0
- package/src/hooks/form/useStepsForm/index.ts +5 -0
- package/src/hooks/form/useStepsForm/useStepsForm.ts +91 -0
- package/src/hooks/import/index.tsx +134 -0
- package/src/hooks/index.ts +7 -0
- package/src/hooks/list/index.ts +1 -0
- package/src/hooks/list/useSimpleList/index.ts +1 -0
- package/src/hooks/list/useSimpleList/useSimpleList.ts +229 -0
- package/src/hooks/modal/index.ts +1 -0
- package/src/hooks/modal/useModal/index.tsx +43 -0
- package/src/hooks/table/index.ts +2 -0
- package/src/hooks/table/useEditableTable/index.ts +1 -0
- package/src/hooks/table/useEditableTable/useEditableTable.ts +87 -0
- package/src/hooks/table/useTable/index.ts +1 -0
- package/src/hooks/table/useTable/paginationLink.tsx +27 -0
- package/src/hooks/table/useTable/useTable.ts +267 -0
- package/src/hooks/useFileUploadState/index.ts +34 -0
- package/src/index.tsx +11 -0
- package/src/interfaces/field.ts +3 -0
- package/src/interfaces/index.ts +23 -0
- package/src/interfaces/upload.ts +9 -0
- package/src/providers/index.ts +1 -0
- package/src/providers/notificationProvider/index.tsx +41 -0
- package/src/types/index.d.ts +4 -0
- package/src/types/sunflower.d.ts +86 -0
- package/tsconfig.json +28 -0
package/README.md
ADDED
|
@@ -0,0 +1,285 @@
|
|
|
1
|
+
<br/>
|
|
2
|
+
|
|
3
|
+
<div align="center" style="margin: 30px;">
|
|
4
|
+
<a href="https://refine.dev/">
|
|
5
|
+
<img src="https://refine.ams3.cdn.digitaloceanspaces.com/refine_logo.png" style="width:250px;" align="center" />
|
|
6
|
+
</a>
|
|
7
|
+
<br />
|
|
8
|
+
<br />
|
|
9
|
+
|
|
10
|
+
<div align="center">
|
|
11
|
+
<a href="https://refine.dev">Home Page</a> |
|
|
12
|
+
<a href="https://discord.gg/refine">Discord</a> |
|
|
13
|
+
<a href="https://refine.dev/examples/">Examples</a> |
|
|
14
|
+
<a href="https://refine.dev/blog/">Blog</a> |
|
|
15
|
+
<a href="https://refine.dev/docs/">Documentation</a> |
|
|
16
|
+
<a href="https://github.com/refinedev/refine/projects/1">Roadmap</a>
|
|
17
|
+
</div>
|
|
18
|
+
</div>
|
|
19
|
+
|
|
20
|
+
<br />
|
|
21
|
+
|
|
22
|
+
<div align="center"><strong>Build your <a href="https://reactjs.org/">React</a>-based CRUD applications, without constraints.</strong><br>An open source, headless web application framework developed with flexibility in mind.
|
|
23
|
+
|
|
24
|
+
<br />
|
|
25
|
+
<br />
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
[](https://discord.gg/refine)
|
|
29
|
+
[](https://twitter.com/refine_dev)
|
|
30
|
+
|
|
31
|
+
<a href="https://www.producthunt.com/posts/refine-3?utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-refine-3" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=362220&theme=light&period=daily" alt="refine - 100% open source React framework to build web apps 3x faster | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
|
32
|
+
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
<div align="center">
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
[](https://github.com/refinedev/awesome-refine)
|
|
42
|
+
[](https://codeclimate.com/github/pankod/refine/maintainability)
|
|
43
|
+
[](https://codeclimate.com/github/pankod/refine/test_coverage)
|
|
44
|
+
[](https://www.npmjs.com/package/@refinedev/core)
|
|
45
|
+
[](https://www.npmjs.com/package/@refinedev/core)
|
|
46
|
+
[](https://github.com/refinedev/refine/commits/next)
|
|
47
|
+
[](CODE_OF_CONDUCT.md)
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
|
|
53
|
+
<br/>
|
|
54
|
+
<a href="https://refine.dev/">
|
|
55
|
+
<picture>
|
|
56
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/18739364/200257042-3f2aa7f7-a07f-4824-8d2a-b25f26b6fd32.png">
|
|
57
|
+
<img alt="how-works-refine" src="https://user-images.githubusercontent.com/18739364/200257209-8fc0c8b1-2568-453e-873f-00513434deed.png">
|
|
58
|
+
</picture>
|
|
59
|
+
</a>
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
## What is refine?
|
|
66
|
+
**refine** is a React-based framework for the rapid ✨ development of web applications.
|
|
67
|
+
It eliminates repetitive tasks demanded by **CRUD** operations and provides industry standard solutions for critical parts like **authentication**, **access control**, **routing**, **networking**, **state management**, and **i18n**.
|
|
68
|
+
|
|
69
|
+
**refine** is *headless by design*, thereby offering unlimited styling and customization options.
|
|
70
|
+
|
|
71
|
+
## What do you mean by "headless" ?
|
|
72
|
+
Instead of being a limited set of pre-styled components, **refine** is a collection of helper `hooks`, `components`, and `providers`. They are all decoupled from *UI components* and *business logic*, so that they never keep you from customizing your *UI* or coding your own flow.
|
|
73
|
+
|
|
74
|
+
**refine** seamlessly works with any **custom design** or **UI framework** that you favor. For convenience, it ships with ready-made integrations for [Ant Design System](https://ant.design/), [Material UI](https://mui.com/), [Mantine](https://mantine.dev/), and [Chakra UI](https://chakra-ui.com/).
|
|
75
|
+
|
|
76
|
+
## Use cases
|
|
77
|
+
**refine** shines on *data-intensive⚡* applications like **admin panels**, **dashboards** and **internal tools**. Thanks to the built-in **SSR support**, **refine** can also power *customer-facing* applications like **storefronts**.
|
|
78
|
+
|
|
79
|
+
You can take a look at some live examples that can be built using **refine** from scratch:
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
<a href="https://s.refine.dev/readme-admin-panel" target="_blank">
|
|
85
|
+
<img src="https://user-images.githubusercontent.com/18739364/204285956-cc20fa11-b769-4bd5-b8f6-9c05a283ac85.gif" style="width:267px;" />
|
|
86
|
+
</a>
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
<a href="https://s.refine.dev/readme-medium-clone" target="_blank">
|
|
90
|
+
<img src="https://user-images.githubusercontent.com/18739364/204285047-8f24f1f4-65ea-4952-83ed-81e92cdd5b90.gif" style="width:200px;" />
|
|
91
|
+
</a>
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
<a href="https://s.refine.dev/readme-ssr-storefront" target="_blank">
|
|
95
|
+
<img src="https://user-images.githubusercontent.com/18739364/204285039-1ce0cb06-fbf8-4704-89c9-2e004620c9a8.gif" style="width:200px;" />
|
|
96
|
+
</a>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<br/>
|
|
100
|
+
<br/>
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
[👉 Refer to most popular real use case examples](https://refine.dev/examples/)
|
|
104
|
+
|
|
105
|
+
[👉 More **refine** powered different usage scenarios can be found here](https://refine.dev/docs/examples/)
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
## Key Features
|
|
111
|
+
|
|
112
|
+
⚙️ Zero-config, **one-minute setup** with a **single CLI command**
|
|
113
|
+
|
|
114
|
+
🔌 Connectors for **15+ backend services** including [REST API](https://github.com/refinedev/refine/tree/master/packages/simple-rest), [GraphQL](https://github.com/refinedev/refine/tree/master/packages/graphql), [NestJs CRUD](https://github.com/refinedev/refine/tree/master/packages/nestjsx-crud), [Airtable](https://github.com/refinedev/refine/tree/master/packages/airtable), [Strapi](https://github.com/refinedev/refine/tree/master/packages/strapi), [Strapi v4](https://github.com/refinedev/refine/tree/master/packages/strapi-v4), [Strapi GraphQL](https://github.com/refinedev/refine/tree/master/packages/strapi-graphql), [Supabase](https://github.com/refinedev/refine/tree/master/packages/supabase), [Hasura](https://github.com/refinedev/refine/tree/master/packages/hasura), [Appwrite](https://github.com/refinedev/refine/tree/master/packages/appwrite), [Firebase](https://firebase.google.com/), and [Directus](https://directus.io/).
|
|
115
|
+
|
|
116
|
+
🌐 **SSR support** with **Next.js** or **Remix**
|
|
117
|
+
|
|
118
|
+
🔍 Auto-generated **CRUD** UIs from **your API data structure**
|
|
119
|
+
|
|
120
|
+
⚛ Perfect **state management** & **mutations** with **React Query**
|
|
121
|
+
|
|
122
|
+
🔀 **Advanced routing** with any router library of your choice
|
|
123
|
+
|
|
124
|
+
🔐 Providers for seamless **authentication** and **access control** flows
|
|
125
|
+
|
|
126
|
+
⚡ Out-of-the-box support for **live / real-time applications**
|
|
127
|
+
|
|
128
|
+
📄 Easy **audit logs** & **document versioning**
|
|
129
|
+
|
|
130
|
+
💬 Support for any **i18n** framework
|
|
131
|
+
|
|
132
|
+
💪 Future-proof, **robust architecture**
|
|
133
|
+
|
|
134
|
+
⌛️ Built-in [CLI](https://refine.dev/docs/packages/documentation/cli/) with time-saving features
|
|
135
|
+
|
|
136
|
+
✅ Full **test coverage**
|
|
137
|
+
|
|
138
|
+
## Quick Start
|
|
139
|
+
|
|
140
|
+
The fastest way to get started with **refine** is by using the `create refine-app` project starter tool.
|
|
141
|
+
Run the following command to create a new **refine** project configured with [Ant Design System](https://ant.design/) as the default UI framework:
|
|
142
|
+
|
|
143
|
+
```
|
|
144
|
+
npm create refine-app@latest -- --preset refine-antd
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
Once the setup is complete, navigate to the project folder and start your project with:
|
|
148
|
+
|
|
149
|
+
```
|
|
150
|
+
npm run dev
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
<br/>
|
|
154
|
+
|
|
155
|
+
Your **refine** application will be accessible at [http://localhost:3000](http://localhost:3000):
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<a href="http://localhost:3000"></a>
|
|
160
|
+
|
|
161
|
+
<br/>
|
|
162
|
+
|
|
163
|
+
Let's consume a public `fake REST API` and add two resources (*posts*, *categories*) to our project. Replace the contents of `src/App.tsx` with the following code:
|
|
164
|
+
|
|
165
|
+
```tsx title="src/App.tsx"
|
|
166
|
+
import { Refine } from "@refinedev/core";
|
|
167
|
+
import { Layout, notificationProvider, ErrorComponent } from "@refinedev/antd";
|
|
168
|
+
import routerProvider, { NavigateToResource } from "@refinedev/react-router-v6";
|
|
169
|
+
import dataProvider from "@refinedev/simple-rest";
|
|
170
|
+
|
|
171
|
+
import { BrowserRouter, Routes, Route, Outlet } from "react-router-dom";
|
|
172
|
+
|
|
173
|
+
import { AntdInferencer } from "@refinedev/inferencer/antd";
|
|
174
|
+
|
|
175
|
+
import "@refinedev/antd/dist/reset.css";
|
|
176
|
+
|
|
177
|
+
const App: React.FC = () => {
|
|
178
|
+
return (
|
|
179
|
+
<BrowserRouter>
|
|
180
|
+
<Refine
|
|
181
|
+
routerProvider={routerProvider}
|
|
182
|
+
dataProvider={dataProvider("https://api.fake-rest.refine.dev")}
|
|
183
|
+
notificationProvider={notificationProvider}
|
|
184
|
+
resources={[
|
|
185
|
+
{
|
|
186
|
+
name: 'posts',
|
|
187
|
+
list: "/posts",
|
|
188
|
+
show: "/posts/show/:id",
|
|
189
|
+
create: "/posts/create",
|
|
190
|
+
edit: "/posts/edit/:id",
|
|
191
|
+
meta: { canDelete: true },
|
|
192
|
+
},
|
|
193
|
+
{
|
|
194
|
+
name: 'categories',
|
|
195
|
+
list: "/categories",
|
|
196
|
+
show: "/categories/show/:id",
|
|
197
|
+
}
|
|
198
|
+
]}
|
|
199
|
+
>
|
|
200
|
+
<Routes>
|
|
201
|
+
<Route
|
|
202
|
+
element={(
|
|
203
|
+
<Layout>
|
|
204
|
+
<Outlet />
|
|
205
|
+
</Layout>
|
|
206
|
+
)}
|
|
207
|
+
>
|
|
208
|
+
<Route index element={<NavigateToResource />} />
|
|
209
|
+
<Route path="posts">
|
|
210
|
+
<Route index element={<AntdInferencer />} />
|
|
211
|
+
<Route path="show/:id" element={<AntdInferencer />} />
|
|
212
|
+
<Route path="create" element={<AntdInferencer />} />
|
|
213
|
+
<Route path="edit/:id" element={<AntdInferencer />} />
|
|
214
|
+
</Route>
|
|
215
|
+
<Route path="categories">
|
|
216
|
+
<Route index element={<AntdInferencer />} />
|
|
217
|
+
<Route path="show/:id" element={<AntdInferencer />} />
|
|
218
|
+
</Route>
|
|
219
|
+
<Route path="*" element={<ErrorComponent />} />
|
|
220
|
+
</Route>
|
|
221
|
+
</Routes>
|
|
222
|
+
</Refine>
|
|
223
|
+
</BrowserRouter>
|
|
224
|
+
);
|
|
225
|
+
};
|
|
226
|
+
|
|
227
|
+
export default App;
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
<br/>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
🚀 Thanks to **refine Inferencer package**, it guesses the configuration to use for the `list`, `show`, `create`, and `edit` pages based on the data fetched from the API and generates the pages automatically.
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
Now, you should see the output as a table populated with `post` & `category` data:
|
|
239
|
+
|
|
240
|
+

|
|
241
|
+
|
|
242
|
+
<br/>
|
|
243
|
+
|
|
244
|
+
You can get the auto-generated pages codes by clicking the `Show Code` button on each page. Afterward, simply pass the pages to the `resources` array by replacing with the Inferencer components.
|
|
245
|
+
|
|
246
|
+
## Next Steps
|
|
247
|
+
|
|
248
|
+
👉 Jump to [Tutorial](https://refine.dev/docs/tutorial/introduction/index/) to continue your work and turn the example into a full-blown CRUD application.
|
|
249
|
+
|
|
250
|
+
👉 Visit [Learn the Basics Page](https://refine.dev/docs/getting-started/overview/) to get informed about the fundamental concepts.
|
|
251
|
+
|
|
252
|
+
👉 Read more on [Advanced Tutorials
|
|
253
|
+
](https://refine.dev/docs/advanced-tutorials/) for different usage scenarios.
|
|
254
|
+
|
|
255
|
+
👉 See the real-life [Finefoods Demo](https://refine.dev/demo/) project.
|
|
256
|
+
|
|
257
|
+
👉 Play with interactive [Examples](https://refine.dev/docs/examples/)
|
|
258
|
+
|
|
259
|
+
## Roadmap
|
|
260
|
+
You can find refine's <a href="https://github.com/refinedev/refine/projects/1">Public Roadmap here!</a>
|
|
261
|
+
|
|
262
|
+
## Stargazers
|
|
263
|
+
|
|
264
|
+
[](https://github.com/refinedev/refine/stargazers)
|
|
265
|
+
|
|
266
|
+
## Contribution
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
[👉 Refer to contribution docs for more information](https://refine.dev/docs/contributing/#ways-to-contribute)
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
If you have any doubts related to the project or want to discuss something, then join our [Discord Server](https://discord.gg/refine).
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
## Our ♥️ Contributors
|
|
278
|
+
|
|
279
|
+
<a href="https://github.com/refinedev/refine/graphs/contributors">
|
|
280
|
+
<img src="https://contrib.rocks/image?repo=refinedev/refine" />
|
|
281
|
+
</a>
|
|
282
|
+
|
|
283
|
+
## License
|
|
284
|
+
|
|
285
|
+
Licensed under the MIT License, Copyright © 2021-present Refinedev
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { RefineBreadcrumbProps } from "@refinedev/ui-types";
|
|
3
|
+
import { BreadcrumbProps as AntdBreadcrumbProps } from "antd";
|
|
4
|
+
export declare type BreadcrumbProps = RefineBreadcrumbProps<AntdBreadcrumbProps>;
|
|
5
|
+
export declare const Breadcrumb: React.FC<BreadcrumbProps>;
|
|
6
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/breadcrumb/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAU1B,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAE5D,OAAO,EAEH,eAAe,IAAI,mBAAmB,EACzC,MAAM,MAAM,CAAC;AAGd,oBAAY,eAAe,GAAG,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;AAEzE,eAAO,MAAM,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,eAAe,CAiDhD,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { CloneButtonProps } from "../types";
|
|
3
|
+
/**
|
|
4
|
+
* `<CloneButton>` uses Ant Design's {@link https://ant.design/components/button/ `<Button> component`}.
|
|
5
|
+
* It uses the {@link https://refine.dev/docs/core/hooks/navigation/useNavigation#clone `clone`} method from {@link https://refine.dev/docs/core/hooks/navigation/useNavigation useNavigation} under the hood.
|
|
6
|
+
* It can be useful when redirecting the app to the create page with the record id route of resource.
|
|
7
|
+
*
|
|
8
|
+
* @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/clone-button} for more details.
|
|
9
|
+
*/
|
|
10
|
+
export declare const CloneButton: React.FC<CloneButtonProps>;
|
|
11
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/buttons/clone/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAc1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC,gBAAgB,CAgFlD,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { CreateButtonProps } from "../types";
|
|
3
|
+
/**
|
|
4
|
+
* <CreateButton> uses Ant Design's {@link https://ant.design/components/button/ `<Button> component`}.
|
|
5
|
+
* It uses the {@link https://refine.dev/docs/core/hooks/navigation/useNavigation#create `create`} method from {@link https://refine.dev/docs/core/hooks/navigation/useNavigation `useNavigation`} under the hood.
|
|
6
|
+
* It can be useful to redirect the app to the create page route of resource}.
|
|
7
|
+
*
|
|
8
|
+
* @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/create-button} for more details.
|
|
9
|
+
*/
|
|
10
|
+
export declare const CreateButton: React.FC<CreateButtonProps>;
|
|
11
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/buttons/create/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAc1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CA+EpD,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { DeleteButtonProps } from "../types";
|
|
3
|
+
/**
|
|
4
|
+
* `<DeleteButton>` uses Ant Design's {@link https://ant.design/components/button/ `<Button>`} and {@link https://ant.design/components/button/ `<Popconfirm>`} components.
|
|
5
|
+
* When you try to delete something, a pop-up shows up and asks for confirmation. When confirmed it executes the `useDelete` method provided by your `dataProvider`.
|
|
6
|
+
*
|
|
7
|
+
* @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/delete-button} for more details.
|
|
8
|
+
*/
|
|
9
|
+
export declare const DeleteButton: React.FC<DeleteButtonProps>;
|
|
10
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/buttons/delete/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAa1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAoGpD,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { EditButtonProps } from "../types";
|
|
3
|
+
/**
|
|
4
|
+
* `<EditButton>` uses Ant Design's {@link https://ant.design/components/button/ `<Button>`} component.
|
|
5
|
+
* It uses the {@link https://refine.dev/docs/core/hooks/navigation/useNavigation#edit `edit`} method from {@link https://refine.dev/docs/core/hooks/navigation/useNavigation `useNavigation`} under the hood.
|
|
6
|
+
* It can be useful when redirecting the app to the edit page with the record id route of resource}.
|
|
7
|
+
*
|
|
8
|
+
* @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/edit-button} for more details.
|
|
9
|
+
*/
|
|
10
|
+
export declare const EditButton: React.FC<EditButtonProps>;
|
|
11
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/buttons/edit/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAc1B,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,eAAe,CAiFhD,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { ExportButtonProps } from "../types";
|
|
3
|
+
/**
|
|
4
|
+
* `<ExportButton>` is an Ant Design {@link https://ant.design/components/button/ `<Button>`} with a default export icon and a default text with "Export".
|
|
5
|
+
* It only has presentational value.
|
|
6
|
+
*
|
|
7
|
+
* @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/export-button} for more details.
|
|
8
|
+
*/
|
|
9
|
+
export declare const ExportButton: React.FC<ExportButtonProps>;
|
|
10
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/buttons/export/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAM1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAiBpD,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { ImportButtonProps } from "../types";
|
|
3
|
+
/**
|
|
4
|
+
* `<ImportButton>` is compatible with the {@link https://refine.dev/docs/ui-frameworks/antd/hooks/import/useImport `useImport`} hook and is meant to be used as it's upload button.
|
|
5
|
+
* It uses Ant Design's {@link https://ant.design/components/button/ `<Button>`} and {@link https://ant.design/components/upload/ `<Upload>`} components.
|
|
6
|
+
* It wraps a `<Button>` component with an `<Upload>` component and accepts properties for `<Button>` and `<Upload>` components separately.
|
|
7
|
+
*
|
|
8
|
+
* @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/import-button} for more details.
|
|
9
|
+
*/
|
|
10
|
+
export declare const ImportButton: React.FC<ImportButtonProps>;
|
|
11
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/buttons/import/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAM1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAoBpD,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export { CreateButton } from "./create";
|
|
2
|
+
export { EditButton } from "./edit";
|
|
3
|
+
export { DeleteButton } from "./delete";
|
|
4
|
+
export { RefreshButton } from "./refresh";
|
|
5
|
+
export { ShowButton } from "./show";
|
|
6
|
+
export { ListButton } from "./list";
|
|
7
|
+
export { ExportButton } from "./export";
|
|
8
|
+
export { SaveButton } from "./save";
|
|
9
|
+
export { CloneButton } from "./clone";
|
|
10
|
+
export { ImportButton } from "./import";
|
|
11
|
+
export * from "./types";
|
|
12
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/buttons/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,cAAc,SAAS,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { ListButtonProps } from "../types";
|
|
3
|
+
/**
|
|
4
|
+
* `<ListButton>` is using Ant Design's {@link https://ant.design/components/button/ `<Button>`} component.
|
|
5
|
+
* It uses the {@link https://refine.dev/docs/core/hooks/navigation/useNavigation#list `list`} method from {@link https://refine.dev/docs/core/hooks/navigation/useNavigation `useNavigation`} under the hood.
|
|
6
|
+
* It can be useful when redirecting the app to the list page route of resource}.
|
|
7
|
+
*
|
|
8
|
+
* @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/list-button} for more details.
|
|
9
|
+
*/
|
|
10
|
+
export declare const ListButton: React.FC<ListButtonProps>;
|
|
11
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/buttons/list/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAgB1B,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,eAAe,CAgGhD,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { RefreshButtonProps } from "../types";
|
|
3
|
+
/**
|
|
4
|
+
* `<RefreshButton>` uses Ant Design's {@link https://ant.design/components/button/ `<Button>`} component
|
|
5
|
+
* to update the data shown on the page via the {@link https://refine.dev/docs/core/hooks/data/useOne `useOne`} method provided by your dataProvider.
|
|
6
|
+
*
|
|
7
|
+
* @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/refresh-button} for more details.
|
|
8
|
+
*/
|
|
9
|
+
export declare const RefreshButton: React.FC<RefreshButtonProps>;
|
|
10
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/buttons/refresh/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAW1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAE9C;;;;;GAKG;AACH,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC,kBAAkB,CAyCtD,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { SaveButtonProps } from "../types";
|
|
3
|
+
/**
|
|
4
|
+
* `<SaveButton>` uses Ant Design's {@link https://ant.design/components/button/ `<Button>`} component.
|
|
5
|
+
* It uses it for presantation purposes only. Some of the hooks that refine has adds features to this button.
|
|
6
|
+
*
|
|
7
|
+
* @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/save-button} for more details.
|
|
8
|
+
*/
|
|
9
|
+
export declare const SaveButton: React.FC<SaveButtonProps>;
|
|
10
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/buttons/save/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAM1B,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C;;;;;GAKG;AACH,eAAO,MAAM,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,eAAe,CAiBhD,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { ShowButtonProps } from "../types";
|
|
3
|
+
/**
|
|
4
|
+
* `<ShowButton>` uses Ant Design's {@link https://ant.design/components/button/ `<Button>`} component.
|
|
5
|
+
* It uses the {@link https://refine.dev/docs/core/hooks/navigation/useNavigation#show `show`} method from {@link https://refine.dev/docs/core/hooks/navigation/useNavigation `useNavigation`} under the hood.
|
|
6
|
+
* It can be useful when redirecting the app to the show page with the record id route of resource.
|
|
7
|
+
*
|
|
8
|
+
* @see {@link https://refine.dev/docs/ui-frameworks/antd/components/buttons/show-button} for more details.
|
|
9
|
+
*/
|
|
10
|
+
export declare const ShowButton: React.FC<ShowButtonProps>;
|
|
11
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/buttons/show/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAc1B,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,eAAe,CAgFhD,CAAC"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { ButtonProps, UploadProps } from "antd";
|
|
2
|
+
import { RefineCloneButtonProps, RefineCreateButtonProps, RefineDeleteButtonProps, RefineEditButtonProps, RefineExportButtonProps, RefineImportButtonProps, RefineListButtonProps, RefineRefreshButtonProps, RefineSaveButtonProps, RefineShowButtonProps } from "@refinedev/ui-types";
|
|
3
|
+
export declare type ShowButtonProps = RefineShowButtonProps<ButtonProps>;
|
|
4
|
+
export declare type CloneButtonProps = RefineCloneButtonProps<ButtonProps>;
|
|
5
|
+
export declare type CreateButtonProps = RefineCreateButtonProps<ButtonProps>;
|
|
6
|
+
export declare type DeleteButtonProps = RefineDeleteButtonProps<ButtonProps>;
|
|
7
|
+
export declare type EditButtonProps = RefineEditButtonProps<ButtonProps>;
|
|
8
|
+
export declare type ExportButtonProps = RefineExportButtonProps<ButtonProps>;
|
|
9
|
+
export declare type ImportButtonProps = RefineImportButtonProps & {
|
|
10
|
+
/**
|
|
11
|
+
* Sets the button type
|
|
12
|
+
* @type [UploadProps](https://ant.design/components/upload/#API)
|
|
13
|
+
*/
|
|
14
|
+
uploadProps: UploadProps;
|
|
15
|
+
/**
|
|
16
|
+
* Sets props of the button
|
|
17
|
+
* @type [ButtonProps](https://ant.design/components/button/#API)
|
|
18
|
+
*/
|
|
19
|
+
buttonProps: ButtonProps;
|
|
20
|
+
};
|
|
21
|
+
export declare type ListButtonProps = RefineListButtonProps<ButtonProps>;
|
|
22
|
+
export declare type RefreshButtonProps = RefineRefreshButtonProps<ButtonProps>;
|
|
23
|
+
export declare type SaveButtonProps = RefineSaveButtonProps<ButtonProps>;
|
|
24
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/components/buttons/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAChD,OAAO,EACH,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACrB,wBAAwB,EACxB,qBAAqB,EACrB,qBAAqB,EACxB,MAAM,qBAAqB,CAAC;AAE7B,oBAAY,eAAe,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;AAEjE,oBAAY,gBAAgB,GAAG,sBAAsB,CAAC,WAAW,CAAC,CAAC;AAEnE,oBAAY,iBAAiB,GAAG,uBAAuB,CAAC,WAAW,CAAC,CAAC;AAErE,oBAAY,iBAAiB,GAAG,uBAAuB,CAAC,WAAW,CAAC,CAAC;AAErE,oBAAY,eAAe,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;AAEjE,oBAAY,iBAAiB,GAAG,uBAAuB,CAAC,WAAW,CAAC,CAAC;AAErE,oBAAY,iBAAiB,GAAG,uBAAuB,GAAG;IACtD;;;OAGG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;;OAGG;IACH,WAAW,EAAE,WAAW,CAAC;CAC5B,CAAC;AAEF,oBAAY,eAAe,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;AAEjE,oBAAY,kBAAkB,GAAG,wBAAwB,CAAC,WAAW,CAAC,CAAC;AAEvE,oBAAY,eAAe,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { CreateProps } from "../types";
|
|
3
|
+
/**
|
|
4
|
+
* `<Create>` provides us a layout to display the page.
|
|
5
|
+
* It does not contain any logic but adds extra functionalities like action buttons and giving titles to the page.
|
|
6
|
+
*
|
|
7
|
+
* @see {@link https://refine.dev/docs/ui-frameworks/antd/components/basic-views/create} for more details.
|
|
8
|
+
*/
|
|
9
|
+
export declare const Create: React.FC<CreateProps>;
|
|
10
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/crud/create/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAa1B,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC;;;;;GAKG;AACH,eAAO,MAAM,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,WAAW,CAiHxC,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { EditProps } from "../types";
|
|
3
|
+
/**
|
|
4
|
+
* `<Edit>` provides us a layout for displaying the page.
|
|
5
|
+
* It does not contain any logic but adds extra functionalities like a refresh button.
|
|
6
|
+
*
|
|
7
|
+
* @see {@link https://refine.dev/docs/ui-frameworks/antd/components/basic-views/edit} for more details.
|
|
8
|
+
*/
|
|
9
|
+
export declare const Edit: React.FC<EditProps>;
|
|
10
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/crud/edit/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAwB1B,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC;;;;;GAKG;AACH,eAAO,MAAM,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,SAAS,CA4LpC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/crud/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,cAAc,SAAS,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { ListProps } from "../types";
|
|
3
|
+
/**
|
|
4
|
+
* `<List>` provides us a layout for displaying the page.
|
|
5
|
+
* It does not contain any logic but adds extra functionalities like a refresh button.
|
|
6
|
+
*
|
|
7
|
+
* @see {@link https://refine.dev/docs/ui-frameworks/antd/components/basic-views/list} for more details.
|
|
8
|
+
*/
|
|
9
|
+
export declare const List: React.FC<ListProps>;
|
|
10
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/crud/list/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAW1B,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC;;;;;GAKG;AACH,eAAO,MAAM,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,SAAS,CAqFpC,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { ShowProps } from "../types";
|
|
3
|
+
/**
|
|
4
|
+
* `<Show>` provides us a layout for displaying the page.
|
|
5
|
+
* It does not contain any logic but adds extra functionalities like a refresh button.
|
|
6
|
+
*
|
|
7
|
+
* @see {@link https://refine.dev/docs/ui-frameworks/antd/components/basic-views/show} for more details.
|
|
8
|
+
*/
|
|
9
|
+
export declare const Show: React.FC<ShowProps>;
|
|
10
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/crud/show/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAsB1B,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC;;;;;GAKG;AACH,eAAO,MAAM,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,SAAS,CAwLpC,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
import { CardProps, SpaceProps } from "antd";
|
|
3
|
+
import { CreateButtonProps, DeleteButtonProps, SaveButtonProps } from "@components/buttons";
|
|
4
|
+
import { RefineCrudCreateProps, RefineCrudEditProps, RefineCrudListProps, RefineCrudShowProps } from "@refinedev/ui-types";
|
|
5
|
+
import { PageHeaderProps } from "../pageHeader";
|
|
6
|
+
export declare type CreateProps = RefineCrudCreateProps<SaveButtonProps, SpaceProps, SpaceProps, React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, PageHeaderProps, CardProps>;
|
|
7
|
+
export declare type EditProps = RefineCrudEditProps<SaveButtonProps, DeleteButtonProps, SpaceProps, SpaceProps, React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, PageHeaderProps, CardProps>;
|
|
8
|
+
export declare type ListProps = RefineCrudListProps<CreateButtonProps, SpaceProps, React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, PageHeaderProps, React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>>;
|
|
9
|
+
export declare type ShowProps = RefineCrudShowProps<SpaceProps, SpaceProps, React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, PageHeaderProps, CardProps>;
|
|
10
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/components/crud/types.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAC7C,OAAO,EACH,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EAClB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACH,qBAAqB,EACrB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACtB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD,oBAAY,WAAW,GAAG,qBAAqB,CAC3C,eAAe,EACf,UAAU,EACV,UAAU,EACV,KAAK,CAAC,iBAAiB,CACnB,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,EACpC,cAAc,CACjB,EACD,eAAe,EACf,SAAS,CACZ,CAAC;AAEF,oBAAY,SAAS,GAAG,mBAAmB,CACvC,eAAe,EACf,iBAAiB,EACjB,UAAU,EACV,UAAU,EACV,KAAK,CAAC,iBAAiB,CACnB,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,EACpC,cAAc,CACjB,EACD,eAAe,EACf,SAAS,CACZ,CAAC;AAEF,oBAAY,SAAS,GAAG,mBAAmB,CACvC,iBAAiB,EACjB,UAAU,EACV,KAAK,CAAC,iBAAiB,CACnB,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,EACpC,cAAc,CACjB,EACD,eAAe,EACf,KAAK,CAAC,iBAAiB,CACnB,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,EACpC,cAAc,CACjB,CACJ,CAAC;AAEF,oBAAY,SAAS,GAAG,mBAAmB,CACvC,UAAU,EACV,UAAU,EACV,KAAK,CAAC,iBAAiB,CACnB,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,EACpC,cAAc,CACjB,EACD,eAAe,EACf,SAAS,CACZ,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import { BooleanFieldProps } from "../types";
|
|
3
|
+
/**
|
|
4
|
+
* This field is used to display boolean values. It uses the {@link https://ant.design/components/tooltip/#header `<Tooltip>`} values from Ant Design.
|
|
5
|
+
*
|
|
6
|
+
* @see {@link https://refine.dev/docs/ui-frameworks/antd/components/fields/boolean} for more details.
|
|
7
|
+
*/
|
|
8
|
+
export declare const BooleanField: React.FC<BooleanFieldProps>;
|
|
9
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/fields/boolean/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAK1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C;;;;GAIG;AACH,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAapD,CAAC"}
|