Interface IOneProps<Data, Payload, Field>

Properties of the template engine component

interface IOneProps<
    Data = IAnything,
    Payload = IAnything,
    Field = IField<Data, Payload>,
> {
    apiRef?: any;
    baseline?: boolean;
    blur?: (
        name: string,
        data: Data,
        payload: Payload,
        onValueChange: (value: Value) => void,
        onChange: (data: Data) => void,
    ) => void;
    change?: (Data: Data, initial: boolean) => void;
    changeSubject?: TSubject<Data>;
    className?: string;
    click?: (
        name: string,
        data: Data,
        payload: Payload,
        onValueChange: (value: Value) => void,
        onChange: (data: Data) => void,
        e: MouseEvent,
    ) => void | Promise<void>;
    context?: Record<string, any>;
    createField?: (entity: IEntity<Data>, currentPath: string) => ReactElement;
    createLayout?: (
        entity: IEntity<Data>,
        children: ReactNode,
        currentPath: string,
    ) => ReactElement;
    dirty?: boolean;
    disabled?: boolean;
    fallback?: (e: Error) => void;
    features?: string[];
    fieldDebounce?: number;
    fields: Field[];
    focus?: (
        name: string,
        data: Data,
        payload: Payload,
        onValueChange: (value: Value) => void,
        onChange: (data: Data) => void,
    ) => void;
    handler?: OneHandler<Data, Payload>;
    incomingTransform?: (data: any, payload: Payload) => Data;
    invalidity?: (name: string, msg: string, payload: Payload) => void;
    isBaseline?: (field: IField) => boolean;
    isBaselineForRoot?: (field: IField) => boolean;
    loadEnd?: (isOk: boolean, source: string) => void;
    loadStart?: (source: string) => void;
    menu?: (
        name: string,
        action: string,
        data: Data,
        payload: Payload,
        onValueChange: (value: Value) => void,
        onChange: (data: Data) => void,
    ) => void;
    noBaseline?: boolean;
    outgoingTransform?: (data: any, payload: Payload) => Data;
    outlinePaper?: boolean;
    payload?: Payload | () => Payload;
    prefix?: string;
    readonly?: boolean;
    readTransform?: (
        value: Value,
        name: string,
        data: Data,
        payload: Payload,
    ) => Value;
    ready?: () => void;
    reloadSubject?: TSubject<void>;
    slots?: Partial<ISlotFactoryContext>;
    style?: any;
    sx?: any;
    transparentPaper?: boolean;
    updateSubject?: TSubject<Data>;
    withNamedPlaceholders?: boolean;
    writeTransform?: (
        value: Value,
        name: string,
        data: Data,
        payload: Payload,
    ) => Value;
}

Type Parameters

Properties

apiRef? baseline? blur? change? changeSubject? className? click? context? createField? createLayout? dirty? disabled? fallback? features? fieldDebounce? fields focus? handler? incomingTransform? invalidity? isBaseline? isBaselineForRoot? loadEnd? loadStart? menu? noBaseline? outgoingTransform? outlinePaper? payload? prefix? readonly? readTransform? ready? reloadSubject? slots? style? sx? transparentPaper? updateSubject? withNamedPlaceholders? writeTransform?

Properties

OptionalapiRef

apiRef?: any

Ссылка на объект API

Optionalbaseline

baseline?: boolean

Привязывет поля к нижнему краю

Optionalblur

blur?: (
    name: string,
    data: Data,
    payload: Payload,
    onValueChange: (value: Value) => void,
    onChange: (data: Data) => void,
) => void

Optionalchange

change?: (Data: Data, initial: boolean) => void

Вызывается после изменения и передает измененный объект прикладному программисту

OptionalchangeSubject

changeSubject?: TSubject<Data>

Эмиттер для перезаписи данных. Вызывает change(data, true)

OptionalclassName

className?: string

Класс корневой группы

Optionalclick

click?: (
    name: string,
    data: Data,
    payload: Payload,
    onValueChange: (value: Value) => void,
    onChange: (data: Data) => void,
    e: MouseEvent,
) => void | Promise<void>

Коллбек для перехвата клика по полю

Optionalcontext

context?: Record<string, any>

Контекст кастомных полей, в отличие от payload доступен к change detection

OptionalcreateField

createField?: (entity: IEntity<Data>, currentPath: string) => ReactElement

Фабрика для создания полей пользователя

OptionalcreateLayout

createLayout?: (
    entity: IEntity<Data>,
    children: ReactNode,
    currentPath: string,
) => ReactElement

Фабрика для создания компоновок пользователя

Optionaldirty

dirty?: boolean

Если флаг включен, показываем валидацию до фокусировки по полю

Optionaldisabled

disabled?: boolean

Отключает поля ввода

Optionalfallback

fallback?: (e: Error) => void

Вызывается при ошибке в handler

Optionalfeatures

features?: string[]

Список бизнес-функций, ограничивающий отображение полей

OptionalfieldDebounce

fieldDebounce?: number

Debounce для FieldType.Text

fields

fields: Field[]

Массив полей, выводимый в компоненте

Optionalfocus

focus?: (
    name: string,
    data: Data,
    payload: Payload,
    onValueChange: (value: Value) => void,
    onChange: (data: Data) => void,
) => void

Вызываются при фокусировки по филду в компоненте и потере фокуса

Optionalhandler

handler?: OneHandler<Data, Payload>

Позволяет загружать данные в компонент

OptionalincomingTransform

incomingTransform?: (data: any, payload: Payload) => Data

Методы для преобразования целевого объекта, например сериализации/десереализации, чтобы хранить в data страницы строку, синхронизируемую через AJAX

Optionalinvalidity

invalidity?: (name: string, msg: string, payload: Payload) => void

Коллбек, вызываемый при не прохождении валидации

OptionalisBaseline

isBaseline?: (field: IField) => boolean

Функция, определяющая, нужно ли включить baseline зависимо от расположения поля в иерархии композиции потомков

OptionalisBaselineForRoot

isBaselineForRoot?: (field: IField) => boolean

Корневой компонент привязывает поля к нижнему краю только если нет ни одной компоновки

OptionalloadEnd

loadEnd?: (isOk: boolean, source: string) => void

OptionalloadStart

loadStart?: (source: string) => void

Коллбеки управления отображением состоянием загрузки

Optionalmenu

menu?: (
    name: string,
    action: string,
    data: Data,
    payload: Payload,
    onValueChange: (value: Value) => void,
    onChange: (data: Data) => void,
) => void

Коллбек для управления контекстным меню

OptionalnoBaseline

noBaseline?: boolean

Привязывает поля и компоновки к верхнему краю

OptionaloutgoingTransform

outgoingTransform?: (data: any, payload: Payload) => Data

OptionaloutlinePaper

outlinePaper?: boolean

Превращает FieldType.Paper в FieldType.Outline

Optionalpayload

payload?: Payload | () => Payload

Объект, передающийся в пользовательские поля через контекст

Optionalprefix

prefix?: string

Префикс для формирования ключей элементов

Optionalreadonly

readonly?: boolean

Блокирует ввод данных

OptionalreadTransform

readTransform?: (
    value: Value,
    name: string,
    data: Data,
    payload: Payload,
) => Value

crypt/decrypt значения, получаемого в makeField из управляемого объекта

Optionalready

ready?: () => void

Вызывается, когда все поля успели отрисоваться в первый раз, после появления формы

OptionalreloadSubject

reloadSubject?: TSubject<void>

Эмиттер для запроса данных

Optionalslots

slots?: Partial<ISlotFactoryContext>

Слоты для полей ввода

Optionalstyle

style?: any

Стиль корневой группы

Optionalsx

sx?: any

SX для корневой группы

OptionaltransparentPaper

transparentPaper?: boolean

OptionalupdateSubject

updateSubject?: TSubject<Data>

Эмиттер для изменения данных. Вызывает change(data, false)

OptionalwithNamedPlaceholders

withNamedPlaceholders?: boolean

Генерирует плейсхолдеры согласно схеме полей целевого объекта

OptionalwriteTransform

writeTransform?: (
    value: Value,
    name: string,
    data: Data,
    payload: Payload,
) => Value

Settings

Member Visibility

On This Page

Properties