Introduce menu entry support
Summary:
[interesting] since it shows how Flipper APIs are exposed through sandy. However, the next diff is a much simpler example of that
This diff adds support for adding menu entries for sandy plugin (renamed keyboard actions to menus, as it always creates a menu entry, but not necessarily a keyboard shortcut)
```
client.addMenuEntry(
// custom entry
{
label: 'Reset Selection',
topLevelMenu: 'Edit',
handler: () => {
selectedID.set(null);
},
},
// based on built-in action (sets standard label, shortcut)
{
action: 'createPaste',
handler: () => {
console.log('creating paste');
},
},
);
```
Most of this diff is introducing the concept of FlipperUtils, a set of static Flipper methods (not related to a device or client) that can be used from Sandy. This will for example be used to implement things as `createPaste` as well
Reviewed By: nikoant
Differential Revision: D22766990
fbshipit-source-id: ce90af3b700e6c3d9a779a3bab4673ba356f3933
This commit is contained in:
committed by
Facebook GitHub Bot
parent
94eaaf5dca
commit
9c202a4a10
@@ -286,3 +286,45 @@ test('device plugins can receive deeplinks', async () => {
|
||||
plugin.triggerDeepLink('test');
|
||||
expect(plugin.instance.field1.get()).toBe('test');
|
||||
});
|
||||
|
||||
test('plugins can register menu entries', async () => {
|
||||
const plugin = TestUtils.startPlugin({
|
||||
plugin(client: PluginClient) {
|
||||
const counter = createState(0);
|
||||
client.addMenuEntry(
|
||||
{
|
||||
action: 'createPaste',
|
||||
handler() {
|
||||
counter.set(counter.get() + 1);
|
||||
},
|
||||
},
|
||||
{
|
||||
label: 'Custom Action',
|
||||
topLevelMenu: 'Edit',
|
||||
handler() {
|
||||
counter.set(counter.get() + 3);
|
||||
},
|
||||
},
|
||||
);
|
||||
return {counter};
|
||||
},
|
||||
Component() {
|
||||
return null;
|
||||
},
|
||||
});
|
||||
|
||||
expect(plugin.instance.counter.get()).toBe(0);
|
||||
plugin.triggerDeepLink('test');
|
||||
plugin.triggerMenuEntry('createPaste');
|
||||
plugin.triggerMenuEntry('Custom Action');
|
||||
expect(plugin.instance.counter.get()).toBe(4);
|
||||
expect(plugin.flipperLib.enableMenuEntries).toBeCalledTimes(1);
|
||||
|
||||
plugin.deactivate();
|
||||
|
||||
expect(() => {
|
||||
plugin.triggerMenuEntry('Non Existing');
|
||||
}).toThrowErrorMatchingInlineSnapshot(
|
||||
`"No menu entry found with action: Non Existing"`,
|
||||
);
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user