Class FilterMenu

A specialized subclass of ContextMenu designed for displaying a menu of filter options.

Hierarchy (View Summary)

ContextMenu
- FilterMenu

Index

Constructors

constructor

new FilterMenu(
    container: HTMLElement,
    selector: string,
    options?: FilterMenuOptions,
): FilterMenu
Parameters
- container: HTMLElement
  The HTML element that contains the context menu targets.
- selector: string
  A CSS selector which activates the context menu.
- Optionaloptions: FilterMenuOptions = {}
  Additional options to configure the context menu.
Returns FilterMenu
Overrides ContextMenu.constructor

Properties

menuItems

menuItems: (ContextMenuEntry & { element: HTMLElement })[]

The array of menu items to render.

onClose

onClose: ContextMenuCallback

A function to call when the context menu is closed.

onOpen

onOpen: ContextMenuCallback

A function to call when the context menu is opened.

Accessors

element

get element(): HTMLElement
The menu element.

Returns HTMLElement
Inherited from FilterMenu.element

eventName

get eventName(): string
The event name to listen for.

Returns string
Inherited from FilterMenu.eventName

expandUp

get expandUp(): boolean
Check which direction the menu is expanded in.

Returns boolean
Inherited from FilterMenu.expandUp

fixed

get fixed(): boolean
Whether to position the context menu as a fixed element, or inject it into the target.

Returns boolean
Inherited from FilterMenu.fixed

relative

get relative(): "target" | "cursor"
For fixed context menus, control whether the menu is positioned relative to the target or to the mouse cursor. Non-fixed context menus are always positioned relative to the target.

Returns "target" | "cursor"
Inherited from FilterMenu.relative

selector

get selector(): string
A CSS selector to identify context menu targets.

Returns string
Inherited from FilterMenu.selector

target

get target(): HTMLElement
The parent HTML element to which the context menu is attached

Returns HTMLElement
Inherited from FilterMenu.target

`Static`implementation

get implementation(): typeof ContextMenu
Retrieve the configured ContextMenu implementation.

Returns typeof ContextMenu
Inherited from ContextMenu.implementation

Methods

_preRenderEntries

_preRenderEntries(options?: {}): Promise<void>
Called before the menu's entries are rendered.
Parameters
- options: {} = {}
Returns Promise<void>
Overrides ContextMenu._preRenderEntries

activateListeners

activateListeners(menu: HTMLElement, options?: ContextMenuRenderOptions): void
Local listeners which apply to each ContextMenu instance which is created.
Parameters
- menu: HTMLElement
  The context menu element.
- Optionaloptions: ContextMenuRenderOptions = {}
Returns void
Inherited from ContextMenu.activateListeners

close

close(options?: { animate?: boolean; target?: HTMLElement }): Promise<void>
Closes the menu and removes it from the DOM.
Parameters
- Optionaloptions: { animate?: boolean; target?: HTMLElement } = {}
  Options to configure the closing behavior.
  - Optionalanimate?: boolean
    Animate the context menu closing.
  - Optionaltarget?: HTMLElement
    The target element to close on.
Returns Promise<void>
Inherited from ContextMenu.close

render

render(target: HTMLElement, options?: ContextMenuRenderOptions): Promise<void>
Render the Context Menu by iterating over the menuItems it contains. Check the visibility of each menu item, and only render ones which are allowed by the item's logical condition. Attach a click handler to each item which is rendered.
Parameters
- target: HTMLElement
  The target element to which the context menu is attached.
- Optionaloptions: ContextMenuRenderOptions = {}
Returns Promise<void>
A Promise that resolves when the open animation has completed.

Inherited from ContextMenu.render

`Protected`_animate

_animate(open?: boolean): Promise<void>
Protected
Animate the context menu's height when opening or closing.
Parameters
- open: boolean = false
  Whether the menu is opening or closing.
Returns Promise<void>
A Promise that resolves when the animation completes.

Inherited from ContextMenu._animate

`Protected`_close

_close(options?: { target?: HTMLElement }): void
Protected
Close the menu and remove it from the DOM.
Parameters
- Optionaloptions: { target?: HTMLElement } = {}
  - Optionaltarget?: HTMLElement
    The target element to close on.
Returns void
Inherited from ContextMenu._close

`Protected`_injectMenu

_injectMenu(menu: HTMLElement, target: HTMLElement): void
Protected
Inject the menu inside the target.
Parameters
- menu: HTMLElement
  The menu element.
- target: HTMLElement
  The context target.
Returns void
Inherited from ContextMenu._injectMenu

`Protected`_onActivate

_onActivate(event: Event): Promise<void> | undefined
Protected
Handle context menu activation.
Parameters
- event: Event
  The triggering event.
Returns Promise<void> | undefined
Inherited from ContextMenu._onActivate

`Protected`_onRender

_onRender(options?: ContextMenuRenderOptions): Promise<void>
Protected
Called after the context menu has finished rendering and animating open.
Parameters
- Optionaloptions: ContextMenuRenderOptions = {}
Returns Promise<void>
Inherited from ContextMenu._onRender

`Protected`_onRenderEntries

_onRenderEntries(
menu: HTMLMenuElement,
options?: ContextMenuRenderOptions,
): Promise<void>
Protected
Called after the context menu has finished rendering its entries.
Parameters
- menu: HTMLMenuElement
  The rendered menu.
- Optionaloptions: ContextMenuRenderOptions = {}
Returns Promise<void>
Inherited from ContextMenu._onRenderEntries

`Protected`_preRender

_preRender(
target: HTMLElement,
options?: ContextMenuRenderOptions,
): Promise<void>
Protected
Called before the context menu begins rendering.
Parameters
- target: HTMLElement
  The context target.
- Optionaloptions: ContextMenuRenderOptions = {}
Returns Promise<void>
Inherited from ContextMenu._preRender

`Protected`_setFixedPosition

_setFixedPosition(
    menu: HTMLElement,
    target: HTMLElement,
    options?: { event?: Event },
): void
Protected
Set the context menu at a fixed position in the viewport.
Parameters
- menu: HTMLElement
  The menu element.
- target: HTMLElement
  The context target.
- Optionaloptions: { event?: Event } = {}
  - Optionalevent?: Event
    The event that triggered the context menu opening.
Returns void
Inherited from ContextMenu._setFixedPosition

`Protected`_setPosition

_setPosition(
    menu: HTMLElement,
    target: HTMLElement,
    options?: { event?: Event },
): void
Protected
Set the position of the context menu, taking into consideration whether the menu should expand upward or downward
Parameters
- menu: HTMLElement
  The context menu element.
- target: HTMLElement
  The element that the context menu was spawned on.
- Optionaloptions: { event?: Event } = {}
  - Optionalevent?: Event
    The event that triggered the context menu opening.
Returns void
Inherited from ContextMenu._setPosition

`Static`activateListeners

activateListeners(
document: Document,
__namedParameters?: { _deprecated?: boolean },
): void
Bind global context menu listeners to a given document.
Parameters
- document: Document
  The document.
- __namedParameters: { _deprecated?: boolean } = {}
Returns void
Inherited from ContextMenu.activateListeners

`Static`create

create(
    app: Application,
    html: any,
    selector: string,
    menuItems: ContextMenuEntry[],
    options?: { hookName?: string },
): ContextMenu
Create a ContextMenu for this Application and dispatch hooks.
Parameters
- app: Application
  The Application this ContextMenu belongs to.
- html: any
  The Application's rendered HTML.
- selector: string
  The target CSS selector which activates the menu.
- menuItems: ContextMenuEntry[]
  The array of menu items being rendered.
- Optionaloptions: { hookName?: string } = {}
  Additional options to configure context menu initialization.
  - OptionalhookName?: string
    The name of the hook to call.
Returns ContextMenu
Deprecated
since v13

Inherited from ContextMenu.create

Class FilterMenu

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FilterMenu

Properties

menuItems

onClose

onOpen

Accessors

element

Returns HTMLElement

eventName

Returns string

expandUp

Returns boolean

fixed

Returns boolean

relative

Returns "target" | "cursor"

selector

Returns string

target

Returns HTMLElement

Staticimplementation

Returns typeof ContextMenu

Methods

_preRenderEntries

Parameters

Returns Promise<void>

activateListeners

Parameters

Returns void

close

Parameters

Optionalanimate?: boolean

Optionaltarget?: HTMLElement

Returns Promise<void>

render

Parameters

Returns Promise<void>

Protected_animate

Parameters

Returns Promise<void>

Protected_close

Parameters

Optionaltarget?: HTMLElement

Returns void

Protected_injectMenu

Parameters

Returns void

Protected_onActivate

Parameters

Returns Promise<void> | undefined

Protected_onRender

Parameters

Returns Promise<void>

Protected_onRenderEntries

Parameters

Returns Promise<void>

Protected_preRender

Parameters

Returns Promise<void>

Protected_setFixedPosition

Parameters

Optionalevent?: Event

Returns void

Protected_setPosition

Parameters

Optionalevent?: Event

Returns void

StaticactivateListeners

Parameters

Returns void

`Static`implementation

`Optional`animate?: boolean

`Optional`target?: HTMLElement

`Protected`_animate

`Protected`_close

`Optional`target?: HTMLElement

`Protected`_injectMenu

`Protected`_onActivate

`Protected`_onRender

`Protected`_onRenderEntries

`Protected`_preRender

`Protected`_setFixedPosition

`Optional`event?: Event

`Protected`_setPosition

`Optional`event?: Event

`Static`activateListeners

`Static`create

`Optional`hookName?: string