Heroic Lands

Interface ContextMenuEntryContext

The raw data describing a single context-menu entry, before it is normalized into a ContextMenuEntry or compiled for Foundry's ContextMenu base class.

interface ContextMenuEntryContext {
    callback?: ContextMenuCallback;
    condition: ContextMenuCondition;
    functionName?: string;
    group: SohlContextMenuSortGroup;
    icon?: HTMLString;
    iconFAClass?: string;
    id: string;
    name: string;
}

Properties

callback? condition functionName? group icon? iconFAClass? id name

Properties

Optionalcallback

callback?: ContextMenuCallback

Handler invoked when the entry is clicked; takes precedence over functionName.

condition

condition: ContextMenuCondition

Predicate (string SafeExpression or function) gating visibility. See ContextMenuCondition.

OptionalfunctionName

functionName?: string

Name of the logic method to invoke when no explicit callback is given.

group

group: SohlContextMenuSortGroup

Sort group the entry belongs to.

Optionalicon

icon?: HTMLString

Pre-built HTML icon markup; mutually optional with iconFAClass.

OptionaliconFAClass

iconFAClass?: string

Font-Awesome CSS class used to build an icon when icon is absent.

id

id: string

Unique identifier for the entry.

name

name: string

Display label for the entry.

Settings

Member Visibility

On This Page

Properties