Class: MenuItem ‹S, SS, S›

Type parameters

▪ S

▪ SS

▪ S

Hierarchy

• Component‹MenuItemProps›

↳ MenuItem

Index

Constructors

• constructor

Properties

• context
• elem
• props
• refs
• state
• contextType
• defaultProps

Accessors

• isFocusable
• isLink

Methods

• UNSAFE_componentWillMount
• UNSAFE_componentWillReceiveProps
• UNSAFE_componentWillUpdate
• bindRef
• componentDidCatch
• componentDidMount
• componentDidUpdate
• componentWillMount
• componentWillReceiveProps
• componentWillUnmount
• componentWillUpdate
• forceUpdate
• getSnapshotBeforeUpdate
• onClick
• render
• setState
• shouldComponentUpdate

Constructors

constructor

+ new MenuItem(props: Readonly‹MenuItemProps›): MenuItem

Inherited from PageLayout.constructor

Defined in node_modules/@types/react/index.d.ts:486

Parameters:

Name	Type
props	Readonly‹MenuItemProps›

Returns: MenuItem

+ new MenuItem(props: MenuItemProps, context?: any): MenuItem

Inherited from PageLayout.constructor

Defined in node_modules/@types/react/index.d.ts:488

deprecated

see https://reactjs.org/docs/legacy-context.html

Parameters:

Name	Type
props	MenuItemProps
context?	any

Returns: MenuItem

Properties

context

• context: MenuContextValue

Overrides PageLayout.context

Defined in src/renderer/components/menu/menu.tsx:307

---

elem

• elem: HTMLElement

Defined in src/renderer/components/menu/menu.tsx:308

---

props

• props: Readonly‹MenuItemProps› & Readonly‹object›

Inherited from PageLayout.props

Defined in node_modules/@types/react/index.d.ts:511

---

refs

• refs: object

Inherited from PageLayout.refs

Defined in node_modules/@types/react/index.d.ts:517

deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Type declaration:

• [ key: string]: ReactInstance

---

state

• state: Readonly‹S›

Inherited from PageLayout.state

Defined in node_modules/@types/react/index.d.ts:512

---

Static contextType

▪ contextType: Context‹Menu‹›› = MenuContext

Overrides PageLayout.contextType

Defined in src/renderer/components/menu/menu.tsx:305

---

Static defaultProps

▪ defaultProps: object = defaultPropsMenuItem as object

Defined in src/renderer/components/menu/menu.tsx:304

Accessors

isFocusable

• get isFocusable(): boolean

Defined in src/renderer/components/menu/menu.tsx:310

Returns: boolean

---

isLink

• get isLink(): boolean

Defined in src/renderer/components/menu/menu.tsx:316

Returns: boolean

Methods

Optional UNSAFE_componentWillMount

▸ UNSAFE_componentWillMount(): void

Inherited from PageLayout.UNSAFE_componentWillMount

Defined in node_modules/@types/react/index.d.ts:712

Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use componentDidMount or the constructor instead

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

---

Optional UNSAFE_componentWillReceiveProps

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹MenuItemProps›, nextContext: any): void

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

Defined in node_modules/@types/react/index.d.ts:744

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use static getDerivedStateFromProps instead

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

Name	Type
nextProps	Readonly‹MenuItemProps›
nextContext	any

Returns: void

---

Optional UNSAFE_componentWillUpdate

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹MenuItemProps›, nextState: Readonly‹S›, nextContext: any): void

Inherited from PageLayout.UNSAFE_componentWillUpdate

Defined in node_modules/@types/react/index.d.ts:772

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use getSnapshotBeforeUpdate instead

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

Name	Type
nextProps	Readonly‹MenuItemProps›
nextState	Readonly‹S›
nextContext	any

Returns: void

---

Protected bindRef

▸ bindRef(elem: HTMLElement): void

Defined in src/renderer/components/menu/menu.tsx:332

Parameters:

Name	Type
elem	HTMLElement

Returns: void

---

Optional componentDidCatch

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

Inherited from PageLayout.componentDidCatch

Defined in node_modules/@types/react/index.d.ts:641

Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

Parameters:

Name	Type
error	Error
errorInfo	ErrorInfo

Returns: void

---

Optional componentDidMount

▸ componentDidMount(): void

Inherited from WizardLayout.componentDidMount

Defined in node_modules/@types/react/index.d.ts:620

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

Returns: void

---

Optional componentDidUpdate

▸ componentDidUpdate(prevProps: Readonly‹MenuItemProps›, prevState: Readonly‹S›, snapshot?: SS): void

Inherited from PageLayout.componentDidUpdate

Defined in node_modules/@types/react/index.d.ts:683

Called immediately after updating occurs. Not called for the initial render.

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

Parameters:

Name	Type
prevProps	Readonly‹MenuItemProps›
prevState	Readonly‹S›
snapshot?	SS

Returns: void

---

Optional componentWillMount

▸ componentWillMount(): void

Inherited from PageLayout.componentWillMount

Defined in node_modules/@types/react/index.d.ts:698

Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

---

Optional componentWillReceiveProps

▸ componentWillReceiveProps(nextProps: Readonly‹MenuItemProps›, nextContext: any): void

Inherited from PageLayout.componentWillReceiveProps

Defined in node_modules/@types/react/index.d.ts:727

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

Name	Type
nextProps	Readonly‹MenuItemProps›
nextContext	any

Returns: void

---

Optional componentWillUnmount

▸ componentWillUnmount(): void

Inherited from WizardLayout.componentWillUnmount

Defined in node_modules/@types/react/index.d.ts:636

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

Returns: void

---

Optional componentWillUpdate

▸ componentWillUpdate(nextProps: Readonly‹MenuItemProps›, nextState: Readonly‹S›, nextContext: any): void

Inherited from PageLayout.componentWillUpdate

Defined in node_modules/@types/react/index.d.ts:757

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

Name	Type
nextProps	Readonly‹MenuItemProps›
nextState	Readonly‹S›
nextContext	any

Returns: void

---

forceUpdate

▸ forceUpdate(callback?: function): void

Inherited from PageLayout.forceUpdate

Defined in node_modules/@types/react/index.d.ts:503

Parameters:

▪Optional callback: function

▸ (): void

Returns: void

---

Optional getSnapshotBeforeUpdate

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹MenuItemProps›, prevState: Readonly‹S›): SS | null

Inherited from PageLayout.getSnapshotBeforeUpdate

Defined in node_modules/@types/react/index.d.ts:677

Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

Parameters:

Name	Type
prevProps	Readonly‹MenuItemProps›
prevState	Readonly‹S›

Returns: SS | null

---

onClick

▸ onClick(evt: MouseEvent): void

Defined in src/renderer/components/menu/menu.tsx:320

Parameters:

Name	Type
evt	MouseEvent

Returns: void

---

render

▸ render(): Element‹›

Overrides void

Defined in src/renderer/components/menu/menu.tsx:336

Returns: Element‹›

---

setState

▸ setState‹K›(state: function | S | object, callback?: function): void

Inherited from PageLayout.setState

Defined in node_modules/@types/react/index.d.ts:498

Type parameters:

▪ K: keyof S

Parameters:

▪ state: function | S | object

▪Optional callback: function

▸ (): void

Returns: void

---

Optional shouldComponentUpdate

▸ shouldComponentUpdate(nextProps: Readonly‹MenuItemProps›, nextState: Readonly‹S›, nextContext: any): boolean

Inherited from PageLayout.shouldComponentUpdate

Defined in node_modules/@types/react/index.d.ts:631

Called to determine whether the change in props and state should trigger a re-render.

Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

Parameters:

Name	Type
nextProps	Readonly‹MenuItemProps›
nextState	Readonly‹S›
nextContext	any

Returns: boolean