Interface IOnePublicProps<Data, Payload, Field>

Represents the interface for the public properties of the class IOnePublicProps.

interface IOnePublicProps<
    Data = IAnything,
    Payload = IAnything,
    Field = IField<Data>,
> {
    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;
    data?: null | Data;
    dirty?: boolean;
    disabled?: boolean;
    fallback?: (e: Error) => void;
    features?:
        | string[]
        | Record<string, Value>
        | () => string[] | Record<string, Value>;
    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;
    onBlur?: (
        name: string,
        data: Data,
        payload: Payload,
        onValueChange: (value: Value) => void,
        onChange: (data: Data) => void,
    ) => void;
    onChange?: (Data: Data, initial: boolean) => void;
    onClick?: (
        name: string,
        data: Data,
        payload: Payload,
        onValueChange: (value: Value) => void,
        onChange: (data: Data) => void,
        e: MouseEvent,
    ) => void | Promise<void>;
    onFocus?: (
        name: string,
        data: Data,
        payload: Payload,
        onValueChange: (value: Value) => void,
        onChange: (data: Data) => void,
    ) => void;
    onInvalid?: (name: string, msg: string, payload: Payload) => void;
    onLoadEnd?: (isOk: boolean, source: string) => void;
    onLoadStart?: (source: string) => void;
    onMenu?: (
        name: string,
        action: string,
        data: Data,
        payload: Payload,
        onValueChange: (value: Value) => void,
        onChange: (data: Data) => void,
    ) => void;
    onReady?: () => void;
    outgoingTransform?: (data: any, payload: Payload) => Data;
    outlinePaper?: boolean;
    payload?: Payload | () => Payload;
    prefix?: string;
    readonly?: boolean;
    readTransform?: (
        value: string | string[],
        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: string | string[],
        name: string,
        data: Data,
        payload: Payload,
    ) => Value;
}

Type Parameters

Hierarchy

  • Omit<
        IOneProps<Data, Payload, Field>,
        keyof { features: never; readTransform: never; writeTransform: never },
    >
    • IOnePublicProps

Properties

apiRef? baseline? blur? change? changeSubject? className? click? context? createField? createLayout? data? dirty? disabled? fallback? features? fieldDebounce? fields focus? handler? incomingTransform? invalidity? isBaseline? isBaselineForRoot? loadEnd? loadStart? menu? noBaseline? onBlur? onChange? onClick? onFocus? onInvalid? onLoadEnd? onLoadStart? onMenu? onReady? 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

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

Optionaldata

data?: null | Data

Represents an alternative way to provide data into component except handler. The casual way more native to React developers

Optionaldirty

dirty?: boolean

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

Optionaldisabled

disabled?: boolean

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

Optionalfallback

fallback?: (e: Error) => void

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

Optionalfeatures

features?:
    | string[]
    | Record<string, Value>
    | () => string[] | Record<string, Value>

Represents the features of a variable.

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

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

OptionalonBlur

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

Called when the blur event is triggered on the component.

Type declaration

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

    • Parameters

      • name: string
      • data: Data

        The data related to the component.

      • payload: Payload

        The payload associated with the blur event.

      • onValueChange: (value: Value) => void
      • onChange: (data: Data) => void

      Returns void

OptionalonChange

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

The onChange function is an optional property of the IOneProps interface. It represents the callback function that is invoked when a change event occurs.

Type declaration

    • (Data: Data, initial: boolean): void

    • Parameters

      • Data: Data
      • initial: boolean

      Returns void

OptionalonClick

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

Represents a callback function that gets triggered when an onClick event occurs.

Type declaration

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

    • Parameters

      • name: string
      • data: Data

        The data associated with the component.

      • payload: Payload

        The payload passed to the function.

      • onValueChange: (value: Value) => void
      • onChange: (data: Data) => void
      • e: MouseEvent

      Returns void | Promise<void>

OptionalonFocus

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

Represents an optional onFocus event handler.

Type declaration

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

    • Parameters

      • name: string
      • data: Data

        The current data of the component.

      • payload: Payload

        The event payload.

      • onValueChange: (value: Value) => void
      • onChange: (data: Data) => void

      Returns void

      • This function does not return any value.

OptionalonInvalid

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

Represents the onInvalid callback function, an optional property of the IOneProps interface. This function is executed when the invalidity condition is met.

Type declaration

    • (name: string, msg: string, payload: Payload): void

    • Parameters

      • name: string
      • msg: string
      • payload: Payload

      Returns void

      void

OptionalonLoadEnd

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

Represents the optional onLoadEnd property of the IOneProps interface.

This property defines a callback function that is invoked when the loading of data ends.

Type declaration

    • (isOk: boolean, source: string): void

    • Parameters

      • isOk: boolean
      • source: string

      Returns void

OptionalonLoadStart

onLoadStart?: (source: string) => void

Represents the onLoadStart event handler of a component.

Type declaration

    • (source: string): void

    • Parameters

      • source: string

      Returns void

OptionalonMenu

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

Represents the optional 'onMenu' property of type IOneProps<Data, Payload, Field>['menu']. This property is used to define the event handler function when a menu action is triggered. The event handler will receive three arguments: data, payload, and field.

Type declaration

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

    • Parameters

      • name: string
      • action: string
      • data: Data

        The data associated with the menu.

      • payload: Payload

        The payload associated with the menu.

      • onValueChange: (value: Value) => void
      • onChange: (data: Data) => void

      Returns void

OptionalonReady

onReady?: () => void

Represents the onReady property of IOneProps.

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: string | string[],
    name: string,
    data: Data,
    payload: Payload,
) => Value

Represents the field value transform factory

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: string | string[],
    name: string,
    data: Data,
    payload: Payload,
) => Value

Settings

Member Visibility

On This Page

Properties