Interface ITimeFieldProps<Data, Payload>

A set of properties for the TimeField component.

interface ITimeFieldProps<Data = IAnything, Payload = IAnything> {
    autoFocus?: boolean;
    description?: string;
    disabled?: boolean;
    inputRef?: (element?: null | HTMLInputElement) => void;
    labelShrink?: boolean;
    outlined?: boolean;
    placeholder?: string;
    readonly?: boolean;
    title?: string;
    validation?: IValidation;
}

Type Parameters

  • Data = IAnything

    The type of data expected to be stored in the field.

  • Payload = IAnything

    The type of payload expected to be returned on field change.

Properties

autoFocus? description? disabled? inputRef? labelShrink? outlined? placeholder? readonly? title? validation?

Properties

OptionalautoFocus

autoFocus?: boolean

Represents the "autoFocus" property of a field.

Optionaldescription

description?: string

Returns the "description" property value of the given object. The object must be of type IField<Data, Payload>.

Param: object

The object to pick the "description" property from.

Returns

  • The value of the "description" property.

Optionaldisabled

disabled?: boolean

Retrieves the "disabled" property from an object of type IField<Data, Payload>.

Template: Data

The type of data associated with the field.

Template: Payload

The type of payload associated with the field.

Param: disabled

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

Returns

  • The value of the "disabled" property.

OptionalinputRef

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

Represents a reference to an input element.

OptionallabelShrink

labelShrink?: boolean

Represents the shrink property of the label in a field.

Optionaloutlined

outlined?: boolean

Returns the value of the "outlined" property for the given field.

Template: Data

The type of data consumed by the field.

Template: Payload

The type of payload.

Param: field

The field to pick the "outlined" property from.

Returns

The value of the "outlined" property.

Optionalplaceholder

placeholder?: string

Retrieves the placeholder property from an object IField<Data, Payload>.

Template: Data

The type of data for the field.

Template: Payload

The type of payload.

Param: field

The field object from which to retrieve the placeholder property.

Returns

  • The placeholder property of the field object.

Optionalreadonly

readonly?: boolean

Retrieves the value of the "readonly" property from a given object that has a specific structure.

Param: field

The input object with a specific structure.

Returns

The value of the "readonly" property from the input object.

Optionaltitle

title?: string

Retrieves the value of the "title" property from the given object.

Template: T

The type of the object.

Template: K

The key of the property to be picked.

Param: obj

The object from which to pick the property.

Param: key

The key of the property to pick.

Returns

  • The value of the picked property.

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.

Settings

Member Visibility

On This Page

Properties