Class SelectiveEditor

Selective structured data editor.

Exports for using selective in other projects.

Hierarchy

__type<typeof Base, this> & Base<this>
- SelectiveEditor

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new SelectiveEditor(config: EditorConfig, container?: HTMLElement): SelectiveEditor

Overrides DataMixin(Base).constructor
- Defined in selective/editor.ts:70
Parameters
- config: EditorConfig
- Optional container: HTMLElement
Returns SelectiveEditor

Properties

Optional _data

_data?: DeepObject

config

config: EditorConfig

Optional container

container?: HTMLElement

fields

fields: FieldsComponent

isPendingRender

isPendingRender: boolean

isRendering

isRendering: boolean

Optional markValidation

markValidation?: boolean

Controls when the validation should be checked across all the fields in the editor.

Note: Render cycle needs to complete before the validation can be trusted.

types

types: Types

Accessors

data

get data(): undefined | DeepObject
set data(data: undefined | DeepObject | Record<string, any>): void

Inherited from DataMixin(Base).data
- Defined in mixins/data.ts:9
Returns undefined | DeepObject
Inherited from DataMixin(Base).data
- Defined in mixins/data.ts:13
Parameters
- data: undefined | DeepObject | Record<string, any>
Returns void

isClean

get isClean(): boolean

- Defined in selective/editor.ts:134
Returns boolean

isValid

get isValid(): boolean

- Defined in selective/editor.ts:138
Returns boolean

value

get value(): any

- Defined in selective/editor.ts:189
Returns any

Methods

addFieldType

addFieldType(key: string, FieldCls: FieldConstructor): void

- Defined in selective/editor.ts:102
Parameters
- key: string
- FieldCls: FieldConstructor
Returns void

addFieldTypes

addFieldTypes(fieldTypes: Record<string, FieldConstructor>): void

- Defined in selective/editor.ts:107
Parameters
- fieldTypes: Record<string, FieldConstructor>
Returns void

addRuleType

addRuleType(key: string, RuleCls: RuleConstructor): void

- Defined in selective/editor.ts:112
Parameters
- key: string
- RuleCls: RuleConstructor
Returns void

addRuleTypes

addRuleTypes(ruleTypes: Record<string, RuleConstructor>): void

- Defined in selective/editor.ts:116
Parameters
- ruleTypes: Record<string, RuleConstructor>
Returns void

guessFields

guessFields(): FieldConfig[]

- Defined in selective/editor.ts:120
Returns FieldConfig[]

render

render(): void

- Defined in selective/editor.ts:148
Returns void

resetFields

resetFields(): void

- Defined in selective/editor.ts:177
Returns void

template

template(editor: SelectiveEditor, data: DeepObject): TemplateResult<ResultType>

- Defined in selective/editor.ts:142
Parameters
- editor: SelectiveEditor
- data: DeepObject
Returns TemplateResult<ResultType>

Generated using TypeDoc