Interface IDictSlot

Represents an interface for a dictionary slot.

interface IDictSlot {
    description?: string;
    dictCreateButton?: any;
    dictDelay?: number;
    dictLimit?: number;
    dictOnAppend?: (
        search: string,
        data: any,
        payload: any,
        onValueChange: (value: null | string) => void,
        onChange: (value: any) => void,
    ) => void;
    dictOnItem?: (
        value: null | string,
        data: any,
        payload: any,
        onValueChange: (value: null | string) => void,
        onChange: (data: any) => void,
    ) => void;
    dictOnText?: (
        text: string,
        data: any,
        payload: any,
        onValueChange: (value: null | string) => void,
        onChange: (data: any) => void,
    ) => void;
    dictSearch?: (
        dto: {
            data: any;
            initial: boolean;
            limit: number;
            offset: number;
            payload: any;
            rows: ISearchItem<any>[];
            search: string;
        },
    ) => ISearchItem<any>[]
    | Promise<ISearchItem<any>[]>;
    dictSearchItem?: any;
    dictSearchText?: (data: any, payload: any) => string | Promise<string>;
    dictValue?: (
        value: string,
        data: any,
        payload: any,
    ) => ISearchItem<any> | Promise<ISearchItem<any>>;
    dirty: boolean;
    disabled: boolean;
    groupRef?: (element?: null | HTMLDivElement) => void;
    incorrect: null | string;
    inputAutocomplete?: "new-password" | "on" | "off" | "false";
    inputFormatter?: (input: string) => string;
    inputFormatterAllowed?: RegExp | (char: string, idx: number) => boolean;
    inputFormatterReplace?: (char: string) => null | string;
    inputFormatterSymbol?: string;
    inputFormatterTemplate?: string;
    inputMode?:
        | "search"
        | "text"
        | "email"
        | "tel"
        | "url"
        | "none"
        | "numeric"
        | "decimal";
    inputPattern?: string;
    inputRef?: (element?: null | HTMLInputElement) => void;
    inputType?:
        | "number"
        | "color"
        | "search"
        | "text"
        | "date"
        | "email"
        | "month"
        | "password"
        | "tel"
        | "time"
        | "url"
        | "week";
    invalid: null
    | string;
    leadingIcon?: any;
    leadingIconClick?: (
        value: Value,
        data: any,
        payload: any,
        onValueChange: (v: Value) => void,
        onChange: (data: any) => void,
    ) => void;
    leadingIconRipple?: boolean;
    leadingIconTabIndex?: number;
    loading: boolean;
    name: string;
    onChange: (v: any, config?: { skipReadonly?: boolean }) => void;
    outlined?: boolean;
    placeholder?: string;
    readonly?: boolean;
    title?: string;
    trailingIcon?: any;
    trailingIconClick?: (
        value: Value,
        data: any,
        payload: any,
        onValueChange: (v: Value) => void,
        onChange: (data: any) => void,
    ) => void;
    trailingIconRipple?: boolean;
    trailingIconTabIndex?: number;
    validation?: IValidation;
    value: any;
}

Hierarchy

  • IDictBase
    • IDictSlot

Properties

description? dictCreateButton? dictDelay? dictLimit? dictOnAppend? dictOnItem? dictOnText? dictSearch? dictSearchItem? dictSearchText? dictValue? dirty disabled groupRef? incorrect inputAutocomplete? inputFormatter? inputFormatterAllowed? inputFormatterReplace? inputFormatterSymbol? inputFormatterTemplate? inputMode? inputPattern? inputRef? inputType? invalid leadingIcon? leadingIconClick? leadingIconRipple? leadingIconTabIndex? loading name onChange outlined? placeholder? readonly? title? trailingIcon? trailingIconClick? trailingIconRipple? trailingIconTabIndex? validation? value

Properties

Optionaldescription

description?: string

Type definition for the PickProp function.

Template: T

The type of the object to pick from.

Template: K

The type of the property to pick.

Param: object

The object to pick from.

Param: prop

The property to pick from the object.

Returns

The value of the picked property.

OptionaldictCreateButton

dictCreateButton?: any

Retrieves the value of the "dictCreateButton" property from the provided object, which is of type PickProp<IField<Data, Payload>, "dictCreateButton">.

Param: input

The input object.

Returns

  • Returns the value of the "dictCreateButton" property, which can be of type "undefined" or "someDataType".

OptionaldictDelay

dictDelay?: number

Retrieves the optional "dictDelay" property from the provided object.

Template: Data

The data type of the object.

Template: Payload

The payload type of the object.

Param: object

The object containing the "dictDelay" property.

Returns

The value of the "dictDelay" property, if it exists, or undefined if it does not.

OptionaldictLimit

dictLimit?: number

Represents the 'dictLimit' property of an object.

Returns

  • The limit for the dictionary.

OptionaldictOnAppend

dictOnAppend?: (
    search: string,
    data: any,
    payload: any,
    onValueChange: (value: null | string) => void,
    onChange: (value: any) => void,
) => void

Represents an optional configuration property for a dictionary append operation.

OptionaldictOnItem

dictOnItem?: (
    value: null | string,
    data: any,
    payload: any,
    onValueChange: (value: null | string) => void,
    onChange: (data: any) => void,
) => void

Represents the field configuration for dictOnItem property.

OptionaldictOnText

dictOnText?: (
    text: string,
    data: any,
    payload: any,
    onValueChange: (value: null | string) => void,
    onChange: (data: any) => void,
) => void

Represents a variable dictOnText which is optional and can be of type PickProp<IField<Data, Payload>, "dictOnText">.

OptionaldictSearch

dictSearch?: (
    dto: {
        data: any;
        initial: boolean;
        limit: number;
        offset: number;
        payload: any;
        rows: ISearchItem<any>[];
        search: string;
    },
) => ISearchItem<any>[]
| Promise<ISearchItem<any>[]>

OptionaldictSearchItem

dictSearchItem?: any

Represents the 'dictSearchItem' property of an object.

Description

This property is an optional field that is used to store information related to dictionary search item. It is extracted from the 'IField' interface using the 'PickProp' utility type.

See

OptionaldictSearchText

dictSearchText?: (data: any, payload: any) => string | Promise<string>

OptionaldictValue

dictValue?: (
    value: string,
    data: any,
    payload: any,
) => ISearchItem<any> | Promise<ISearchItem<any>>

Retrieves the "dictValue" property from the given object.

Type declaration

    • (
          value: string,
          data: any,
          payload: any,
      ): ISearchItem<any> | Promise<ISearchItem<any>>

    • Parameters

      • value: string
      • data: any
      • payload: any

      Returns ISearchItem<any> | Promise<ISearchItem<any>>

      • The value of the "dictValue" property, or undefined if it does not exist.

dirty

dirty: boolean

disabled

disabled: boolean

Represents the disabled property of a given field in a form.

Template: Data

The data type of the field.

Template: Payload

The payload type of the field.

Template: IField

The interface of the field.

Template: PickProp

Utility to pick a property from an interface.

Param: field

The given field in a form.

Returns

  • The value of the disabled property.

OptionalgroupRef

groupRef?: (element?: null | HTMLDivElement) => void

Represents the group reference property of a field in a data payload.

incorrect

incorrect: null | string

OptionalinputAutocomplete

inputAutocomplete?: "new-password" | "on" | "off" | "false"

Retrieves the value of the "inputAutocomplete" property from the specified object.

Template: Data

The type of the data object.

Template: Payload

The type of the payload object.

Template: T

The type of the object.

Param: obj

The object from which to retrieve the "inputAutocomplete" property.

Returns

The value of the "inputAutocomplete" property, or undefined if the property doesn't exist.

OptionalinputFormatter

inputFormatter?: (input: string) => string

Represents an input formatter for a specific type of field in a form.

OptionalinputFormatterAllowed

inputFormatterAllowed?: RegExp | (char: string, idx: number) => boolean

Represents the allowed input formatters for a field.

OptionalinputFormatterReplace

inputFormatterReplace?: (char: string) => null | string

Represents an object property inputFormatterReplace of the interface IField<Data, Payload>.

See

OptionalinputFormatterSymbol

inputFormatterSymbol?: string

Represents a symbol used by the input formatter for a given field.

OptionalinputFormatterTemplate

inputFormatterTemplate?: string

Represents a template for input formatter.

OptionalinputMode

inputMode?:
    | "search"
    | "text"
    | "email"
    | "tel"
    | "url"
    | "none"
    | "numeric"
    | "decimal"

Represents the input mode configuration for a field.

OptionalinputPattern

inputPattern?: string

Represents the input pattern of a field in the form.

OptionalinputRef

inputRef?: (element?: null | HTMLInputElement) => void

Represents a reference to the input element within a field.

OptionalinputType

inputType?:
    | "number"
    | "color"
    | "search"
    | "text"
    | "date"
    | "email"
    | "month"
    | "password"
    | "tel"
    | "time"
    | "url"
    | "week"

Represents the input type of a field.

invalid

invalid: null | string

OptionalleadingIcon

leadingIcon?: any

Represents the leading icon for a field.

OptionalleadingIconClick

leadingIconClick?: (
    value: Value,
    data: any,
    payload: any,
    onValueChange: (v: Value) => void,
    onChange: (data: any) => void,
) => void

Represents the optional property 'leadingIconClick' from the 'IField' interface.

Type declaration

    • (
          value: Value,
          data: any,
          payload: any,
          onValueChange: (v: Value) => void,
          onChange: (data: any) => void,
      ): void

    • Parameters

      • value: Value
      • data: any
      • payload: any
      • onValueChange: (v: Value) => void
      • onChange: (data: any) => void

      Returns void

OptionalleadingIconRipple

leadingIconRipple?: boolean

Represents the configuration for the leading icon ripple effect.

Memberof

PickProp<IField<Data, Payload>, 'leadingIconRipple'>

OptionalleadingIconTabIndex

leadingIconTabIndex?: number

loading

loading: boolean

name

name: string

onChange

onChange: (v: any, config?: { skipReadonly?: boolean }) => void

Optionaloutlined

outlined?: boolean

A type representing the picked property "outlined" from the given object type.

Template: T

The object type to pick the property from.

Template: K

The name of the property to pick.

Optionalplaceholder

placeholder?: string

Type definition for the placeholder property of PickProp type.

The placeholder property represents a subset of the IField<Data, Payload> type, where it specifically picks the placeholder property.

Template: Data

The type of the Data object in IField.

Template: Payload

The type of the Payload object in IField.

Optionalreadonly

readonly?: boolean

The readonly property of the IField object.

Optionaltitle

title?: string

Type declaration for the utility function PickProp.

Template: T

The type of the input object.

Template: K

The type of the property to pick.

OptionaltrailingIcon

trailingIcon?: any

This is a variable named trailingIcon. The variable is an optional property of type 'PickProp<IField<Data, Payload>, 'trailingIcon'>'.

OptionaltrailingIconClick

trailingIconClick?: (
    value: Value,
    data: any,
    payload: any,
    onValueChange: (v: Value) => void,
    onChange: (data: any) => void,
) => void

The trailingIconClick property defines the action to be performed when the trailing icon of a field is clicked.

Description

The trailingIconClick property accepts a function that will be executed when the trailing icon of a field is clicked.

OptionaltrailingIconRipple

trailingIconRipple?: boolean

Represents the trailing icon ripple configuration for a field.

OptionaltrailingIconTabIndex

trailingIconTabIndex?: number

Optionalvalidation

validation?: IValidation

Validation factory config

Template: IField

Type representing the field object.

Template: Data

Type representing the data object.

Template: Payload

Type representing the payload object.

Returns

The value of the "validation" property.

value

value: any

Settings

Member Visibility

On This Page

Properties