@k8slens/drop-down-menu-contracts 1.0.0 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k8slens/drop-down-menu-contracts",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "lens": {
     "env": "renderer",
     "layer": "technical",

package/dist/src/context-menu-items.d.ts

@@ -1,77 +0,0 @@
-import type { Discriminable, Orderable, MaybeComputedShowable, MaybeComputedEnableable, Identifiable } from "@k8slens/composable-responsibilities";
-import type { MaybeAsyncVoidFunction, MaybePromise } from "@k8slens/public-utilities";
-import type React from "react";
-/**
- * A label given as plain text.
- */
-export type TextLabelable = {
-    readonly labelText: string;
-    readonly Label?: undefined;
-    readonly labelProps?: undefined;
-};
-/**
- * When the label component requires props, providing them is mandatory; when all of its props are
- * optional, so is providing them.
- */
-export type LabelPropsFor<P extends object> = {} extends P ? {
-    readonly labelProps?: P;
-} : {
-    readonly labelProps: P;
-};
-/**
- * A label given as a component type the menu renders where and when the label is shown. The
- * component must be defined at module scope; any data it needs arrives as props through
- * `labelProps`. Capturing data in a closure instead would create a new component reference on
- * every invocation and break React reconciliation.
- */
-export type ComponentLabelable<P extends object = any> = {
-    readonly labelText?: undefined;
-    readonly Label: React.ComponentType<P>;
-} & LabelPropsFor<P>;
-/**
- * Exactly one of `labelText` and `Label` must be provided.
- */
-export type ReactLabelable<P extends object = any> = TextLabelable | ComponentLabelable<P>;
-/**
- * A clickable menu item. Visibility (`isVisible`/`isHidden`) and enablement (`isEnabled`) may be
- * given as computeds, in which case the menu reacts to their changes while open.
- */
-export type ActionMenuItem<P extends object = any> = Discriminable<"action"> & Identifiable & Orderable & ReactLabelable<P> & MaybeComputedShowable & MaybeComputedEnableable & {
-    /**
-     * This function will be called when the user clicks on this menu item
-     */
-    readonly onClick: MaybePromise<MaybeAsyncVoidFunction>;
-    readonly parentId: string | undefined;
-};
-/**
- * A menu item that reveals nested items on hover.
- */
-export type SubMenuItem<P extends object = any> = Discriminable<"sub-menu"> & Identifiable & Orderable & ReactLabelable<P> & MaybeComputedShowable & MaybeComputedEnableable & {
-    readonly parentId: string | undefined;
-    readonly onClick?: MaybePromise<MaybeAsyncVoidFunction>;
-};
-/**
- * An item that renders itself entirely — the element it lives in included. The menu puts the
- * component in its list and stays out of the way, so the item decides its own markup, whether it
- * anchors anything, and whether it takes part in keyboard navigation.
- *
- * The component must be defined at module scope; capturing data in a closure would create a new
- * component reference on every invocation and break React reconciliation.
- */
-export interface ComponentMenuItem extends Discriminable<"component">, Identifiable, Orderable, MaybeComputedShowable {
-    readonly Component: React.ComponentType;
-    readonly parentId: string | undefined;
-}
-/**
- * A group of items that should have separators before the first item (if applicable) and after the last item (if applicable)
- */
-export interface GroupOfMenuItems extends Discriminable<"group">, MaybeComputedShowable, Identifiable, Orderable {
-    readonly parentId: string | undefined;
-}
-/**
- * The authoring model of a menu item: a clickable action, a sub-menu, or a group. Items reference
- * each other by `id`/`parentId`; siblings are ordered by `orderNumber`, and separators appear
- * between adjacent groups.
- */
-export type MenuItem = ActionMenuItem | SubMenuItem | ComponentMenuItem | GroupOfMenuItems;
-//# sourceMappingURL=context-menu-items.d.ts.map

package/dist/src/context-menu-items.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"context-menu-items.d.ts","sourceRoot":"","sources":["../../src/context-menu-items.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,SAAS,EACT,qBAAqB,EACrB,uBAAuB,EACvB,YAAY,EACb,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACtF,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;IAC3B,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,CAAC;CACjC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,IAAI,EAAE,SAAS,CAAC,GAAG;IAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAA;CAAE,CAAC;AAEtH;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,MAAM,GAAG,GAAG,IAAI;IACvD,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;CACxC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AAErB;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,GAAG,GAAG,IAAI,aAAa,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAE3F;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,GAAG,GAAG,IAAI,aAAa,CAAC,QAAQ,CAAC,GAC1E,YAAY,GACZ,SAAS,GACT,cAAc,CAAC,CAAC,CAAC,GACjB,qBAAqB,GACrB,uBAAuB,GAAG;IACxB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,sBAAsB,CAAC,CAAC;IACvD,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CACvC,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,GAAG,IAAI,aAAa,CAAC,UAAU,CAAC,GACzE,YAAY,GACZ,SAAS,GACT,cAAc,CAAC,CAAC,CAAC,GACjB,qBAAqB,GACrB,uBAAuB,GAAG;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,sBAAsB,CAAC,CAAC;CACzD,CAAC;AAEJ;;;;;;;GAOG;AACH,MAAM,WAAW,iBAAkB,SAAQ,aAAa,CAAC,WAAW,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,qBAAqB;IACnH,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC;IACxC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,aAAa,CAAC,OAAO,CAAC,EAAE,qBAAqB,EAAE,YAAY,EAAE,SAAS;IAC9G,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,cAAc,GAAG,WAAW,GAAG,iBAAiB,GAAG,gBAAgB,CAAC"}

package/dist/src/menu-item-activated-context.d.ts

@@ -1,6 +0,0 @@
-/**
- * Told by an item when it is activated, so the menu it belongs to — and the menus it was opened
- * from — can close. Items themselves know nothing of menus.
- */
-export declare const menuItemActivatedContext: import("react").Context<VoidFunction | undefined>;
-//# sourceMappingURL=menu-item-activated-context.d.ts.map

package/dist/src/menu-item-activated-context.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"menu-item-activated-context.d.ts","sourceRoot":"","sources":["../../src/menu-item-activated-context.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,wBAAwB,mDAAqD,CAAC"}