Interface ObjectUiSchema

interface ObjectUiSchema {
    additionalProperties: false;
    const?: Record<string, PrimitiveUiValue | TupleUiValue>;
    default?: Record<string, PrimitiveUiValue | TupleUiValue>;
    description?: string;
    enum?: Record<string, PrimitiveUiValue | TupleUiValue>[];
    enumDescriptions?: string[];
    enumItemLabels?: string[];
    hidden?: boolean;
    markdownDescription?: string;
    markdownEnumDescriptions?: string[];
    order?: number;
    properties: Record<string, PrimitiveUiSchema | TupleUiSchema>;
    required?: string[];
    type: "object";
}

Hierarchy (view full)

UiSchemaBase<Record<string, PrimitiveUiValue | TupleUiValue>>
- ObjectUiSchema

Index

Properties

additionalProperties const? default? description? enum? enumDescriptions? enumItemLabels? hidden? markdownDescription? markdownEnumDescriptions? order? properties required? type

Properties

additionalProperties

additionalProperties: false

`Optional` const

const?: Record<string, PrimitiveUiValue | TupleUiValue>

`Optional` default

default?: Record<string, PrimitiveUiValue | TupleUiValue>

`Optional` description

description?: string

`Optional` enum

enum?: Record<string, PrimitiveUiValue | TupleUiValue>[]

`Optional` enumDescriptions

enumDescriptions?: string[]

`Optional` enumItemLabels

enumItemLabels?: string[]

`Optional` hidden

hidden?: boolean

`Optional` markdownDescription

markdownDescription?: string

`Optional` markdownEnumDescriptions

markdownEnumDescriptions?: string[]

`Optional` order

order?: number

properties

properties: Record<string, PrimitiveUiSchema | TupleUiSchema>

`Optional` required

required?: string[]

type

type: "object"

Generated using TypeDoc