@vuu-ui/vuu-data-types 0.8.1-debug → 0.8.2-debug

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 (2) hide show
  1. package/index.d.ts +15 -0
  2. package/package.json +3 -3
package/index.d.ts CHANGED
@@ -52,11 +52,26 @@ export type ContextMenuItemDescriptor =
52
52
  | ContextMenuLeafItemDescriptor
53
53
  | ContextMenuGroupItemDescriptor;
54
54
 
55
+ /**
56
+ * MenuBuilder describes a factory function that creates
57
+ * Menu Item Descriptors appropriate to the supplied
58
+ * location. Location can be any string identifier, it
59
+ * will be used to determine which Menu Items to include
60
+ * in the menu. Most often used for ContextMenus.
61
+ */
55
62
  export type MenuBuilder<L = string, O = unknown> = (
56
63
  location: L,
57
64
  options: O
58
65
  ) => ContextMenuItemDescriptor[];
59
66
 
67
+ /**
68
+ * MenuActionHandler describes a function that provides an implementation of
69
+ * one or more MenuItem actions. It will receive the type from the MenuItem
70
+ * clicked, plus any options object associated with that MenuItem.
71
+ *
72
+ * It should return true if it handled this MenuItem. This allows multiple Menu-
73
+ * ActionHandlers to be chained.
74
+ */
60
75
  export type MenuActionHandler = (
61
76
  type: string,
62
77
  options: unknown
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@vuu-ui/vuu-data-types",
3
- "version": "0.8.1-debug",
3
+ "version": "0.8.2-debug",
4
4
  "author": "heswell",
5
5
  "license": "Apache-2.0",
6
6
  "devDependencies": {
7
- "@vuu-ui/vuu-filter-types": "0.8.1-debug",
8
- "@vuu-ui/vuu-protocol-types": "0.8.1-debug"
7
+ "@vuu-ui/vuu-filter-types": "0.8.2-debug",
8
+ "@vuu-ui/vuu-protocol-types": "0.8.2-debug"
9
9
  },
10
10
  "dependencies": {},
11
11
  "peerDependencies": {},