Skip to content

Commit

Permalink
Add API reference link.
Browse files Browse the repository at this point in the history
  • Loading branch information
supnate committed Mar 16, 2024
1 parent 03fc0b2 commit 14b4ccd
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ While there're already some form libraries/frameworks focus on state management

It is a small utility with zero dependencies and can be seamlessly integrated with any React UI library or form state manager and comes with built-in support for native HTML, [antd.design](https://ant.design), and [Formik](https://formik.org) + [MUI](https://mui.com).


Before read through the detailed introduction below, we suggest you first go through our examples page so that you get a quick glance at the scenarios NiceForm is used for and how API looks like:

- [MUI + Formik Examples](https://opensource.ebay.com/nice-form-react/formik)
Expand Down Expand Up @@ -279,8 +280,6 @@ const meta = {
Also, see the live example [here](https://opensource.ebay.com/nice-form-react/antd/#field-condition).
## View Mode and Edit Mode
NiceForm provides two modes for form: edit mode and view mode. So you usually can render two modes of a form with a single meta object. For each field, you can define how a field is rendered under edit mode or view mode.
Expand All @@ -289,6 +288,8 @@ The mode could be form level or field level. To understand how it works, just se
## API Reference
> You can see the full API reference [here](https://opensource.ebay.com/nice-form-react/docs/api/).
To create a form with Nice Form, you usually use below APIs:
- NiceForm component: a holder component to render form by meta. Always: `<NiceForm meta={meta} />`
Expand Down

0 comments on commit 14b4ccd

Please sign in to comment.