Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
janryWang authored Dec 26, 2019
1 parent 127a0b3 commit 9c513d0
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions packages/react-schema-renderer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ npm install --save @uform/react-schema-renderer
- [`<InternalForm/>`](#InternalForm)
- [`<InternalField/>`](#InternalField)
- [Interfaces](#interfaces)
- [IConnectOptions](#iconnectoptions)
- [ISchemaFieldComponentProps](#ischemafieldcomponentprops)
- [ISchemaVirtualFieldComponentProps](#ischemavirtualfieldcomponentprops)
- [ISchemaFormRegistry](#ischemaformregistry)
Expand Down Expand Up @@ -1566,6 +1567,30 @@ type IMarkupSchemaFieldProps = ISchema
> Inheriting @uform/react and @uform/core's Interfaces as a whole, only @uform/react-schema-renderer are listed below.
#### IConnectOptions
> Connect parameters for registered components
```typescript
interface IConnectOptions {
valueName?: string //value name
eventName?: string //get value callback name
defaultProps?: {} //component default props
getValueFromEvent?: (event?: any, value?: any) => any //get value from event callback.
getProps?: ( //props transformer
componentProps: {},
fieldProps: MergedFieldComponentProps
) => {} | void
getComponent?: ( //component transformer
Target: any,
componentProps: {},
fieldProps: MergedFieldComponentProps
) => React.JSXElementConstructor<any>
}

```
#### ISchemaFieldComponentProps
> It is very important to customize the properties received by the component. As long as it involves developing custom components, you need to understand the protocol.
Expand Down

0 comments on commit 9c513d0

Please sign in to comment.