Class PopoverMenuController

Allows opening and closing a PopoverMenu.

Hierarchy

SAEventTarget
- PopoverMenuController

Index

Constructors

Properties

Methods

close emit off on open

Constructors

constructor

new PopoverMenuController(): PopoverMenuController
Returns PopoverMenuController
Inherited from SAEventTarget.constructor

Properties

[EventRecord]

"[EventRecord]": {}

Methods

close

close(): void
Closes the popover menu, including any nested popover menus.

Returns void
- Defined in src/components/PopoverMenu.tsx:783

emit

emit<
    K extends "openSignal"
    | "closeSignal",
    C extends new (type: K) => EventResult,
    EventResult extends Event | CustomEvent<PopoverMenuOpenParams>,
>(
    type: K,
    constructor: C,
): boolean
Type Parameters
- K extends "openSignal" | "closeSignal"
- C extends new (type: K) => EventResult
- EventResult extends Event | CustomEvent<PopoverMenuOpenParams>
Parameters
- type: K
- constructor: C
Returns boolean
Inherited from SAEventTarget.emit
- Defined in node_modules/com.sweaxizone.w3c.extension/dist/index.d.ts:28
emit<
    K extends "openSignal"
    | "closeSignal",
    C extends new (type: K, options: O) => EventResult,
    O,
    EventResult extends Event | CustomEvent<PopoverMenuOpenParams>,
>(
    type: K,
    constructor: C,
    options: O,
): boolean
Type Parameters
- K extends "openSignal" | "closeSignal"
- C extends new (type: K, options: O) => EventResult
- O
- EventResult extends Event | CustomEvent<PopoverMenuOpenParams>
Parameters
- type: K
- constructor: C
- options: O
Returns boolean
Inherited from SAEventTarget.emit
- Defined in node_modules/com.sweaxizone.w3c.extension/dist/index.d.ts:29
emit(event: Event): boolean
Parameters
- event: Event
Returns boolean
Inherited from SAEventTarget.emit
- Defined in node_modules/com.sweaxizone.w3c.extension/dist/index.d.ts:30

off

off<K extends "openSignal" | "closeSignal">(
    type: K,
    listener: (e: {}[K] extends Event ? any[any] : never) => void | undefined,
    options?: boolean | SAOffEventOptions,
): void
Type Parameters
- K extends "openSignal" | "closeSignal"
Parameters
- type: K
- listener: (e: {}[K] extends Event ? any[any] : never) => void | undefined
- Optionaloptions: boolean | SAOffEventOptions
Returns void
Inherited from SAEventTarget.off
- Defined in node_modules/com.sweaxizone.w3c.extension/dist/index.d.ts:26
off(
    type: string,
    listener: (e: Event) => void | undefined,
    options?: boolean | SAOffEventOptions,
): void
Parameters
- type: string
- listener: (e: Event) => void | undefined
- Optionaloptions: boolean | SAOffEventOptions
Returns void
Inherited from SAEventTarget.off
- Defined in node_modules/com.sweaxizone.w3c.extension/dist/index.d.ts:27

on

on<K extends "openSignal" | "closeSignal">(
    type: K,
    listener: (e: {}[K] extends Event ? any[any] : never) => void | undefined,
    options?: boolean | SAOnEventOptions,
): void
Type Parameters
- K extends "openSignal" | "closeSignal"
Parameters
- type: K
- listener: (e: {}[K] extends Event ? any[any] : never) => void | undefined
- Optionaloptions: boolean | SAOnEventOptions
Returns void
Inherited from SAEventTarget.on
- Defined in node_modules/com.sweaxizone.w3c.extension/dist/index.d.ts:24
on(
    type: string,
    listener: (e: Event) => void | undefined,
    options?: boolean | SAOnEventOptions,
): void
Parameters
- type: string
- listener: (e: Event) => void | undefined
- Optionaloptions: boolean | SAOnEventOptions
Returns void
Inherited from SAEventTarget.on
- Defined in node_modules/com.sweaxizone.w3c.extension/dist/index.d.ts:25

open

open(params: PopoverMenuOpenParams): void
Opens the popover menu.
Parameters
- params: PopoverMenuOpenParams
Returns void
- Defined in src/components/PopoverMenu.tsx:774