From 14b4ccdf5c4aa886837189a152268fc8e5ab2a89 Mon Sep 17 00:00:00 2001 From: Nate Wang Date: Sat, 16 Mar 2024 11:27:00 +0800 Subject: [PATCH] Add API reference link. --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cb97cf9..6e389e5 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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. @@ -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: ``