Class: ButtonMenu

Defined in: workingtitle-instruments-epic2/shared/Components/ButtonMenu.tsx:42

Button menu

Extends

• DisplayComponent<ButtonMenuProps>

Constructors

Constructor

new ButtonMenu(props): ButtonMenu

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	ButtonMenuProps	The propertis of the component.

Returns

ButtonMenu

Inherited from

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

menuContainerElement

readonly menuContainerElement: NodeReference<HTMLElement>

Defined in: workingtitle-instruments-epic2/shared/Components/ButtonMenu.tsx:61

---

props

props: ButtonMenuProps & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

Methods

countAncestorsWithClass()

countAncestorsWithClass(node, className): number

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

Count the number of ancestors with a specific class.

Parameters

Parameter	Type	Description
node	null | HTMLElement	HTMLElement
className	string	className to search for

Returns

number

The count of ancestors with the specified class.

---

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy

---

getContext()

protected getContext(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

---

handleMouseUp()

readonly handleMouseUp(e): void

Defined in: workingtitle-instruments-epic2/shared/Components/ButtonMenu.tsx:129

Global event handler to close any open menus

Parameters

Parameter	Type	Description
e	MouseEvent	MouseEvent

Returns

void

---

onAfterRender()

onAfterRender(node): void

Defined in: workingtitle-instruments-epic2/shared/Components/ButtonMenu.tsx:86

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
node	VNode	The component's VNode.

Returns

void

Overrides

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

---

onDestroy()

onDestroy(): void

Defined in: workingtitle-instruments-epic2/shared/Components/ButtonMenu.tsx:187

Returns

void

Inherit Doc

---

render()

render(): VNode

Defined in: workingtitle-instruments-epic2/shared/Components/ButtonMenu.tsx:152

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render