Skip to main content

Interface: ListButtonProps

Defined in: workingtitle-instruments-epic2/shared/Components/List/ListButton.tsx:7

The props for ListButton.

Extends​

Properties​

children?​

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from​

Omit.children

fullSizeButton?​

optional fullSizeButton: boolean

Defined in: workingtitle-instruments-epic2/shared/Components/List/ListButton.tsx:15

Whether the button should fill the entire list item. Overrides hideBorder to be true when true. Defaults to false.

hideBorder?​

optional hideBorder: boolean | Subscribable<boolean>

Defined in: workingtitle-instruments-epic2/shared/Components/List/ListItem.tsx:13

Hides the list item border, allowing the content to easily fill the entire space of the list-item. Defaults to false.

Inherited from​

Omit.hideBorder

isEnabled?​

optional isEnabled: boolean | Subscribable<boolean>

Defined in: workingtitle-instruments-epic2/shared/Components/TouchButton.tsx:85

Whether the button is enabled, or a subscribable which provides it. Disabled buttons cannot be touched, primed, pressed, or held. Defaults to true.

Inherited from​

Pick.isEnabled

isHighlighted?​

optional isHighlighted: boolean | Subscribable<boolean>

Defined in: workingtitle-instruments-epic2/shared/Components/TouchButton.tsx:92

Whether the button is highlighted, or a subscribable which provides it. When true, the touch-button-highlight css class will be applied, making the button cyan with black font. Defaults to false.

Inherited from​

Pick.isHighlighted

isVisible?​

optional isVisible: boolean | Subscribable<boolean>

Defined in: workingtitle-instruments-epic2/shared/Components/List/ListItem.tsx:22

Controls the list item's visibility. Defaults to true.

Inherited from​

Omit.isVisible

label?​

optional label: string | VNode | Subscribable<string>

Defined in: workingtitle-instruments-epic2/shared/Components/TouchButton.tsx:111

The label for the button. Can be defined as either a static string, a subscribable which provides the label string, or a VNode. If not defined, the button will not have a label.

If the label is defined as a VNode, all first-level DisplayComponents in the VNode tree will be destroyed when the button is destroyed.

Inherited from​

Pick.label

listItemClasses?​

optional listItemClasses: string | SubscribableSet<string>

Defined in: workingtitle-instruments-epic2/shared/Components/List/ListButton.tsx:21

CSS class(es) to apply to the list item div element.

onDestroy()?​

optional onDestroy: () => void

Defined in: workingtitle-instruments-epic2/shared/Components/List/ListButton.tsx:18

A callback function to execute when the list item is destroyed.

Returns​

void

Overrides​

Omit.onDestroy

onPressed()?​

optional onPressed: <B>(button, isHeld) => void

Defined in: workingtitle-instruments-epic2/shared/Components/TouchButton.tsx:126

A callback function which will be called every time the button is pressed.

Type Parameters​

Type ParameterDefault type
B extends TouchButton<TouchButtonProps>TouchButton<TouchButtonProps>

Parameters​

ParameterTypeDescription
buttonBThe button that was pressed.
isHeldbooleanWhether the button was held when it was pressed.

Returns​

void

Inherited from​

Pick.onPressed

paddedListItem?​

optional paddedListItem: boolean | Subscribable<boolean>

Defined in: workingtitle-instruments-epic2/shared/Components/List/ListItem.tsx:19

Adds some default, commonly used padding to the list item. Defaults to false.

Inherited from​

Omit.paddedListItem

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

Omit.ref

touchButtonClasses?​

optional touchButtonClasses: string | SubscribableSet<string>

Defined in: workingtitle-instruments-epic2/shared/Components/List/ListButton.tsx:24

CSS class(es) to apply to the list item div element.