Class: GtcListButton
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcListButton.tsx:31
A TouchButton used at the top level of a GtcList list item. Handles cleaning up the TouchButton on destroy.
Extends
DisplayComponent<GtcListButtonProps>
Constructors
Constructor
new GtcListButton(
props):GtcListButton
Defined in: sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
| Parameter | Type | Description |
|---|---|---|
props | GtcListButtonProps | The propertis of the component. |
Returns
GtcListButton
Inherited from
DisplayComponent<GtcListButtonProps>.constructor
Properties
context?
optionalcontext: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
DisplayComponent.context
contextType?
readonlyoptionalcontextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
props
props:
GtcListButtonProps&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
DisplayComponent.props
Methods
destroy()
destroy():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcListButton.tsx:89
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
getContext()
protectedgetContext(context):never
Defined in: sdk/components/FSComponent.ts:106
Gets a context data subscription from the context collection.
Parameters
| Parameter | Type | Description |
|---|---|---|
context | never | The context to get the subscription for. |
Returns
never
The requested context.
Throws
An error if no data for the specified context type could be found.
Inherited from
DisplayComponent.getContext
onAfterRender()
onAfterRender(
node):void
Defined in: sdk/components/FSComponent.ts:87
A callback that is called after the component is rendered.
Parameters
| Parameter | Type | Description |
|---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
DisplayComponent.onAfterRender
onBeforeRender()
onBeforeRender():
void
Defined in: sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
render()
render():
VNode
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcListButton.tsx:40
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render