Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ControlWithDetailProps

Hierarchy

Index

Properties

Optional cells

Optional config

config: any

Any configuration options for the element.

data

data: any

The data to be rendered.

Optional description

description: string

Description of input cell

enabled

enabled: boolean

Whether the rendered element should be enabled.

errors

errors: string

Any validation errors that are caused by the data to be rendered.

id

id: string

A unique ID that should be used for rendering the scoped UI schema element.

label

label: string | Labels

The label for the rendered element.

path

path: string

Instance path the data is written to, in case of a control.

Optional renderers

Optional required

required: boolean

Whether the rendered data is required.

rootSchema

rootSchema: JsonSchema

The root schema as returned by the store.

schema

schema: JsonSchema

The JSON schema that describes the data.

uischema

uischema: ControlElement

Optional uischemas

visible

visible: boolean

Whether the rendered element should be visible.

Methods

handleChange

  • handleChange(path: string, value: any): void
  • Update handler that emits a data change

    Parameters

    • path: string

      the path to the data to be updated

    • value: any

      the new value that should be written to the given path

    Returns void

Generated using TypeDoc