Interface CombinatorRendererProps

State-based props of a Control

interface CombinatorRendererProps {
    cells?: {
        cell: any;
        tester: RankedTester;
    }[];
    config?: any;
    data: any;
    description?: string;
    enabled: boolean;
    errors: string;
    i18nKeyPrefix?: string;
    id: string;
    indexOfFittingSchema: number;
    label: string;
    path: string;
    renderers?: JsonFormsRendererRegistryEntry[];
    required?: boolean;
    rootSchema: JsonSchema;
    schema: JsonSchema;
    uischema: ControlElement;
    uischemas: JsonFormsUISchemaRegistryEntry[];
    visible: boolean;
    handleChange(path, value): void;
}

Hierarchy (view full)

Properties

cells? config? data description? enabled errors i18nKeyPrefix? id indexOfFittingSchema label path renderers? required? rootSchema schema uischema uischemas visible

Methods

handleChange

Properties

Optional cells

cells?: {
    cell: any;
    tester: RankedTester;
}[]

All available cell renderers.

Type declaration

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.

Optional i18nKeyPrefix

i18nKeyPrefix?: string

id

id: string

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

indexOfFittingSchema

indexOfFittingSchema: number

label

label: string

The label for the rendered element.

path

path: string

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

Optional renderers

renderers?: JsonFormsRendererRegistryEntry[]

All available 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

The UI schema to be rendered.

uischemas

uischemas: JsonFormsUISchemaRegistryEntry[]

visible

visible: boolean

Whether the rendered element should be visible.

Methods

handleChange

  • handleChange(path, value): 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

Settings

Member Visibility

Theme

On This Page

cellsconfigdatadescriptionenablederrorsi18nKeyPrefixidindexOfFittingSchemalabelpathrenderersrequiredrootSchemaschemauischemauischemasvisiblehandleChange