Skip to main content

Interface: CharInputProps

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/CharInput/CharInput.tsx:12

Component props for CharInput.

Extends

  • ComponentProps

Properties

children?

optional children: DisplayChildren[]

Defined in: src/sdk/components/FSComponent.ts:122

The children of the display component.

Inherited from

ComponentProps.children


class?

optional class: string | ToggleableClassNameRecord | SubscribableSet<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/CharInput/CharInput.tsx:30

CSS class(es) to apply to the root of the component.


initialEditIndex?

optional initialEditIndex: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/CharInput/CharInput.tsx:21

The character index to initially select with the cursor when editing is activated. Defaults to 0.


ref?

optional ref: NodeReference<any>

Defined in: src/sdk/components/FSComponent.ts:125

A reference to the display component.

Inherited from

ComponentProps.ref


renderInactiveValue?

optional renderInactiveValue: VNode | (value) => string | VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/CharInput/CharInput.tsx:27

A function or VNode which renders the input's value when editing is not active. If defined, the rendered inactive value replaces all rendered child components when editing is not active.


value

value: MutableSubscribable<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/CharInput/CharInput.tsx:18

A mutable subscribable to bind to the input's composite value. The binding is one-way: changes in the input value will be piped to the subscribable, but changes in the subscribable's value will not trigger any changes to the input.