Represents a Dialog component.

Type Parameters

Hierarchy

Hierarchy

  • Component<P, {}>
    • IgrDialog

Constructors

  • Type parameters

    Type Parameters

    Parameters

    • props: P

    Returns IgrDialog<P>

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<P> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get closeOnOutsideClick(): boolean
  • Whether the dialog should be closed when clicking outside of it.

    Returns boolean

  • set closeOnOutsideClick(v): void
  • Parameters

    • v: boolean

    Returns void

  • get hideDefaultAction(): boolean
  • Whether to hide the default action button for the dialog. When there is projected content in the footer slot this property has no effect.

    Returns boolean

  • set hideDefaultAction(v): void
  • Parameters

    • v: boolean

    Returns void

  • get keepOpenOnEscape(): boolean
  • Whether the dialog should be kept open when pressing the 'ESCAPE' button.

    Returns boolean

  • set keepOpenOnEscape(v): void
  • Parameters

    • v: boolean

    Returns void

  • get open(): boolean
  • Whether the dialog is opened.

    Returns boolean

  • set open(v): void
  • Parameters

    • v: boolean

    Returns void

  • get returnValue(): string
  • Sets the return value for the dialog.

    Returns string

  • set returnValue(v): void
  • Parameters

    • v: string

    Returns void

  • get title(): string
  • Sets the title of the dialog.

    Returns string

  • set title(v): void
  • Parameters

    • v: string

    Returns void

Methods

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

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns void

  • 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

    • prevProps: Readonly<P>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    Returns void

  • 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

  • Parameters

    • name: string

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • 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

    • prevProps: Readonly<P>
    • prevState: Readonly<{}>

    Returns any

  • Closes the dialog.

    Returns void

  • Returns DOMElement<{
        children: any[];
        class: P["className"];
        id: P["id"];
        ref: ((ref) => void);
        style: P["style"];
    }, any>

  • Parameters

    • element: any

    Returns void

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

  • Opens the dialog.

    Returns void

  • Toggles the open state of the dialog.

    Returns void