Interface: CharInputSlotProps
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/CharInput/CharInputSlot.tsx:11
Component props for CharInputSlot.
Extends
ComponentProps
Properties
charArray
charArray: readonly
string
[]
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/CharInput/CharInputSlot.tsx:16
An array of valid character values for the slot. The order of characters in the array determines the order in which the slot will cycle through characters when incrementing/decrementing its value.
children?
optional
children:DisplayChildren
[]
Defined in: sdk/components/FSComponent.ts:122
The children of the display component.
Inherited from
ComponentProps.children
class?
optional
class:string
|ToggleableClassNameRecord
|SubscribableSet
<string
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/CharInput/CharInputSlot.tsx:34
CSS class(es) to apply to the slot's root element.
defaultCharValue
defaultCharValue:
string
|Subscribable
<string
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/CharInput/CharInputSlot.tsx:25
The default character value for the slot when the character value is null
.
ref?
optional
ref:NodeReference
<any
>
Defined in: sdk/components/FSComponent.ts:125
A reference to the display component.
Inherited from
ComponentProps.ref
renderChar()?
optional
renderChar: (character
,index
) =>string
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/CharInput/CharInputSlot.tsx:31
A function which renders slot characters into string. If not defined, non-null characters will be rendered as-is, and null characters will be rendered according to the default value assigned to that character.
Parameters
Parameter | Type |
---|---|
character | null | string |
index | number |
Returns
string
wrap
wrap:
boolean
|Subscribable
<boolean
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/CharInput/CharInputSlot.tsx:22
Whether the slot should wrap from the last valid character to the first valid character and vice-versa when incrementing/decrementing its value.