Interface IComponentFieldProps<Data, Payload>

Props interface for the IComponentField component.

interface IComponentFieldProps<Data = IAnything, Payload = IAnything> {
    className?: string;
    element?: any;
    groupRef?: (element?: null | HTMLDivElement) => void;
    name?: string;
    placeholder?: string;
    style?: any;
    sx?: any;
    watchOneContext?: boolean;
}

Type Parameters

  • Data = IAnything

    The type of data for the field.

  • Payload = IAnything

    The type of payload for the field.

Properties

className? element? groupRef? name? placeholder? style? sx? watchOneContext?

Properties

OptionalclassName

className?: string

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

Param: obj

The input object containing the "className" property.

Returns

  • The value of the "className" property if present, otherwise undefined.

Throws

If the input object is not of the expected type.

Optionalelement

element?: any

Retrieves the "element" property from the given object

Param: element

The object to extract the "element" property from

Returns

  • The value of the "element" property

OptionalgroupRef

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

Represents a property of an object, where the key is "groupRef" and the value is of type PickProp<IField<Data, Payload>, "groupRef">.

Optionalname

name?: string

Type definition for the 'name' property of an object. The 'name' property is extracted from a specific type and is used to pick a specific property from that type.

Template: Data

The data type to extract the property from.

Template: Payload

The type of the property to pick.

Optionalplaceholder

placeholder?: string

Type definition for the placeholder property of a field.

Template: Data

The type of data associated with the field.

Template: Payload

The type of payload used for updating the field.

Optionalstyle

style?: any

Returns the style property of the given variable.

Template: T

The type of the variable.

Template: K

The type of the property to be picked.

Param: obj

The variable from which to pick the property.

Param: prop

The property to pick from the variable.

Returns

  • The picked property value.

Optionalsx

sx?: any

Represents the 'sx' property of a PickProp.

Template: IField

The input field type.

Template: Data

The data type.

Template: Payload

The payload type.

Param: -

The input field.

Returns

  • The value of the 'sx' property.

OptionalwatchOneContext

watchOneContext?: boolean

Represents the contextual information for watching a single field in a data structure.

Settings

Member Visibility

On This Page

Properties