Skip to content

Class: Dialog ‹SS›#

Type parameters#

▪ SS

Hierarchy#

↳ Dialog

Index#

Properties#

Accessors#

Methods#

Object literals#

Properties#

closeOnNavigate#

• closeOnNavigate: IReactionDisposer = reaction(() => navigation.getPath(), () => this.close())

Defined in src/renderer/components/dialog/dialog.tsx:45

Accessors#

elem#

• get elem(): HTMLElement

Defined in src/renderer/components/dialog/dialog.tsx:51

Returns: HTMLElement

isOpen#

• get isOpen(): boolean

Defined in src/renderer/components/dialog/dialog.tsx:56

Returns: boolean

Methods#

Optional UNSAFE_componentWillMount#

▸ UNSAFE_componentWillMount(): void

Inherited from PageLayout.UNSAFE_componentWillMount

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

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‹DialogProps›, nextContext: any): void

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

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

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‹DialogProps›
nextContext any

Returns: void

Optional UNSAFE_componentWillUpdate#

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹DialogProps›, nextState: Readonly‹DialogState›, nextContext: any): void

Inherited from PageLayout.UNSAFE_componentWillUpdate

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

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‹DialogProps›
nextState Readonly‹DialogState›
nextContext any

Returns: void

close#

▸ close(): void

Defined in src/renderer/components/dialog/dialog.tsx:87

Returns: void

Optional componentDidCatch#

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

Inherited from PageLayout.componentDidCatch

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

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

componentDidMount#

▸ componentDidMount(): void

Overrides WizardLayout.componentDidMount

Defined in src/renderer/components/dialog/dialog.tsx:60

Returns: void

componentDidUpdate#

▸ componentDidUpdate(prevProps: DialogProps): void

Overrides PageLayout.componentDidUpdate

Defined in src/renderer/components/dialog/dialog.tsx:64

Parameters:

Name Type
prevProps DialogProps

Returns: void

Optional componentWillMount#

▸ componentWillMount(): void

Inherited from PageLayout.componentWillMount

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

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‹DialogProps›, nextContext: any): void

Inherited from PageLayout.componentWillReceiveProps

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

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‹DialogProps›
nextContext any

Returns: void

componentWillUnmount#

▸ componentWillUnmount(): void

Overrides WizardLayout.componentWillUnmount

Defined in src/renderer/components/dialog/dialog.tsx:72

Returns: void

Optional componentWillUpdate#

▸ componentWillUpdate(nextProps: Readonly‹DialogProps›, nextState: Readonly‹DialogState›, nextContext: any): void

Inherited from PageLayout.componentWillUpdate

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

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‹DialogProps›
nextState Readonly‹DialogState›
nextContext any

Returns: void

Optional getSnapshotBeforeUpdate#

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹DialogProps›, prevState: Readonly‹DialogState›): SS | null

Inherited from PageLayout.getSnapshotBeforeUpdate

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

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‹DialogProps›
prevState Readonly‹DialogState›

Returns: SS | null

onClickOutside#

▸ onClickOutside(evt: MouseEvent): void

Defined in src/renderer/components/dialog/dialog.tsx:121

Parameters:

Name Type
evt MouseEvent

Returns: void

onClose#

▸ onClose(): void

Defined in src/renderer/components/dialog/dialog.tsx:103

Returns: void

onEscapeKey#

▸ onEscapeKey(evt: KeyboardEvent): void

Defined in src/renderer/components/dialog/dialog.tsx:112

Parameters:

Name Type
evt KeyboardEvent

Returns: void

onOpen#

▸ onOpen(): void

Defined in src/renderer/components/dialog/dialog.tsx:93

Returns: void

open#

▸ open(): void

Defined in src/renderer/components/dialog/dialog.tsx:81

Returns: void

render#

▸ render(): ReactPortal‹›

Defined in src/renderer/components/dialog/dialog.tsx:130

Returns: ReactPortal‹›

Optional shouldComponentUpdate#

▸ shouldComponentUpdate(nextProps: Readonly‹DialogProps›, nextState: Readonly‹DialogState›, nextContext: any): boolean

Inherited from PageLayout.shouldComponentUpdate

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

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‹DialogProps›
nextState Readonly‹DialogState›
nextContext any

Returns: boolean

toggle#

▸ toggle(isOpen: boolean): void

Defined in src/renderer/components/dialog/dialog.tsx:76

Parameters:

Name Type
isOpen boolean

Returns: void

Object literals#

state#

▪ state: object#

Defined in src/renderer/components/dialog/dialog.tsx:47

isOpen#

• isOpen: boolean = this.props.isOpen

Defined in src/renderer/components/dialog/dialog.tsx:48

Static defaultProps#

▪ defaultProps: object#

Defined in src/renderer/components/dialog/dialog.tsx:33

animated#

• animated: true = true

Defined in src/renderer/components/dialog/dialog.tsx:40

close#

• close: any = noop

Defined in src/renderer/components/dialog/dialog.tsx:36

isOpen#

• isOpen: false = false

Defined in src/renderer/components/dialog/dialog.tsx:34

• modal: true = true

Defined in src/renderer/components/dialog/dialog.tsx:39

onClose#

• onClose: any = noop

Defined in src/renderer/components/dialog/dialog.tsx:38

onOpen#

• onOpen: any = noop

Defined in src/renderer/components/dialog/dialog.tsx:37

open#

• open: any = noop

Defined in src/renderer/components/dialog/dialog.tsx:35

pinned#

• pinned: false = false

Defined in src/renderer/components/dialog/dialog.tsx:41