@dxos/react-ui-menu 0.8.4-main.f5c0578 → 0.8.4-main.fcc0d83b33
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lib/browser/index.mjs +537 -403
- package/dist/lib/browser/index.mjs.map +4 -4
- package/dist/lib/browser/meta.json +1 -1
- package/dist/lib/browser/translations.mjs +14 -0
- package/dist/lib/browser/translations.mjs.map +7 -0
- package/dist/lib/node-esm/index.mjs +537 -403
- package/dist/lib/node-esm/index.mjs.map +4 -4
- package/dist/lib/node-esm/meta.json +1 -1
- package/dist/lib/node-esm/translations.mjs +16 -0
- package/dist/lib/node-esm/translations.mjs.map +7 -0
- package/dist/types/src/builder.d.ts +28 -3
- package/dist/types/src/builder.d.ts.map +1 -1
- package/dist/types/src/builder.test.d.ts +2 -0
- package/dist/types/src/builder.test.d.ts.map +1 -0
- package/dist/types/src/components/ActionLabel.d.ts +3 -3
- package/dist/types/src/components/ActionLabel.d.ts.map +1 -1
- package/dist/types/src/components/DropdownMenu.d.ts +4 -2
- package/dist/types/src/components/DropdownMenu.d.ts.map +1 -1
- package/dist/types/src/components/Menu.d.ts +50 -0
- package/dist/types/src/components/Menu.d.ts.map +1 -0
- package/dist/types/src/components/Menu.stories.d.ts +21 -0
- package/dist/types/src/components/Menu.stories.d.ts.map +1 -0
- package/dist/types/src/components/Menu.test.d.ts +2 -0
- package/dist/types/src/components/Menu.test.d.ts.map +1 -0
- package/dist/types/src/components/ToolbarMenu.d.ts +7 -6
- package/dist/types/src/components/ToolbarMenu.d.ts.map +1 -1
- package/dist/types/src/components/ToolbarMenu.stories.d.ts +22 -0
- package/dist/types/src/components/ToolbarMenu.stories.d.ts.map +1 -0
- package/dist/types/src/components/index.d.ts +1 -3
- package/dist/types/src/components/index.d.ts.map +1 -1
- package/dist/types/src/hooks/useMenuActions.d.ts +8 -7
- package/dist/types/src/hooks/useMenuActions.d.ts.map +1 -1
- package/dist/types/src/index.d.ts +1 -2
- package/dist/types/src/index.d.ts.map +1 -1
- package/dist/types/src/testing/generator.d.ts +20 -14
- package/dist/types/src/testing/generator.d.ts.map +1 -1
- package/dist/types/src/translations.d.ts +2 -2
- package/dist/types/src/translations.d.ts.map +1 -1
- package/dist/types/src/types.d.ts +38 -27
- package/dist/types/src/types.d.ts.map +1 -1
- package/dist/types/src/util.d.ts +14 -5
- package/dist/types/src/util.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +44 -32
- package/src/builder.test.ts +224 -0
- package/src/builder.ts +76 -26
- package/src/components/ActionLabel.tsx +7 -6
- package/src/components/DropdownMenu.tsx +12 -6
- package/src/components/Menu.stories.tsx +266 -0
- package/src/components/Menu.test.tsx +447 -0
- package/src/components/Menu.tsx +348 -0
- package/src/components/ToolbarMenu.stories.tsx +83 -0
- package/src/components/ToolbarMenu.tsx +155 -96
- package/src/components/index.ts +1 -3
- package/src/hooks/useMenuActions.ts +30 -53
- package/src/index.ts +1 -3
- package/src/testing/generator.ts +74 -64
- package/src/translations.ts +1 -1
- package/src/types.ts +39 -27
- package/src/util.ts +34 -15
- package/dist/types/src/components/MenuContext.d.ts +0 -13
- package/dist/types/src/components/MenuContext.d.ts.map +0 -1
- package/dist/types/src/components/Menus.stories.d.ts +0 -25
- package/dist/types/src/components/Menus.stories.d.ts.map +0 -1
- package/src/components/MenuContext.tsx +0 -50
- package/src/components/Menus.stories.tsx +0 -69
|
@@ -0,0 +1,266 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2025 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import { Atom } from '@effect-atom/atom-react';
|
|
6
|
+
import { type Meta, type StoryObj } from '@storybook/react-vite';
|
|
7
|
+
import React, { useEffect, useMemo, useState } from 'react';
|
|
8
|
+
import { expect, userEvent, within } from 'storybook/test';
|
|
9
|
+
|
|
10
|
+
import { Button, IconButton } from '@dxos/react-ui';
|
|
11
|
+
import { withTheme } from '@dxos/react-ui/testing';
|
|
12
|
+
import { withRegistry } from '@dxos/storybook-utils';
|
|
13
|
+
|
|
14
|
+
import { translations } from '#translations';
|
|
15
|
+
|
|
16
|
+
import { Menu, useMenu } from '../components';
|
|
17
|
+
import { type ActionGraphProps, useMenuActions } from '../hooks';
|
|
18
|
+
import { createActions } from '../testing';
|
|
19
|
+
import { type MenuItem } from '../types';
|
|
20
|
+
import { createMenuAction } from '../util';
|
|
21
|
+
|
|
22
|
+
const STORY_NAME = 'StoryMenuItems';
|
|
23
|
+
|
|
24
|
+
const meta = {
|
|
25
|
+
title: 'ui/react-ui-menu/MenuItems',
|
|
26
|
+
component: Menu.Root,
|
|
27
|
+
decorators: [withTheme(), withRegistry],
|
|
28
|
+
parameters: {
|
|
29
|
+
translations,
|
|
30
|
+
},
|
|
31
|
+
} satisfies Meta<typeof Menu.Root>;
|
|
32
|
+
|
|
33
|
+
export default meta;
|
|
34
|
+
|
|
35
|
+
type Story = StoryObj<typeof meta>;
|
|
36
|
+
|
|
37
|
+
const createBaseActionsAtom = (count = 3) => {
|
|
38
|
+
const actions = createActions({ count });
|
|
39
|
+
return Atom.make<ActionGraphProps>({
|
|
40
|
+
nodes: actions,
|
|
41
|
+
edges: actions.map((action) => ({ source: 'root', target: action.id, relation: 'child' })),
|
|
42
|
+
}).pipe(Atom.keepAlive);
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
const openDropdown = async (canvasElement: HTMLElement) => {
|
|
46
|
+
const canvas = within(canvasElement);
|
|
47
|
+
const trigger = canvas.getByRole('button', { name: /options/i });
|
|
48
|
+
await userEvent.click(trigger);
|
|
49
|
+
const body = within(document.body);
|
|
50
|
+
return body;
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
const StaticItemsProvider = () => {
|
|
54
|
+
const menu = useMenu(STORY_NAME);
|
|
55
|
+
const items: MenuItem[] = useMemo(
|
|
56
|
+
() => [
|
|
57
|
+
createMenuAction('static-1', () => {}, {
|
|
58
|
+
label: 'Static Action 1',
|
|
59
|
+
icon: 'ph--star--regular',
|
|
60
|
+
}),
|
|
61
|
+
createMenuAction('static-2', () => {}, {
|
|
62
|
+
label: 'Static Action 2',
|
|
63
|
+
icon: 'ph--heart--regular',
|
|
64
|
+
}),
|
|
65
|
+
],
|
|
66
|
+
[],
|
|
67
|
+
);
|
|
68
|
+
|
|
69
|
+
useEffect(() => {
|
|
70
|
+
menu.addMenuItems({ id: 'static-items', mode: 'additive', items });
|
|
71
|
+
return () => menu.removeMenuItems('static-items');
|
|
72
|
+
}, [menu, items]);
|
|
73
|
+
|
|
74
|
+
return null;
|
|
75
|
+
};
|
|
76
|
+
|
|
77
|
+
export const StaticItems: Story = {
|
|
78
|
+
render: () => {
|
|
79
|
+
const actionsAtom = useMemo(() => createBaseActionsAtom(2), []);
|
|
80
|
+
const menuActions = useMenuActions(actionsAtom);
|
|
81
|
+
|
|
82
|
+
return (
|
|
83
|
+
<Menu.Root {...menuActions}>
|
|
84
|
+
<StaticItemsProvider />
|
|
85
|
+
<Menu.Trigger asChild>
|
|
86
|
+
<IconButton icon='ph--list-checks--regular' label='Options' />
|
|
87
|
+
</Menu.Trigger>
|
|
88
|
+
<Menu.Content />
|
|
89
|
+
</Menu.Root>
|
|
90
|
+
);
|
|
91
|
+
},
|
|
92
|
+
play: async ({ canvasElement }) => {
|
|
93
|
+
const body = await openDropdown(canvasElement);
|
|
94
|
+
const items = await body.findAllByRole('menuitem');
|
|
95
|
+
const labels = items.map((el) => el.textContent);
|
|
96
|
+
await expect(labels).toContain('Static Action 1');
|
|
97
|
+
await expect(labels).toContain('Static Action 2');
|
|
98
|
+
},
|
|
99
|
+
};
|
|
100
|
+
|
|
101
|
+
const ReactiveItemsProvider = ({ items }: { items: MenuItem[] }) => {
|
|
102
|
+
const menu = useMenu(STORY_NAME);
|
|
103
|
+
|
|
104
|
+
useEffect(() => {
|
|
105
|
+
menu.addMenuItems({ id: 'reactive-items', mode: 'additive', priority: 50, items });
|
|
106
|
+
return () => menu.removeMenuItems('reactive-items');
|
|
107
|
+
}, [menu, items]);
|
|
108
|
+
|
|
109
|
+
return null;
|
|
110
|
+
};
|
|
111
|
+
|
|
112
|
+
export const ReactiveItems: Story = {
|
|
113
|
+
render: () => {
|
|
114
|
+
const actionsAtom = useMemo(() => createBaseActionsAtom(2), []);
|
|
115
|
+
const [count, setCount] = useState(1);
|
|
116
|
+
const reactiveItems: MenuItem[] = useMemo(
|
|
117
|
+
() => [
|
|
118
|
+
createMenuAction('reactive-1', () => {}, {
|
|
119
|
+
label: `Reactive Action (${count})`,
|
|
120
|
+
icon: 'ph--lightning--regular',
|
|
121
|
+
}),
|
|
122
|
+
],
|
|
123
|
+
[count],
|
|
124
|
+
);
|
|
125
|
+
|
|
126
|
+
const menuActions = useMenuActions(actionsAtom);
|
|
127
|
+
|
|
128
|
+
return (
|
|
129
|
+
<div className='flex flex-col gap-4'>
|
|
130
|
+
<Menu.Root {...menuActions}>
|
|
131
|
+
<ReactiveItemsProvider items={reactiveItems} />
|
|
132
|
+
<Menu.Trigger asChild>
|
|
133
|
+
<IconButton icon='ph--list-checks--regular' label='Options' />
|
|
134
|
+
</Menu.Trigger>
|
|
135
|
+
<Menu.Content />
|
|
136
|
+
</Menu.Root>
|
|
137
|
+
<Button data-testid='update-button' onClick={() => setCount((prev) => prev + 1)}>
|
|
138
|
+
Update Reactive Item ({count})
|
|
139
|
+
</Button>
|
|
140
|
+
</div>
|
|
141
|
+
);
|
|
142
|
+
},
|
|
143
|
+
play: async ({ canvasElement }) => {
|
|
144
|
+
const canvas = within(canvasElement);
|
|
145
|
+
|
|
146
|
+
const body = await openDropdown(canvasElement);
|
|
147
|
+
const items = await body.findAllByRole('menuitem');
|
|
148
|
+
await expect(items.map((el) => el.textContent)).toContain('Reactive Action (1)');
|
|
149
|
+
|
|
150
|
+
await userEvent.keyboard('{Escape}');
|
|
151
|
+
const updateButton = canvas.getByTestId('update-button');
|
|
152
|
+
await userEvent.click(updateButton);
|
|
153
|
+
|
|
154
|
+
const body2 = await openDropdown(canvasElement);
|
|
155
|
+
const updatedItems = await body2.findAllByRole('menuitem');
|
|
156
|
+
await expect(updatedItems.map((el) => el.textContent)).toContain('Reactive Action (2)');
|
|
157
|
+
},
|
|
158
|
+
};
|
|
159
|
+
|
|
160
|
+
const ReplacementItemsProvider = () => {
|
|
161
|
+
const menu = useMenu(STORY_NAME);
|
|
162
|
+
const items: MenuItem[] = useMemo(
|
|
163
|
+
() => [
|
|
164
|
+
createMenuAction('replacement-1', () => {}, {
|
|
165
|
+
label: 'Replacement Only',
|
|
166
|
+
icon: 'ph--swap--regular',
|
|
167
|
+
}),
|
|
168
|
+
],
|
|
169
|
+
[],
|
|
170
|
+
);
|
|
171
|
+
|
|
172
|
+
useEffect(() => {
|
|
173
|
+
menu.addMenuItems({ id: 'replacement-items', mode: 'replacement', items });
|
|
174
|
+
return () => menu.removeMenuItems('replacement-items');
|
|
175
|
+
}, [menu, items]);
|
|
176
|
+
|
|
177
|
+
return null;
|
|
178
|
+
};
|
|
179
|
+
|
|
180
|
+
export const ReplacementMode: Story = {
|
|
181
|
+
render: () => {
|
|
182
|
+
const actionsAtom = useMemo(() => createBaseActionsAtom(5), []);
|
|
183
|
+
const menuActions = useMenuActions(actionsAtom);
|
|
184
|
+
|
|
185
|
+
return (
|
|
186
|
+
<Menu.Root {...menuActions}>
|
|
187
|
+
<ReplacementItemsProvider />
|
|
188
|
+
<Menu.Trigger asChild>
|
|
189
|
+
<IconButton icon='ph--list-checks--regular' label='Options (replaced)' />
|
|
190
|
+
</Menu.Trigger>
|
|
191
|
+
<Menu.Content />
|
|
192
|
+
</Menu.Root>
|
|
193
|
+
);
|
|
194
|
+
},
|
|
195
|
+
play: async ({ canvasElement }) => {
|
|
196
|
+
const body = await openDropdown(canvasElement);
|
|
197
|
+
const items = await body.findAllByRole('menuitem');
|
|
198
|
+
await expect(items).toHaveLength(1);
|
|
199
|
+
await expect(items[0].textContent).toBe('Replacement Only');
|
|
200
|
+
},
|
|
201
|
+
};
|
|
202
|
+
|
|
203
|
+
const LowPriorityItemsProvider = () => {
|
|
204
|
+
const menu = useMenu(STORY_NAME);
|
|
205
|
+
const items: MenuItem[] = useMemo(
|
|
206
|
+
() => [
|
|
207
|
+
createMenuAction('low-priority', () => {}, {
|
|
208
|
+
label: 'Low Priority (150)',
|
|
209
|
+
icon: 'ph--arrow-down--regular',
|
|
210
|
+
}),
|
|
211
|
+
],
|
|
212
|
+
[],
|
|
213
|
+
);
|
|
214
|
+
|
|
215
|
+
useEffect(() => {
|
|
216
|
+
menu.addMenuItems({ id: 'low-priority-items', mode: 'additive', items, priority: 150 });
|
|
217
|
+
return () => menu.removeMenuItems('low-priority-items');
|
|
218
|
+
}, [menu, items]);
|
|
219
|
+
|
|
220
|
+
return null;
|
|
221
|
+
};
|
|
222
|
+
|
|
223
|
+
const HighPriorityItemsProvider = () => {
|
|
224
|
+
const menu = useMenu(STORY_NAME);
|
|
225
|
+
const items: MenuItem[] = useMemo(
|
|
226
|
+
() => [
|
|
227
|
+
createMenuAction('high-priority', () => {}, {
|
|
228
|
+
label: 'High Priority (50)',
|
|
229
|
+
icon: 'ph--arrow-up--regular',
|
|
230
|
+
}),
|
|
231
|
+
],
|
|
232
|
+
[],
|
|
233
|
+
);
|
|
234
|
+
|
|
235
|
+
useEffect(() => {
|
|
236
|
+
menu.addMenuItems({ id: 'high-priority-items', mode: 'additive', items, priority: 50 });
|
|
237
|
+
return () => menu.removeMenuItems('high-priority-items');
|
|
238
|
+
}, [menu, items]);
|
|
239
|
+
|
|
240
|
+
return null;
|
|
241
|
+
};
|
|
242
|
+
|
|
243
|
+
export const PriorityOrdering: Story = {
|
|
244
|
+
render: () => {
|
|
245
|
+
const actionsAtom = useMemo(() => createBaseActionsAtom(0), []);
|
|
246
|
+
const menuActions = useMenuActions(actionsAtom);
|
|
247
|
+
|
|
248
|
+
return (
|
|
249
|
+
<Menu.Root {...menuActions}>
|
|
250
|
+
<LowPriorityItemsProvider />
|
|
251
|
+
<HighPriorityItemsProvider />
|
|
252
|
+
<Menu.Trigger asChild>
|
|
253
|
+
<IconButton icon='ph--list-checks--regular' label='Options (priority ordered)' />
|
|
254
|
+
</Menu.Trigger>
|
|
255
|
+
<Menu.Content />
|
|
256
|
+
</Menu.Root>
|
|
257
|
+
);
|
|
258
|
+
},
|
|
259
|
+
play: async ({ canvasElement }) => {
|
|
260
|
+
const body = await openDropdown(canvasElement);
|
|
261
|
+
const items = await body.findAllByRole('menuitem');
|
|
262
|
+
await expect(items).toHaveLength(2);
|
|
263
|
+
await expect(items[0].textContent).toBe('High Priority (50)');
|
|
264
|
+
await expect(items[1].textContent).toBe('Low Priority (150)');
|
|
265
|
+
},
|
|
266
|
+
};
|