@component-controls/editors
v4.0.3
Published
Component controls editors for component control values.
Downloads
140
Readme
Table of contents
Overview
Some of the guiding design goals for this library:
- Extensible using
addPropertyEditor
, so you can replace or add new editors. - All editors offer a consistent interface through the
getPropertyEditor
factory.
List of components
addPropertyEditor
react function
defined in @component-controls/editors/core/specification/src/prop-factory.ts
parameters
| Name | Type | Description |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| type*
| ControlTypes
.TEXT
, ControlTypes
.NUMBER
, ControlTypes
.BOOLEAN
, ControlTypes
.OPTIONS
, ControlTypes
.DATE
, ControlTypes
.COLOR
, ControlTypes
.BUTTON
, ControlTypes
.OBJECT
, ControlTypes
.ARRAY
, ControlTypes
.FILES
| Control field types examples are provided for the different types: |
| editor*
| PropertyEditor
<>propTypes
: WeakValidationMap
<> | undefined
contextTypes
: ValidationMap
<> | undefined
defaultProps
: Partial
<P
> | undefined
displayName
: string
| undefined
| : a Property Editor class. |