Skip to content

refactor: Make preconditionFn part of all context menu items #9558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gonfunko merged 2 commits into from
Jan 9, 2026
Merged

refactor: Make preconditionFn part of all context menu items #9558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53030a9
refactor: Make preconditionFn part of all context menu items
gonfunko Jan 8, 2026
a522829
test: Verify separator menu item behavior with precondition functions
gonfunko Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions core/contextmenu_registry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,15 +104,15 @@ export class ContextMenuRegistry {
weight: item.weight,
};

const precondition = item.preconditionFn?.(scope, menuOpenEvent);
if (precondition === 'hidden') continue;

if (item.separator) {
menuOption = {
...menuOption,
separator: true,
};
} else {
const precondition = item.preconditionFn(scope, menuOpenEvent);
if (precondition === 'hidden') continue;

const displayText =
typeof item.displayText === 'function'
? item.displayText(scope)
Expand Down Expand Up @@ -165,6 +165,7 @@ export namespace ContextMenuRegistry {
scopeType?: ScopeType;
weight: number;
id: string;
preconditionFn?: (p1: Scope, menuOpenEvent: Event) => string;
}

/**
Expand All @@ -185,8 +186,8 @@ export namespace ContextMenuRegistry {
location: Coordinate,
) => void;
displayText: ((p1: Scope) => string | HTMLElement) | string | HTMLElement;
preconditionFn: (p1: Scope, menuOpenEvent: Event) => string;
separator?: never;
preconditionFn: (p1: Scope, menuOpenEvent: Event) => string;
}

/**
Expand All @@ -196,7 +197,6 @@ export namespace ContextMenuRegistry {
separator: true;
callback?: never;
displayText?: never;
preconditionFn?: never;
}

/**
Expand Down
166 changes: 166 additions & 0 deletions tests/mocha/contextmenu_items_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,89 @@ suite('Context Menu Items', function () {
assert.equal(this.deleteOption.displayText(this.scope), 'Delete Block');
});
});

suite('Separators', function () {
setup(function () {
this.registry.reset();
this.registry.register({
weight: 0,
id: 'a',
preconditionFn: () => {},
displayText: 'a',
callback: () => {},
});
this.registry.register({
weight: 2,
id: 'b',
preconditionFn: () => {},
displayText: 'b',
callback: () => {},
});
});

test('are hidden when precondition returns hidden', function () {
this.registry.register({
weight: 1,
id: 'separator',
preconditionFn: () => 'hidden',
separator: true,
});

const items = this.registry.getContextMenuOptions(
this.scope,
new Event('pointerdown'),
);
assert.equal(items.length, 2);
assert.isTrue(items.every((item) => !('separator' in item)));
});

test('are included when precondition returns enabled', function () {
this.registry.register({
weight: 1,
id: 'separator',
preconditionFn: () => 'enabled',
separator: true,
});

const items = this.registry.getContextMenuOptions(
this.scope,
new Event('pointerdown'),
);
assert.equal(items.length, 3);
assert.isTrue('separator' in items[1]);
});

test('are included when precondition returns disabled', function () {
this.registry.register({
weight: 1,
id: 'separator',
preconditionFn: () => 'disabled',
separator: true,
});

const items = this.registry.getContextMenuOptions(
this.scope,
new Event('pointerdown'),
);
assert.equal(items.length, 3);
assert.isTrue('separator' in items[1]);
});

test('are included when there is no precondition', function () {
this.registry.register({
weight: 1,
id: 'separator',
separator: true,
});

const items = this.registry.getContextMenuOptions(
this.scope,
new Event('pointerdown'),
);
assert.equal(items.length, 3);
assert.isTrue('separator' in items[1]);
});
});
});

suite('Block Items', function () {
Expand Down Expand Up @@ -483,5 +566,88 @@ suite('Context Menu Items', function () {
assert.equal(this.inlineOption.preconditionFn(this.scope), 'enabled');
});
});

suite('Separators', function () {
setup(function () {
this.registry.reset();
this.registry.register({
weight: 0,
id: 'a',
preconditionFn: () => {},
displayText: 'a',
callback: () => {},
});
this.registry.register({
weight: 2,
id: 'b',
preconditionFn: () => {},
displayText: 'b',
callback: () => {},
});
});

test('are hidden when precondition returns hidden', function () {
this.registry.register({
weight: 1,
id: 'separator',
preconditionFn: () => 'hidden',
separator: true,
});

const items = this.registry.getContextMenuOptions(
this.scope,
new Event('pointerdown'),
);
assert.equal(items.length, 2);
assert.isTrue(items.every((item) => !('separator' in item)));
});

test('are included when precondition returns enabled', function () {
this.registry.register({
weight: 1,
id: 'separator',
preconditionFn: () => 'enabled',
separator: true,
});

const items = this.registry.getContextMenuOptions(
this.scope,
new Event('pointerdown'),
);
assert.equal(items.length, 3);
assert.isTrue('separator' in items[1]);
});

test('are included when precondition returns disabled', function () {
this.registry.register({
weight: 1,
id: 'separator',
preconditionFn: () => 'disabled',
separator: true,
});

const items = this.registry.getContextMenuOptions(
this.scope,
new Event('pointerdown'),
);
assert.equal(items.length, 3);
assert.isTrue('separator' in items[1]);
});

test('are included when there is no precondition', function () {
this.registry.register({
weight: 1,
id: 'separator',
separator: true,
});

const items = this.registry.getContextMenuOptions(
this.scope,
new Event('pointerdown'),
);
assert.equal(items.length, 3);
assert.isTrue('separator' in items[1]);
});
});
});
});
Loading