Skip to content

fix: 🐛 don't add separator before group on no main items #83166

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
streamich merged 3 commits into from
Dec 3, 2020
Merged

fix: 🐛 don't add separator before group on no main items #83166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c9de585
fix: 🐛 don't add separator befor group on no main items
streamich Nov 11, 2020
9eea930
Merge branch 'master' into fix-first-group-sep
kibanamachine Nov 20, 2020
83e9ad1
Merge branch 'master' into fix-first-group-sep
kibanamachine Dec 3, 2020
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
202 changes: 201 additions & 1 deletion src/plugins/ui_actions/public/context_menu/build_eui_context_menu_panels.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,31 @@
import { EuiContextMenuPanelDescriptor } from '@elastic/eui';
import { buildContextMenuForActions } from './build_eui_context_menu_panels';
import { Action, createAction } from '../actions';
import { PresentableGrouping } from '../util';

const createTestAction = ({
type,
dispayName,
order,
grouping = undefined,
}: {
type?: string;
dispayName: string;
order?: number;
grouping?: PresentableGrouping;
}) =>
createAction({
type: type as any, // mapping doesn't matter for this test
getDisplayName: () => dispayName,
order,
execute: async () => {},
grouping,
});

const resultMapper = (panel: EuiContextMenuPanelDescriptor) => ({
items: panel.items ? panel.items.map((item) => ({ name: item.name })) : [],
items: panel.items
? panel.items.map((item) => ({ name: item.isSeparator ? 'SEPARATOR' : item.name }))
: [],
});

test('sorts items in DESC order by "order" field first, then by display name', async () => {
Expand Down Expand Up @@ -237,3 +243,197 @@ test('hides items behind in "More" submenu if there are more than 4 actions', as
]
`);
});

test('separates grouped items from main items with a separator', async () => {
const actions = [
createTestAction({
dispayName: 'Foo 1',
}),
createTestAction({
dispayName: 'Foo 2',
}),
createTestAction({
dispayName: 'Foo 3',
}),
createTestAction({
dispayName: 'Foo 4',
grouping: [
{
id: 'testGroup',
getDisplayName: () => 'Test group',
},
],
}),
];
const menu = await buildContextMenuForActions({
actions: actions.map((action) => ({ action, context: {}, trigger: 'TEST' as any })),
});

expect(menu.map(resultMapper)).toMatchInlineSnapshot(`
Array [
Object {
"items": Array [
Object {
"name": "Foo 1",
},
Object {
"name": "Foo 2",
},
Object {
"name": "Foo 3",
},
Object {
"name": "SEPARATOR",
},
Object {
"name": "Foo 4",
},
],
},
Object {
"items": Array [
Object {
"name": "Foo 4",
},
],
},
]
`);
});

test('separates multiple groups each with its own separator', async () => {
const actions = [
createTestAction({
dispayName: 'Foo 1',
}),
createTestAction({
dispayName: 'Foo 2',
}),
createTestAction({
dispayName: 'Foo 3',
}),
createTestAction({
dispayName: 'Foo 4',
grouping: [
{
id: 'testGroup',
getDisplayName: () => 'Test group',
},
],
}),
createTestAction({
dispayName: 'Foo 5',
grouping: [
{
id: 'testGroup2',
getDisplayName: () => 'Test group 2',
},
],
}),
];
const menu = await buildContextMenuForActions({
actions: actions.map((action) => ({ action, context: {}, trigger: 'TEST' as any })),
});

expect(menu.map(resultMapper)).toMatchInlineSnapshot(`
Array [
Object {
"items": Array [
Object {
"name": "Foo 1",
},
Object {
"name": "Foo 2",
},
Object {
"name": "Foo 3",
},
Object {
"name": "SEPARATOR",
},
Object {
"name": "Foo 4",
},
Object {
"name": "SEPARATOR",
},
Object {
"name": "Foo 5",
},
],
},
Object {
"items": Array [
Object {
"name": "Foo 4",
},
],
},
Object {
"items": Array [
Object {
"name": "Foo 5",
},
],
},
]
`);
});

test('does not add separator for first grouping if there are no main items', async () => {
const actions = [
createTestAction({
dispayName: 'Foo 4',
grouping: [
{
id: 'testGroup',
getDisplayName: () => 'Test group',
},
],
}),
createTestAction({
dispayName: 'Foo 5',
grouping: [
{
id: 'testGroup2',
getDisplayName: () => 'Test group 2',
},
],
}),
];
const menu = await buildContextMenuForActions({
actions: actions.map((action) => ({ action, context: {}, trigger: 'TEST' as any })),
});

expect(menu.map(resultMapper)).toMatchInlineSnapshot(`
Array [
Object {
"items": Array [
Object {
"name": "Foo 4",
},
Object {
"name": "SEPARATOR",
},
Object {
"name": "Foo 5",
},
],
},
Object {
"items": Array [
Object {
"name": "Foo 4",
},
],
},
Object {
"items": Array [
Object {
"name": "Foo 5",
},
],
},
]
`);
});
10 changes: 6 additions & 4 deletions src/plugins/ui_actions/public/context_menu/build_eui_context_menu_panels.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,10 +201,12 @@ export async function buildContextMenuForActions({

for (const panel of Object.values(panels)) {
if (panel._level === 0) {
panels.mainMenu.items.push({
isSeparator: true,
key: panel.id + '__separator',
});
if (panels.mainMenu.items.length > 0) {
panels.mainMenu.items.push({
isSeparator: true,
key: panel.id + '__separator',
});
}
if (panel.items.length > 3) {
panels.mainMenu.items.push({
name: panel.title || panel.id,
Expand Down