@macrulez/vue-command-palette 0.1.0

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.
Files changed (20) hide show
  1. package/README.md +1014 -0
  2. package/dist/components/CommandGroup.vue.d.ts +53 -0
  3. package/dist/components/CommandItem.vue.d.ts +50 -0
  4. package/dist/components/CommandPalette.vue.d.ts +97 -0
  5. package/dist/components/VirtualList.vue.d.ts +26 -0
  6. package/dist/core/CommandStore.d.ts +284 -0
  7. package/dist/core/FuzzySearch.d.ts +5 -0
  8. package/dist/core/FuzzySearch.test.d.ts +1 -0
  9. package/dist/core/KeyboardManager.d.ts +8 -0
  10. package/dist/core/KeyboardManager.test.d.ts +1 -0
  11. package/dist/core/useCommandPalette.d.ts +57 -0
  12. package/dist/index.d.ts +13 -0
  13. package/dist/nuxt.d.ts +2 -0
  14. package/dist/plugin.d.ts +6 -0
  15. package/dist/style.css +1 -0
  16. package/dist/testing.d.ts +335 -0
  17. package/dist/types.d.ts +57 -0
  18. package/dist/vue-command-palette.js +1035 -0
  19. package/dist/vue-command-palette.umd.cjs +1 -0
  20. package/package.json +75 -0
package/dist/testing.d.ts ADDED
@@ -0,0 +1,335 @@
1
+ import { Command, CommandGroup, PaletteOptions } from './types';
2
+ import { PaletteContext } from './core/useCommandPalette';
3
+
4
+ export interface PaletteTestOptions extends PaletteOptions {
5
+ commands?: Command[];
6
+ groups?: CommandGroup[];
7
+ }
8
+ /**
9
+ * Creates a palette context for use in unit tests.
10
+ * Pass `provide` to Vue Test Utils `mount({ global: { provide } })`.
11
+ *
12
+ * @example
13
+ * const { provide } = createPaletteContext({ commands: [myCmd] })
14
+ * const wrapper = mount(MyComponent, { global: { provide } })
15
+ */
16
+ export declare function createPaletteContext(options?: PaletteTestOptions): {
17
+ ctx: PaletteContext;
18
+ store: {
19
+ state: {
20
+ groups: Map<string, {
21
+ id: string;
22
+ label: string;
23
+ priority?: number | undefined;
24
+ commands: {
25
+ id: string;
26
+ label: string;
27
+ description?: string | undefined;
28
+ group?: string | undefined;
29
+ keywords?: string[] | undefined;
30
+ aliases?: string[] | undefined;
31
+ icon?: string | import('vue').FunctionalComponent<any, {}, any, {}> | {
32
+ new (...args: any[]): any;
33
+ __isFragment?: never;
34
+ __isTeleport?: never;
35
+ __isSuspense?: never;
36
+ } | {
37
+ [x: string]: any;
38
+ setup?: ((this: void, props: import('@vue/shared').LooseRequired<any>, ctx: {
39
+ attrs: import('vue').Attrs;
40
+ slots: Readonly<{
41
+ [name: string]: import('vue').Slot<any> | undefined;
42
+ }>;
43
+ emit: ((event: unknown, ...args: any[]) => void) | ((event: string, ...args: any[]) => void);
44
+ expose: <Exposed extends Record<string, any> = Record<string, any>>(exposed?: Exposed) => void;
45
+ }) => any) | undefined;
46
+ name?: string | undefined;
47
+ template?: string | object | undefined;
48
+ render?: Function | undefined;
49
+ components?: Record<string, import('vue').Component<any, any, any, import('vue').ComputedOptions, import('vue').MethodOptions, {}, any>> | undefined;
50
+ directives?: Record<string, import('vue').Directive<any, any, string, any>> | undefined;
51
+ inheritAttrs?: boolean | undefined;
52
+ emits?: any;
53
+ slots?: {} | undefined;
54
+ expose?: string[] | undefined;
55
+ serverPrefetch?: (() => void | Promise<any>) | undefined;
56
+ compilerOptions?: {
57
+ isCustomElement?: ((tag: string) => boolean) | undefined;
58
+ whitespace?: "preserve" | "condense" | undefined;
59
+ comments?: boolean | undefined;
60
+ delimiters?: [string, string] | undefined;
61
+ } | undefined;
62
+ call?: ((this: unknown, ...args: unknown[]) => never) | undefined;
63
+ __isFragment?: never | undefined;
64
+ __isTeleport?: never | undefined;
65
+ __isSuspense?: never | undefined;
66
+ __defaults?: {} | undefined;
67
+ compatConfig?: {
68
+ GLOBAL_MOUNT?: boolean | "suppress-warning" | undefined;
69
+ GLOBAL_MOUNT_CONTAINER?: boolean | "suppress-warning" | undefined;
70
+ GLOBAL_EXTEND?: boolean | "suppress-warning" | undefined;
71
+ GLOBAL_PROTOTYPE?: boolean | "suppress-warning" | undefined;
72
+ GLOBAL_SET?: boolean | "suppress-warning" | undefined;
73
+ GLOBAL_DELETE?: boolean | "suppress-warning" | undefined;
74
+ GLOBAL_OBSERVABLE?: boolean | "suppress-warning" | undefined;
75
+ GLOBAL_PRIVATE_UTIL?: boolean | "suppress-warning" | undefined;
76
+ CONFIG_SILENT?: boolean | "suppress-warning" | undefined;
77
+ CONFIG_DEVTOOLS?: boolean | "suppress-warning" | undefined;
78
+ CONFIG_KEY_CODES?: boolean | "suppress-warning" | undefined;
79
+ CONFIG_PRODUCTION_TIP?: boolean | "suppress-warning" | undefined;
80
+ CONFIG_IGNORED_ELEMENTS?: boolean | "suppress-warning" | undefined;
81
+ CONFIG_WHITESPACE?: boolean | "suppress-warning" | undefined;
82
+ CONFIG_OPTION_MERGE_STRATS?: boolean | "suppress-warning" | undefined;
83
+ INSTANCE_SET?: boolean | "suppress-warning" | undefined;
84
+ INSTANCE_DELETE?: boolean | "suppress-warning" | undefined;
85
+ INSTANCE_DESTROY?: boolean | "suppress-warning" | undefined;
86
+ INSTANCE_EVENT_EMITTER?: boolean | "suppress-warning" | undefined;
87
+ INSTANCE_EVENT_HOOKS?: boolean | "suppress-warning" | undefined;
88
+ INSTANCE_CHILDREN?: boolean | "suppress-warning" | undefined;
89
+ INSTANCE_LISTENERS?: boolean | "suppress-warning" | undefined;
90
+ INSTANCE_SCOPED_SLOTS?: boolean | "suppress-warning" | undefined;
91
+ INSTANCE_ATTRS_CLASS_STYLE?: boolean | "suppress-warning" | undefined;
92
+ OPTIONS_DATA_FN?: boolean | "suppress-warning" | undefined;
93
+ OPTIONS_DATA_MERGE?: boolean | "suppress-warning" | undefined;
94
+ OPTIONS_BEFORE_DESTROY?: boolean | "suppress-warning" | undefined;
95
+ OPTIONS_DESTROYED?: boolean | "suppress-warning" | undefined;
96
+ WATCH_ARRAY?: boolean | "suppress-warning" | undefined;
97
+ PROPS_DEFAULT_THIS?: boolean | "suppress-warning" | undefined;
98
+ V_ON_KEYCODE_MODIFIER?: boolean | "suppress-warning" | undefined;
99
+ CUSTOM_DIR?: boolean | "suppress-warning" | undefined;
100
+ ATTR_FALSE_VALUE?: boolean | "suppress-warning" | undefined;
101
+ ATTR_ENUMERATED_COERCION?: boolean | "suppress-warning" | undefined;
102
+ TRANSITION_CLASSES?: boolean | "suppress-warning" | undefined;
103
+ TRANSITION_GROUP_ROOT?: boolean | "suppress-warning" | undefined;
104
+ COMPONENT_ASYNC?: boolean | "suppress-warning" | undefined;
105
+ COMPONENT_FUNCTIONAL?: boolean | "suppress-warning" | undefined;
106
+ COMPONENT_V_MODEL?: boolean | "suppress-warning" | undefined;
107
+ RENDER_FUNCTION?: boolean | "suppress-warning" | undefined;
108
+ FILTERS?: boolean | "suppress-warning" | undefined;
109
+ PRIVATE_APIS?: boolean | "suppress-warning" | undefined;
110
+ MODE?: 2 | 3 | ((comp: import('vue').Component | null) => 2 | 3) | undefined;
111
+ } | undefined;
112
+ data?: ((this: any, vm: any) => any) | undefined;
113
+ computed?: import('vue').ComputedOptions | undefined;
114
+ methods?: import('vue').MethodOptions | undefined;
115
+ watch?: {
116
+ [x: string]: (string | import('vue').WatchCallback | ({
117
+ handler: import('vue').WatchCallback | string;
118
+ } & import('vue').WatchOptions<boolean>)) | (string | import('vue').WatchCallback | ({
119
+ handler: import('vue').WatchCallback | string;
120
+ } & import('vue').WatchOptions<boolean>))[];
121
+ } | undefined;
122
+ provide?: import('vue').ComponentProvideOptions | undefined;
123
+ inject?: {} | string[] | undefined;
124
+ filters?: Record<string, Function> | undefined;
125
+ mixins?: any[] | undefined;
126
+ extends?: any;
127
+ beforeCreate?: (() => any) | undefined;
128
+ created?: (() => any) | undefined;
129
+ beforeMount?: (() => any) | undefined;
130
+ mounted?: (() => any) | undefined;
131
+ beforeUpdate?: (() => any) | undefined;
132
+ updated?: (() => any) | undefined;
133
+ activated?: (() => any) | undefined;
134
+ deactivated?: (() => any) | undefined;
135
+ beforeDestroy?: (() => any) | undefined;
136
+ beforeUnmount?: (() => any) | undefined;
137
+ destroyed?: (() => any) | undefined;
138
+ unmounted?: (() => any) | undefined;
139
+ renderTracked?: ((e: import('vue').DebuggerEvent) => void) | undefined;
140
+ renderTriggered?: ((e: import('vue').DebuggerEvent) => void) | undefined;
141
+ errorCaptured?: ((err: unknown, instance: import('vue').ComponentPublicInstance | null, info: string) => boolean | void) | undefined;
142
+ delimiters?: [string, string] | undefined;
143
+ __differentiator?: string | number | symbol | undefined;
144
+ __isBuiltIn?: boolean | undefined;
145
+ __file?: string | undefined;
146
+ __name?: string | undefined;
147
+ } | undefined;
148
+ shortcut?: string[] | undefined;
149
+ disabled?: boolean | undefined;
150
+ enabled?: (() => boolean) | undefined;
151
+ confirm?: string | undefined;
152
+ perform: () => void | Promise<void>;
153
+ subCommands?: /*elided*/ any[] | undefined;
154
+ }[];
155
+ onSearch?: ((query: string) => Promise<Command[]>) | undefined;
156
+ }> & Omit<Map<string, CommandGroup>, keyof Map<any, any>>;
157
+ commands: Map<string, {
158
+ id: string;
159
+ label: string;
160
+ description?: string | undefined;
161
+ group?: string | undefined;
162
+ keywords?: string[] | undefined;
163
+ aliases?: string[] | undefined;
164
+ icon?: string | import('vue').FunctionalComponent<any, {}, any, {}> | {
165
+ new (...args: any[]): any;
166
+ __isFragment?: never;
167
+ __isTeleport?: never;
168
+ __isSuspense?: never;
169
+ } | {
170
+ [x: string]: any;
171
+ setup?: ((this: void, props: import('@vue/shared').LooseRequired<any>, ctx: {
172
+ attrs: import('vue').Attrs;
173
+ slots: Readonly<{
174
+ [name: string]: import('vue').Slot<any> | undefined;
175
+ }>;
176
+ emit: ((event: unknown, ...args: any[]) => void) | ((event: string, ...args: any[]) => void);
177
+ expose: <Exposed extends Record<string, any> = Record<string, any>>(exposed?: Exposed) => void;
178
+ }) => any) | undefined;
179
+ name?: string | undefined;
180
+ template?: string | object | undefined;
181
+ render?: Function | undefined;
182
+ components?: Record<string, import('vue').Component<any, any, any, import('vue').ComputedOptions, import('vue').MethodOptions, {}, any>> | undefined;
183
+ directives?: Record<string, import('vue').Directive<any, any, string, any>> | undefined;
184
+ inheritAttrs?: boolean | undefined;
185
+ emits?: any;
186
+ slots?: {} | undefined;
187
+ expose?: string[] | undefined;
188
+ serverPrefetch?: (() => void | Promise<any>) | undefined;
189
+ compilerOptions?: {
190
+ isCustomElement?: ((tag: string) => boolean) | undefined;
191
+ whitespace?: "preserve" | "condense" | undefined;
192
+ comments?: boolean | undefined;
193
+ delimiters?: [string, string] | undefined;
194
+ } | undefined;
195
+ call?: ((this: unknown, ...args: unknown[]) => never) | undefined;
196
+ __isFragment?: never | undefined;
197
+ __isTeleport?: never | undefined;
198
+ __isSuspense?: never | undefined;
199
+ __defaults?: {} | undefined;
200
+ compatConfig?: {
201
+ GLOBAL_MOUNT?: boolean | "suppress-warning" | undefined;
202
+ GLOBAL_MOUNT_CONTAINER?: boolean | "suppress-warning" | undefined;
203
+ GLOBAL_EXTEND?: boolean | "suppress-warning" | undefined;
204
+ GLOBAL_PROTOTYPE?: boolean | "suppress-warning" | undefined;
205
+ GLOBAL_SET?: boolean | "suppress-warning" | undefined;
206
+ GLOBAL_DELETE?: boolean | "suppress-warning" | undefined;
207
+ GLOBAL_OBSERVABLE?: boolean | "suppress-warning" | undefined;
208
+ GLOBAL_PRIVATE_UTIL?: boolean | "suppress-warning" | undefined;
209
+ CONFIG_SILENT?: boolean | "suppress-warning" | undefined;
210
+ CONFIG_DEVTOOLS?: boolean | "suppress-warning" | undefined;
211
+ CONFIG_KEY_CODES?: boolean | "suppress-warning" | undefined;
212
+ CONFIG_PRODUCTION_TIP?: boolean | "suppress-warning" | undefined;
213
+ CONFIG_IGNORED_ELEMENTS?: boolean | "suppress-warning" | undefined;
214
+ CONFIG_WHITESPACE?: boolean | "suppress-warning" | undefined;
215
+ CONFIG_OPTION_MERGE_STRATS?: boolean | "suppress-warning" | undefined;
216
+ INSTANCE_SET?: boolean | "suppress-warning" | undefined;
217
+ INSTANCE_DELETE?: boolean | "suppress-warning" | undefined;
218
+ INSTANCE_DESTROY?: boolean | "suppress-warning" | undefined;
219
+ INSTANCE_EVENT_EMITTER?: boolean | "suppress-warning" | undefined;
220
+ INSTANCE_EVENT_HOOKS?: boolean | "suppress-warning" | undefined;
221
+ INSTANCE_CHILDREN?: boolean | "suppress-warning" | undefined;
222
+ INSTANCE_LISTENERS?: boolean | "suppress-warning" | undefined;
223
+ INSTANCE_SCOPED_SLOTS?: boolean | "suppress-warning" | undefined;
224
+ INSTANCE_ATTRS_CLASS_STYLE?: boolean | "suppress-warning" | undefined;
225
+ OPTIONS_DATA_FN?: boolean | "suppress-warning" | undefined;
226
+ OPTIONS_DATA_MERGE?: boolean | "suppress-warning" | undefined;
227
+ OPTIONS_BEFORE_DESTROY?: boolean | "suppress-warning" | undefined;
228
+ OPTIONS_DESTROYED?: boolean | "suppress-warning" | undefined;
229
+ WATCH_ARRAY?: boolean | "suppress-warning" | undefined;
230
+ PROPS_DEFAULT_THIS?: boolean | "suppress-warning" | undefined;
231
+ V_ON_KEYCODE_MODIFIER?: boolean | "suppress-warning" | undefined;
232
+ CUSTOM_DIR?: boolean | "suppress-warning" | undefined;
233
+ ATTR_FALSE_VALUE?: boolean | "suppress-warning" | undefined;
234
+ ATTR_ENUMERATED_COERCION?: boolean | "suppress-warning" | undefined;
235
+ TRANSITION_CLASSES?: boolean | "suppress-warning" | undefined;
236
+ TRANSITION_GROUP_ROOT?: boolean | "suppress-warning" | undefined;
237
+ COMPONENT_ASYNC?: boolean | "suppress-warning" | undefined;
238
+ COMPONENT_FUNCTIONAL?: boolean | "suppress-warning" | undefined;
239
+ COMPONENT_V_MODEL?: boolean | "suppress-warning" | undefined;
240
+ RENDER_FUNCTION?: boolean | "suppress-warning" | undefined;
241
+ FILTERS?: boolean | "suppress-warning" | undefined;
242
+ PRIVATE_APIS?: boolean | "suppress-warning" | undefined;
243
+ MODE?: 2 | 3 | ((comp: import('vue').Component | null) => 2 | 3) | undefined;
244
+ } | undefined;
245
+ data?: ((this: any, vm: any) => any) | undefined;
246
+ computed?: import('vue').ComputedOptions | undefined;
247
+ methods?: import('vue').MethodOptions | undefined;
248
+ watch?: {
249
+ [x: string]: (string | import('vue').WatchCallback | ({
250
+ handler: import('vue').WatchCallback | string;
251
+ } & import('vue').WatchOptions<boolean>)) | (string | import('vue').WatchCallback | ({
252
+ handler: import('vue').WatchCallback | string;
253
+ } & import('vue').WatchOptions<boolean>))[];
254
+ } | undefined;
255
+ provide?: import('vue').ComponentProvideOptions | undefined;
256
+ inject?: {} | string[] | undefined;
257
+ filters?: Record<string, Function> | undefined;
258
+ mixins?: any[] | undefined;
259
+ extends?: any;
260
+ beforeCreate?: (() => any) | undefined;
261
+ created?: (() => any) | undefined;
262
+ beforeMount?: (() => any) | undefined;
263
+ mounted?: (() => any) | undefined;
264
+ beforeUpdate?: (() => any) | undefined;
265
+ updated?: (() => any) | undefined;
266
+ activated?: (() => any) | undefined;
267
+ deactivated?: (() => any) | undefined;
268
+ beforeDestroy?: (() => any) | undefined;
269
+ beforeUnmount?: (() => any) | undefined;
270
+ destroyed?: (() => any) | undefined;
271
+ unmounted?: (() => any) | undefined;
272
+ renderTracked?: ((e: import('vue').DebuggerEvent) => void) | undefined;
273
+ renderTriggered?: ((e: import('vue').DebuggerEvent) => void) | undefined;
274
+ errorCaptured?: ((err: unknown, instance: import('vue').ComponentPublicInstance | null, info: string) => boolean | void) | undefined;
275
+ delimiters?: [string, string] | undefined;
276
+ __differentiator?: string | number | symbol | undefined;
277
+ __isBuiltIn?: boolean | undefined;
278
+ __file?: string | undefined;
279
+ __name?: string | undefined;
280
+ } | undefined;
281
+ shortcut?: string[] | undefined;
282
+ disabled?: boolean | undefined;
283
+ enabled?: (() => boolean) | undefined;
284
+ confirm?: string | undefined;
285
+ perform: () => void | Promise<void>;
286
+ subCommands?: /*elided*/ any[] | undefined;
287
+ }> & Omit<Map<string, Command>, keyof Map<any, any>>;
288
+ };
289
+ registerCommands: (commands: Command[], groupId?: string) => () => void;
290
+ registerGroup: (group: CommandGroup) => () => void;
291
+ search: (query: string) => import('./types').SearchResult[];
292
+ getAllCommands: () => Command[];
293
+ getSortedGroups: () => CommandGroup[];
294
+ };
295
+ isOpen: import('vue').Ref<boolean, boolean>;
296
+ query: import('vue').Ref<string, string>;
297
+ activeIndex: import('vue').Ref<number, number>;
298
+ provide: {
299
+ [x: string]: PaletteContext;
300
+ };
301
+ };
302
+ /**
303
+ * Wrapper component that provides palette context to its slot children.
304
+ * Useful for component tree tests.
305
+ *
306
+ * @example
307
+ * mount(PaletteProvider, {
308
+ * props: { commands: [myCmd] },
309
+ * slots: { default: MyComponent },
310
+ * })
311
+ */
312
+ export declare const PaletteProvider: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
313
+ commands: {
314
+ type: () => Command[];
315
+ default: () => never[];
316
+ };
317
+ groups: {
318
+ type: () => CommandGroup[];
319
+ default: () => never[];
320
+ };
321
+ }>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
322
+ [key: string]: any;
323
+ }>[] | undefined, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
324
+ commands: {
325
+ type: () => Command[];
326
+ default: () => never[];
327
+ };
328
+ groups: {
329
+ type: () => CommandGroup[];
330
+ default: () => never[];
331
+ };
332
+ }>> & Readonly<{}>, {
333
+ groups: CommandGroup[];
334
+ commands: Command[];
335
+ }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
package/dist/types.d.ts ADDED
@@ -0,0 +1,57 @@
1
+ import { Component } from 'vue';
2
+
3
+ export interface Command {
4
+ id: string;
5
+ label: string;
6
+ description?: string;
7
+ group?: string;
8
+ keywords?: string[];
9
+ aliases?: string[];
10
+ icon?: Component | string;
11
+ shortcut?: string[];
12
+ disabled?: boolean;
13
+ enabled?: () => boolean;
14
+ confirm?: string;
15
+ perform: () => void | Promise<void>;
16
+ subCommands?: Command[];
17
+ }
18
+ export interface CommandGroup {
19
+ id: string;
20
+ label: string;
21
+ priority?: number;
22
+ commands: Command[];
23
+ onSearch?: (query: string) => Promise<Command[]>;
24
+ }
25
+ export interface CommandSection {
26
+ type: 'section';
27
+ id: string;
28
+ }
29
+ export interface PaletteState {
30
+ isOpen: boolean;
31
+ query: string;
32
+ activeIndex: number;
33
+ history: Array<{
34
+ paletteId: string;
35
+ query: string;
36
+ activeIndex: number;
37
+ }>;
38
+ recentIds: string[];
39
+ }
40
+ export interface SearchResult {
41
+ command: Command;
42
+ score: number;
43
+ matches: Array<[start: number, end: number]>;
44
+ groupId?: string;
45
+ }
46
+ export interface PaletteOptions {
47
+ hotkey?: string[];
48
+ persistRecent?: boolean;
49
+ maxRecent?: number;
50
+ maxRecentPerGroup?: number;
51
+ localStorageKey?: string;
52
+ colorTheme?: 'light' | 'dark' | 'system';
53
+ onOpen?: () => void;
54
+ onClose?: () => void;
55
+ onError?: (err: unknown, command: Command) => void;
56
+ }
57
+ export declare const PALETTE_INJECT_KEY: unique symbol;