Interface IIconFieldProps<Data, Payload>

Interface representing props for the IconField component.

interface IIconFieldProps<Data = IAnything, Payload = IAnything> {
    disabled?: boolean;
    groupRef?: (element?: null | HTMLDivElement) => void;
    icon?: any;
    iconBackground?:
        | "error"
        | "inherit"
        | "primary"
        | "secondary"
        | "success"
        | "info"
        | "warning";
    iconColor?: | "error"
    | "inherit"
    | "primary"
    | "secondary"
    | "success"
    | "info"
    | "warning"
    | "default";
    iconSize?: number;
}

Type Parameters

  • Data = IAnything

    The type of data for the field.

  • Payload = IAnything

    The type of payload for the field.

Hierarchy (View Summary)

Properties

disabled? groupRef? icon? iconBackground? iconColor? iconSize?

Properties

Optionaldisabled

disabled?: boolean

Represents the "disabled" property of a field in the given data payload.

Template: Data

The type of the data payload.

Template: Payload

The type of the payload object.

Param: disabled

The value of the "disabled" property.

Returns

OptionalgroupRef

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

Represents the optional property groupRef from the IField interface. The groupRef property is a subset of the PickProp type with the 'groupRef' key.

Optionalicon

icon?: any

Retrieves the 'icon' property from the given variable.

Template: T

The type of the variable.

Template: K

The key to pick from the variable.

Param: variable

The variable to pick the property from.

Returns

  • The picked property.

OptionaliconBackground

iconBackground?:
    | "error"
    | "inherit"
    | "primary"
    | "secondary"
    | "success"
    | "info"
    | "warning"

Retrieves the 'iconBackground' property from the given variable.

Template: T

The type of the variable.

Template: K

The key to pick from the variable.

Param: variable

The variable to pick the property from.

Returns

  • The picked property.

OptionaliconColor

iconColor?:
    | "error"
    | "inherit"
    | "primary"
    | "secondary"
    | "success"
    | "info"
    | "warning"
    | "default"

Retrieves the 'iconColor' property from the given variable.

Template: T

The type of the variable.

Template: K

The key to pick from the variable.

Param: variable

The variable to pick the property from.

Returns

  • The picked property.

OptionaliconSize

iconSize?: number

Retrieves the 'iconSize' property from the given variable.

Template: T

The type of the variable.

Template: K

The key to pick from the variable.

Param: variable

The variable to pick the property from.

Returns

  • The picked property.

Settings

Member Visibility

On This Page

Properties