Interface OverlayStateModel

Controlled or uncontrolled Overlay open-state model.

interface OverlayStateModel {
    close(): boolean;
    isOpen(): boolean;
    open(): boolean;
    setOptions(options: CreateOverlayStateOptions): boolean;
    toggle(): boolean;
}

Index

Methods

close isOpen open setOptions toggle

Methods

close

close(): boolean
Requests closing and returns resulting observable state.

Returns boolean
- Defined in components/overlays/overlay/index.ts:16

isOpen

isOpen(): boolean
Returns current controlled or uncontrolled open state.

Returns boolean
- Defined in components/overlays/overlay/index.ts:19

open

open(): boolean
Requests opening and returns resulting observable state.

Returns boolean
- Defined in components/overlays/overlay/index.ts:22

setOptions

setOptions(options: CreateOverlayStateOptions): boolean
Replaces controlled/uncontrolled options.
Parameters
- options: CreateOverlayStateOptions
Returns boolean
- Defined in components/overlays/overlay/index.ts:25

toggle

toggle(): boolean
Requests opposite state and returns resulting observable state.

Returns boolean
- Defined in components/overlays/overlay/index.ts:28