A Q&A platform software for teams at any scales. Whether it's a community forum, help center, or knowledge management platform, you can always count on Apache Answer.
docs(ui): update schema form doc
robine3bc029fd204
diff --git a/ui/src/components/SchemaForm/README.md b/ui/src/components/SchemaForm/README.mdindex 46676a8f..74fb514e 100644--- a/ui/src/components/SchemaForm/README.md+++ b/ui/src/components/SchemaForm/README.md@@ -1,19 +1,21 @@-# SchemaForm User Guide+---+sidebar_position: 0+---+# Schema Form## Introduction-SchemaForm is a component that can be used to render a form based on a [JSON schema](https://json-schema.org/understanding-json-schema/index.html).+A React component capable of building HTML forms out of a [JSON schema](https://json-schema.org/understanding-json-schema/index.html).## Usage-### Basic Usage-```tsx-import React from 'react';+import React, { useState } from 'react';+import { SchemaForm, initFormData, JSONSchema, UISchema } from '@/components';const schema: JSONSchema = {- type: 'object',+ title: 'General',properties: {name: {type: 'string',@@ -23,12 +25,12 @@ const schema: JSONSchema = {type: 'number',title: 'Age',},- sex:{- type: 'boolean',+ sex: {+ type: 'string',title: 'sex',enum: [1, 2],enumNames: ['male', 'female'],- }+ },},};@@ -39,41 +41,193 @@ const uiSchema: UISchema = {age: {'ui:widget': 'input','ui:options': {- type: 'number'- }+ type: 'number',+ },},sex: {'ui:widget': 'radio',- }+ },};-// form component-const Form = () => {const [formData, setFormData] = useState(initFormData(schema));++ const handleChange = (data) => {+ setFormData(data);+ };+return (<SchemaFormschema={schema}uiSchema={uiSchema}formData={formData}- onChange={console.log}+ onChange={handleChange}/>);};++export default Form;+```## Props-| Property | Description | Type | Default |-| -------- | ---------------------------------------- | ----------------------------------------- | ------- |-| schema | JSON schema | [JSONSchema](index.tsx#L9) | - |-| uiSchema | UI schema | [UISchema](index.tsx#L24) | - |-| formData | Form data | [FormData](index.tsx#L66) | - |-| onChange | Callback function when form data changes | (data: [FormData](index.tsx#L66)) => void | - |-| onSubmit | Callback function when form is submitted | (data: React.FormEvent) => void | - |+| Property | Description | Type | Default |+| -------- | ---------------------------------------- | ------------------------------------- | ------- |+| schema | Describe the form structure with schema | [JSONSchema](#json-schema) | - |+| uiSchema | Describe the properties of the field | [UISchema](#uischema) | - |+| formData | Describe form data | [FormData](#formdata) | - |+| onChange | Callback function when form data changes | (data: [FormData](#formdata)) => void | - |+| onSubmit | Callback function when form is submitted | (data: React.FormEvent) => void | - |++## Types Definition+### JSONSchema++```ts+export interface JSONSchema {+ title: string;+ description?: string;+ required?: string[];+ properties: {+ [key: string]: {+ type: 'string' | 'boolean' | 'number';+ title: string;+ label?: string;+ description?: string;+ enum?: Array<string | boolean | number>;+ enumNames?: string[];+ default?: string | boolean | number;+ };+ };+}+```++### UIOptions++```ts+export interface UIOptions {+ empty?: string;+ className?: string | string[];+ validator?: (+ value,+ formData?,+ ) => Promise<string | true | void> | true | string;+}+```+### InputOptions++```ts+export interface InputOptions extends UIOptions {+ placeholder?: string;+ type?:+ | 'color'+ | 'date'+ | 'datetime-local'+ | 'email'+ | 'month'+ | 'number'+ | 'password'+ | 'range'+ | 'search'+ | 'tel'+ | 'text'+ | 'time'+ | 'url'+ | 'week';+}+```+### SelectOptions++```ts+export interface SelectOptions extends UIOptions {}+```+### UploadOptions++```ts+export interface UploadOptions extends UIOptions {+ acceptType?: string;+ imageType?: 'post' | 'avatar' | 'branding';+}+```+### SwitchOptions++```ts+export interface SwitchOptions extends UIOptions {}+```+### TimezoneOptions++```ts+export interface TimezoneOptions extends UIOptions {+ placeholder?: string;+}+```+### CheckboxOptions++```ts+export interface CheckboxOptions extends UIOptions {}+```+### RadioOptions++```ts+export interface RadioOptions extends UIOptions {}+```+### TextareaOptions++```ts+export interface TextareaOptions extends UIOptions {+ placeholder?: string;+ rows?: number;+}+```+### UIWidget++```ts+export type UIWidget =+ | 'textarea'+ | 'input'+ | 'checkbox'+ | 'radio'+ | 'select'+ | 'upload'+ | 'timezone'+ | 'switch';+```++### UISchema++```ts+export interface UISchema {+ [key: string]: {+ 'ui:widget'?: UIWidget;+ 'ui:options'?:+ | InputOptions+ | SelectOptions+ | UploadOptions+ | SwitchOptions+ | TimezoneOptions+ | CheckboxOptions+ | RadioOptions+ | TextareaOptions;+ };+}+```++### FormData+```ts+export interface FormValue<T = any> {+ value: T;+ isInvalid: boolean;+ errorMsg: string;+ [prop: string]: any;+}++export interface FormDataType {+ [prop: string]: FormValue;+}+```## reference- [json schema](https://json-schema.org/understanding-json-schema/index.html)-- [react-jsonschema-form](http://rjsf-team.github.io/react-jsonschema-form/)+- [react-jsonschema-form](https://github.com/rjsf-team/react-jsonschema-form)- [vue-json-schema-form](https://github.com/lljj-x/vue-json-schema-form/)