react-component · xrkffgg · Nov 18, 2020 · Nov 18, 2020 · Nov 18, 2020 · xrkffgg
diff --git a/.umirc.ts b/.umirc.ts
@@ -1,13 +1,11 @@
+// more config: https://d.umijs.org/config
 import { defineConfig } from 'dumi';
 
 export default defineConfig({
   title: 'rc-field-form',
   favicon:
-    'https://user-images.githubusercontent.com/9554297/83762004-a0761b00-a6a9-11ea-83b4-9c8ff721d4b8.png',
+    'https://avatars0.githubusercontent.com/u/9441414?s=200&v=4',
   logo:
-    'https://user-images.githubusercontent.com/9554297/83762004-a0761b00-a6a9-11ea-83b4-9c8ff721d4b8.png',
-  outputPath: '.doc',
-  exportStatic: {},
-  // mode: 'site',
-  // more config: https://d.umijs.org/config
+    'https://avatars0.githubusercontent.com/u/9441414?s=200&v=4',
+  outputPath: '.doc'
 });
diff --git a/docs/StateForm-list-draggable.md b/docs/StateForm-list-draggable.md
diff --git a/docs/basic.md b/docs/basic.md
diff --git a/docs/component.md b/docs/component.md
diff --git a/docs/context.md b/docs/context.md
diff --git a/docs/demo/basic.md b/docs/demo/basic.md
@@ -0,0 +1,4 @@
+## basic
+
+
+<code src="../examples/basic.tsx" />
diff --git a/docs/demo/component.md b/docs/demo/component.md
@@ -0,0 +1,3 @@
+## component
+
+<code src="../examples/component.tsx" />
diff --git a/docs/demo/context.md b/docs/demo/context.md
@@ -0,0 +1,3 @@
+## context
+
+<code src="../examples/context.tsx" />
diff --git a/docs/demo/layout.md b/docs/demo/layout.md
@@ -0,0 +1,3 @@
+## layout
+
+<code src="../examples/layout.tsx" />
diff --git a/docs/demo/list.md b/docs/demo/list.md
@@ -0,0 +1,3 @@
+## list
+
+<code src="../examples/list.tsx" />
diff --git a/docs/demo/redux.md b/docs/demo/redux.md
@@ -0,0 +1,3 @@
+## redux
+
+<code src="../examples/redux.tsx" />
diff --git a/docs/demo/renderProps.md b/docs/demo/renderProps.md
@@ -0,0 +1,3 @@
+## renderProps
+
+<code src="../examples/renderProps.tsx" />
diff --git a/docs/demo/reset.md b/docs/demo/reset.md
@@ -0,0 +1,3 @@
+## reset
+
+<code src="../examples/reset.tsx" />
diff --git a/docs/demo/stateForm-list-draggable.md b/docs/demo/stateForm-list-draggable.md
@@ -0,0 +1,3 @@
+## stateForm-list-draggable
+
+<code src="../examples/StateForm-list-draggable.tsx" />
diff --git a/docs/demo/useForm.md b/docs/demo/useForm.md
@@ -0,0 +1,3 @@
+## useForm
+
+<code src="../examples/useForm.tsx" />
diff --git a/docs/demo/validate-perf.md b/docs/demo/validate-perf.md
@@ -0,0 +1,3 @@
+## validate-perf
+
+<code src="../examples/validate-perf.tsx" />
diff --git a/docs/demo/validate.md b/docs/demo/validate.md
@@ -0,0 +1,3 @@
+## validate
+
+<code src="../examples/validate.tsx" />
diff --git a/docs/examples/test.mdx b/docs/examples/test.mdx
diff --git a/docs/index.md b/docs/index.md
@@ -1,11 +1,8 @@
-## rc-field-form
+# rc-field-form
 
 React Performance First Form Component.
 
-[![NPM version][npm-image]][npm-url]
-[![build status][github-actions-image]][github-actions-url]
-[![Codecov][codecov-image]][codecov-url]
-[![npm download][download-image]][download-url]
+[![NPM version][npm-image]][npm-url] [![build status][github-actions-image]][github-actions-url] [![Codecov][codecov-image]][codecov-url] [![npm download][download-image]][download-url]
 
 [npm-image]: http://img.shields.io/npm/v/rc-field-form.svg?style=flat-square
 [npm-url]: http://npmjs.org/package/rc-field-form
@@ -21,7 +18,7 @@ React Performance First Form Component.
 ```bash
 npm install
 npm start
-open http://localhost:8000/
+open http://localhost:8000
 ```
 
 ## Feature
@@ -56,11 +53,11 @@ import Form, { Field } from 'rc-field-form';
 export default Demo;
 ```
 
-# API
+## 🔥 API
 
 We use typescript to create the Type definition. You can view directly in IDE. But you can still check the type definition [here](https://github.com/react-component/field-form/blob/master/src/interface.ts).
 
-## Form
+### Form
 
 | Prop             | Description                                        | Type                                         | Default          |
 | ---------------- | -------------------------------------------------- | -------------------------------------------- | ---------------- |
@@ -76,7 +73,7 @@ We use typescript to create the Type definition. You can view directly in IDE. B
 | onFinishFailed   | Trigger when form submit and failed                | ({ values, errorFields, outOfDate }) => void | -                |
 | onValuesChange   | Trigger when any value of Field changed            | (changedValues, values) => void              | -                |
 
-## Field
+### Field
 
 | Prop              | Description                                                                   | Type                                        | Default  |
 | ----------------- | ----------------------------------------------------------------------------- | ------------------------------------------- | -------- |
@@ -93,14 +90,14 @@ We use typescript to create the Type definition. You can view directly in IDE. B
 | validateTrigger   | Config trigger point with rule validate                                       | string \| string[]                          | onChange |
 | valuePropName     | Config value mapping prop with element                                        | string                                      | value    |
 
-## List
+### List
 
 | Prop     | Description                     | Type                                                                                                    | Default |
 | -------- | ------------------------------- | ------------------------------------------------------------------------------------------------------- | ------- |
 | name     | List field name path            | [NamePath](#namepath)[]                                                                                 | -       |
 | children | Render props for listing fields | (fields: { name: [NamePath](#namepath) }[], operations: [ListOperations](#listoperations)) => ReactNode | -       |
 
-## useForm
+### useForm
 
 Form component default create an form instance by `Form.useForm`. But you can create it and pass to Form also. This allow you to call some function on the form instance.
 
@@ -140,15 +137,15 @@ class Demo extends React.Component {
 | submit            | Trigger form submit                        | () => void                                                                 |
 | validateFields    | Trigger fields to validate                 | (nameList?: [NamePath](#namepath)[], options?: ValidateOptions) => Promise |
 
-## FormProvider
+### FormProvider
 
 | Prop             | Description                               | Type                                     | Default |
 | ---------------- | ----------------------------------------- | ---------------------------------------- | ------- |
 | validateMessages | Config global `validateMessages` template | [ValidateMessages](#validatemessages)    | -       |
 | onFormChange     | Trigger by named form fields change       | (name, { changedFields, forms }) => void | -       |
 | onFormFinish     | Trigger by named form fields finish       | (name, { values, forms }) => void        | -       |
 
-## Interface
+## 📋 Interface
 
 ### NamePath
 
@@ -208,27 +205,27 @@ Validate Messages provides a list of error template. You can ref [here](https://
 | pattern | Rule `pattern` prop |
 | type    | Rule `type` prop    |
 
-# Different with `rc-form`
+## Different with `rc-form`
 
 `rc-field-form` is try to keep sync with `rc-form` in api level, but there still have something to change:
 
-## 🔥 Field will not keep snyc with `initialValues` when un-touched
+### 1. Field will not keep snyc with `initialValues` when un-touched
 
 In `rc-form`, field value will get from `initialValues` if user not operate on it.
 It's a bug but user use as a feature which makes fixing will be a breaking change and we have to keep it.
 In Field Form, this bug will not exist anymore. If you want to change a field value, use `setFieldsValue` instead.
 
-## 🔥 Remove Field will not clean up related value
+### 2. Remove Field will not clean up related value
 
 We do lots of logic to clean up the value when Field removed before. But with user feedback, remove exist value increase the additional work to keep value back with conditional field.
 
-## 🔥 Nest name use array instead of string
+### 3. Nest name use array instead of string
 
 In `rc-form`, we support like `user.name` to be a name and convert value to `{ user: { name: 'Bamboo' } }`. This makes '.' always be the route of variable, this makes developer have to do additional work if name is real contains a point like `app.config.start` to be `app_config_start` and parse back to point when submit.
 
 Field Form will only trade `['user', 'name']` to be `{ user: { name: 'Bamboo' } }`, and `user.name` to be `{ ['user.name']: 'Bamboo' }`.
 
-## 🔥 Remove `validateFieldsAndScroll`
+### 4. Remove `validateFieldsAndScroll`
 
 Since `findDomNode` is marked as warning in [StrictMode](https://reactjs.org/docs/strict-mode.html#warning-about-deprecated-finddomnode-usage). It seems over control of Form component.
 We decide to remove `validateFieldsAndScroll` method and you should handle it with you own logic:
@@ -241,7 +238,7 @@ We decide to remove `validateFieldsAndScroll` method and you should handle it wi
 </Form>
 ```
 
-## 🔥 `getFieldsError` always return array
+### 5. `getFieldsError` always return array
 
 `rc-form` returns `null` when no error happen. This makes user have to do some additional code like:
 
@@ -253,7 +250,7 @@ We decide to remove `validateFieldsAndScroll` method and you should handle it wi
 
 Now `getFieldsError` will return `[]` if no errors.
 
-## 🔥 Remove `callback` with `validateFields`
+### 6. Remove `callback` with `validateFields`
 
 Since ES8 is support `async/await`, that's no reason not to use it. Now you can easily handle your validate logic:
 
@@ -272,11 +269,11 @@ async function() {
 
 **Notice: Now if your validator return an `Error(message)`, not need to get error by `e => e.message`. FieldForm will handle this.**
 
-## 🔥 `preserve` is default to false
+### 7. `preserve` is default to false
 
 In `rc-form` you should use `preserve` to keep a value cause Form will auto remove a value from Field removed. Field Form will always keep the value in the Form whatever Field removed. But you can still use `preserve=false` to disable value keeping since `1.5.0`.
 
-## 🔥 `setFields` not trigger `onFieldsChange` and `setFieldsValue` not trigger `onValuesChange`
+### 8. `setFields` not trigger `onFieldsChange` and `setFieldsValue` not trigger `onValuesChange`
 
 In `rc-form`, we hope to help user auto trigger change event by setting to make redux dispatch easier, but it's not good design since it makes code logic couping.
 

diff --git a/docs/layout.md b/docs/layout.md
diff --git a/docs/list.md b/docs/list.md
diff --git a/docs/redux.md b/docs/redux.md
diff --git a/docs/renderProps.md b/docs/renderProps.md
diff --git a/docs/reset.md b/docs/reset.md
diff --git a/docs/useForm.md b/docs/useForm.md
diff --git a/docs/validate-perf.md b/docs/validate-perf.md
diff --git a/docs/validate.md b/docs/validate.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## component

		<code src="../examples/component.tsx" />
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## context

		<code src="../examples/context.tsx" />
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## layout

		<code src="../examples/layout.tsx" />
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## renderProps

		<code src="../examples/renderProps.tsx" />
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## stateForm-list-draggable

		<code src="../examples/StateForm-list-draggable.tsx" />
Copy link Member Author xrkffgg Nov 18, 2020 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. 奇了怪了，把 example 里的改成了小写，竟然 diff 检测不到
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## useForm

		<code src="../examples/useForm.tsx" />
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## validate-perf

		<code src="../examples/validate-perf.tsx" />
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## validate

		<code src="../examples/validate.tsx" />