docs(ui): Add SchemaForm doc

This commit is contained in:
robin 2022-11-10 17:55:20 +08:00
parent 399d695b83
commit 3fb4167870
1 changed files with 73 additions and 0 deletions

View File

@ -0,0 +1,73 @@
# SchemaForm User Guide
## Introduction
SchemaForm is a component that can be used to render a form based on a JSON schema.
## Usage
### Basic Usage
```jsx
import React from 'react';
import { SchemaForm, initFormData, JSONSchema, UISchema } from '@/components';
const schema: JSONSchema = {
type: 'object',
properties: {
name: {
type: 'string',
title: 'Name',
},
age: {
type: 'number',
title: 'Age',
},
sex:{
type: 'boolean',
title: 'sex',
enum: [1, 2]
enumNames: ['male', 'female'],
}
},
};
const uiSchema: UISchema = {
name: {
'ui:widget': 'input',
},
age: {
'ui:widget': 'input',
'ui:options': {
type: 'number'
}
},
sex: {
'ui:widget': 'radio',
}
};
// form component
const Form = () => {
const [formData, setFormData] = useState(initFormData(schema));
return (
<SchemaForm
schema={schema}
uiSchema={uiSchema}
formData={formData}
onChange={console.log}
/>
);
};
```
## Props
| Property | Description | Type | Default |
| -------- | ---------------------------------------- | ---------------------------- | ------- |
| schema | JSON schema | [JSONSchema]() | - |
| uiSchema | UI schema | [UISchema]() | - |
| formData | Form data | [FormData]() | - |
| onChange | Callback function when form data changes | (data: [FormData]()) => void | - |
| onSubmit | Callback function when form is submitted | (data: [FormData]()) => void | - |