Class: ComponentStore

Component settings for serialization in JSON.

Constructors

Constructor

new ComponentStore(key, type): ComponentStore

Creates the component settings.

Parameters

key

string

the React component key.

type

string

the component type of the form viewer.

Returns

ComponentStore

Properties

children?

optional children?: ComponentStore[]

The array of child components.

---

css?

optional css?: Css

The component CSS styles.

---

dataKey?

optional dataKey?: string

The component data key.

---

disableDataBinding?

optional disableDataBinding?: ComponentProperty<boolean>

Disables data binding for the component.

---

events?

optional events?: Record<string, ActionData[]>

The set of event handlers.

---

htmlAttributes?

optional htmlAttributes?: HtmlAttribute[]

The set of arbitrary HTML attributes added to the component.

---

key

key: string = ''

The React component key.

---

modal?

optional modal?: ModalComponentStore

The modal settings.

---

props

props: Record<string, ComponentProperty> = {}

The component properties.

---

renderWhen?

optional renderWhen?: ComponentProperty<any>

The expression or function to conditionally render a component.

---

schema?

optional schema?: BoundValueSchema

The component value validation settings.

---

slot?

optional slot?: string

The name of the occupied component property in the parent component.

---

slotCondition?

optional slotCondition?: string

The condition for binding a child element to a parent element.

---

style?

optional style?: ComponentStyle

The component styles for the style attribute.

---

tooltipProps?

optional tooltipProps?: Record<string, ComponentProperty<any>>

The tooltip settings.

---

type

type: string = ''

The component type of the form viewer.

---

wrapperCss?

optional wrapperCss?: Css

The component wrapper CSS styles.

---

wrapperStyle?

optional wrapperStyle?: ComponentStyle

The component wrapper styles for the style attribute.

Methods

addEventHandler()

static addEventHandler(store, eventName, data): void

Adds the event handler for component.

Parameters

store

ComponentStore

the target ComponentStore.

eventName

string

the target event name.

data

ActionData

the ActionData.

Returns

void

---

addValidationRule()

static addValidationRule(store, key, type?): void

Adds a validation rule to the component.

Parameters

store

ComponentStore

the component settings.

key

string

the validation key.

type?

ValidatorType = 'internal'

the validation type.

Returns

void

---

clone()

static clone(store): ComponentStore

Returns a clone of the specified component settings.

Parameters

store

ComponentStore

the component settings.

Returns

ComponentStore

the clone of the specified component settings.

---

createFromObject()

static createFromObject(value): ComponentStore

Correctly creates the ComponentStore from deserialized data. Recursively materializes the tree so constructor defaults (for example props) apply to every node. JSON form children are often {key, type} without props; wrapping only the root would leave those as plain objects.

Parameters

value

any

the deserialized data.

Returns

ComponentStore

the component Store.

---

hasValidationRule()

static hasValidationRule(store, key): boolean | undefined

Returns true if the component has a validation rule.

Parameters

store

ComponentStore

the component settings.

key

string

the validation key.

Returns

boolean | undefined

true if the component has a validation rule, otherwise false.

---

removeValidationRule()

static removeValidationRule(store, key): void

Removes a validation rule from the component.

Parameters

store

ComponentStore

the component settings.

key

string

the validation key.

Returns

void