Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TreeWithDetailProps

Hierarchy

Index

Properties

addToRoot

addToRoot: any

Optional classes

classes: any

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 field

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 fields

fields: object[]

filterPredicate

filterPredicate: any

id

id: string

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

imageProvider

imageProvider: any

label

label: string | Labels

The label for the rendered element.

labelProviders

labelProviders: object

Type declaration

path

path: string

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

Optional required

required: boolean

Whether the rendered data is required.

rootData

rootData: any

rootSchema

rootSchema: JsonSchema

The root schema as returned by the store.

schema

schema: JsonSchema

The JSON schema that describes the data.

uischema

uischema: ControlElement

visible

visible: boolean

Whether the rendered element should be visible.

Methods

findUISchema

  • findUISchema(schema: JsonSchema, schemaPath: string, path: string, fallbackLayoutType?: string, control?: ControlElement): UISchemaElement
  • Finds a registered UI schema to use, if any.

    Parameters

    • schema: JsonSchema

      the JSON schema describing the data to be rendered

    • schemaPath: string

      the according schema path

    • path: string

      the instance path

    • Optional fallbackLayoutType: string

      the type of the layout to use

    • Optional control: ControlElement

      may be checked for embedded inline uischema options

    Returns UISchemaElement

Generated using TypeDoc