Interface ISliderFieldProps<Data, Payload>

Interface representing the properties of a Slider Field component.

interface ISliderFieldProps<Data = IAnything, Payload = IAnything> {
    disabled?: boolean;
    groupRef?: (element?: null | HTMLDivElement) => void;
    labelFormatSlider?: (v: number) => string | number;
    leadingIcon?: any;
    leadingIconClick?: (
        value: Value,
        data: Data,
        payload: Payload,
        onValueChange: (v: Value) => void,
        onChange: (data: Data) => void,
    ) => void;
    leadingIconRipple?: boolean;
    leadingIconTabIndex?: number;
    maxSlider?: number;
    minSlider?: number;
    readonly?: boolean;
    sliderRailColor?: (v: number) => string;
    sliderSteps?: { label: string; value: number }[];
    sliderThumbColor?: (v: number) => string;
    sliderTrackColor?: (v: number) => string;
    stepSlider?: number;
    trailingIcon?: any;
    trailingIconClick?: (
        value: Value,
        data: Data,
        payload: Payload,
        onValueChange: (v: Value) => void,
        onChange: (data: Data) => void,
    ) => void;
    trailingIconRipple?: boolean;
    trailingIconTabIndex?: number;
}

Type Parameters

  • Data = IAnything

    The data type used in the Field component.

  • Payload = IAnything

    The payload type used in the Field component.

Hierarchy (View Summary)

Properties

disabled? groupRef? labelFormatSlider? leadingIcon? leadingIconClick? leadingIconRipple? leadingIconTabIndex? maxSlider? minSlider? readonly? sliderRailColor? sliderSteps? sliderThumbColor? sliderTrackColor? stepSlider? trailingIcon? trailingIconClick? trailingIconRipple? trailingIconTabIndex?

Properties

Optionaldisabled

disabled?: boolean

Represents the disabled property extracted from a field.

OptionalgroupRef

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

Represents the optional property 'groupRef' of an object of type IField<Data, Payload>.

OptionallabelFormatSlider

labelFormatSlider?: (v: number) => string | number

Specifies the format for the labels of a slider component.

OptionalleadingIcon

leadingIcon?: any

Represents the leading icon of a field.

OptionalleadingIconClick

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

This variable represents an optional function called leadingIconClick, which is a property of the IField interface. It is picked from the PickProp type, using the 'leadingIconClick ' key.

OptionalleadingIconRipple

leadingIconRipple?: boolean

Retrieve the value of the 'leadingIconRipple' property from a given object.

Param: obj

The object which contains the 'leadingIconRipple' property.

Returns

The value of the 'leadingIconRipple' property.

OptionalleadingIconTabIndex

leadingIconTabIndex?: number

OptionalmaxSlider

maxSlider?: number

The maximum value for a slider in a field of a data object payload.

OptionalminSlider

minSlider?: number

The minimum value for a slider in a field.

Optionalreadonly

readonly?: boolean

Retrieves the readonly property value from the provided object.

Param: obj

The object from which to retrieve the readonly property.

Returns

  • The value of the readonly property.

OptionalsliderRailColor

sliderRailColor?: (v: number) => string

Retrieves the value of the sliderRailColor property from the given object.

Type declaration

    • (v: number): string

    • Parameters

      • v: number

      Returns string

      • The value of the sliderRailColor property.

OptionalsliderSteps

sliderSteps?: { label: string; value: number }[]

Defines custom steps for the slider component.

OptionalsliderThumbColor

sliderThumbColor?: (v: number) => string

The color of the slider thumb.

OptionalsliderTrackColor

sliderTrackColor?: (v: number) => string

The color of the slider track.

OptionalstepSlider

stepSlider?: number

Represents the configuration for a step slider field.

OptionaltrailingIcon

trailingIcon?: any

Sets the trailing icon of the field.

Param: trailingIcon

The trailing icon to be set for the field.

OptionaltrailingIconClick

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

Represents the event handler for when the trailing icon of a field is clicked.

OptionaltrailingIconRipple

trailingIconRipple?: boolean

The trailingIconRipple variable is an optional property that represents the ripple effect configuration for the trailing icon in a field component. It is a pick property that is extracted from the trailingIconRipple property of the IField interface.

The trailingIconRipple property defines the behavior and appearance of the ripple effect when interacting with the trailing icon.

OptionaltrailingIconTabIndex

trailingIconTabIndex?: number

Settings

Member Visibility

On This Page

Properties