@elaraai/east-ui 0.0.1-beta.3 → 0.0.1-beta.5

package/dist/src/overlays/menu/index.js

@@ -142,21 +142,145 @@ function createMenu(trigger, items, style) {
  * ```
  */
 export const Menu = {
-    /** Creates a Menu component */
+    /**
+     * Creates a Menu component with a trigger and menu items.
+     *
+     * @param trigger - The element that triggers the menu
+     * @param items - Array of menu items
+     * @param style - Optional style configuration
+     * @returns An East expression representing the Menu component
+     *
+     * @remarks
+     * Menu provides a dropdown list of actions triggered by clicking a UI element.
+     * Supports items with labels and values, plus separators for visual grouping.
+     *
+     * @example
+     * ```ts
+     * import { East } from "@elaraai/east";
+     * import { Menu, Button, UIComponentType } from "@elaraai/east-ui";
+     *
+     * const example = East.function([], UIComponentType, $ => {
+     *     return Menu.Root(
+     *         Button.Root("Actions"),
+     *         [
+     *             Menu.Item("edit", "Edit"),
+     *             Menu.Separator(),
+     *             Menu.Item("delete", "Delete"),
+     *         ]
+     *     );
+     * });
+     * ```
+     */
     Root: createMenu,
-    /** Creates a menu item */
+    /**
+     * Creates a menu item with value and label.
+     *
+     * @param value - Unique identifier for the item
+     * @param label - Display text for the item
+     * @param disabled - Whether the item is disabled
+     * @returns An East expression representing the menu item
+     *
+     * @remarks
+     * Menu items are clickable entries within a Menu. Each item has a unique
+     * value for identification and a label for display.
+     *
+     * @example
+     * ```ts
+     * import { East } from "@elaraai/east";
+     * import { Menu, Button, UIComponentType } from "@elaraai/east-ui";
+     *
+     * const example = East.function([], UIComponentType, $ => {
+     *     return Menu.Root(
+     *         Button.Root("Actions"),
+     *         [
+     *             Menu.Item("edit", "Edit"),
+     *             Menu.Item("delete", "Delete", true), // disabled
+     *         ]
+     *     );
+     * });
+     * ```
+     */
     Item: createMenuItem,
-    /** Creates a menu separator */
+    /**
+     * Creates a menu separator for visual grouping.
+     *
+     * @returns An East expression representing a menu separator
+     *
+     * @remarks
+     * Separators create visual dividers between groups of menu items.
+     * Use them to organize related actions within a menu.
+     *
+     * @example
+     * ```ts
+     * import { East } from "@elaraai/east";
+     * import { Menu, Button, UIComponentType } from "@elaraai/east-ui";
+     *
+     * const example = East.function([], UIComponentType, $ => {
+     *     return Menu.Root(
+     *         Button.Root("File"),
+     *         [
+     *             Menu.Item("new", "New"),
+     *             Menu.Item("open", "Open"),
+     *             Menu.Separator(),
+     *             Menu.Item("exit", "Exit"),
+     *         ]
+     *     );
+     * });
+     * ```
+     */
     Separator: createMenuSeparator,
-    /** Type definitions */
     Types: {
-        /** Menu struct type */
+        /**
+         * East StructType for Menu component.
+         *
+         * @remarks
+         * Menu wraps a trigger element and displays a dropdown menu on click.
+         * The trigger can be any UI component.
+         *
+         * @property trigger - The UI component that triggers the menu on click
+         * @property items - Array of menu items (Item or Separator)
+         * @property placement - Optional placement position
+         */
         Menu: MenuType,
-        /** Menu item variant type */
+        /**
+         * Menu item variant type.
+         *
+         * @remarks
+         * Menu items can be either an Item (clickable menu entry) or a Separator (visual divider).
+         *
+         * @property Item - A clickable menu item with value, label, and optional disabled state
+         * @property Separator - A visual separator between menu items
+         */
         Item: MenuItemType,
-        /** Menu style struct type */
+        /**
+         * Style type for Menu component.
+         *
+         * @remarks
+         * Contains optional styling properties for the menu.
+         *
+         * @property placement - Where to position the menu relative to the trigger
+         */
         Style: MenuStyleType,
-        /** Placement variant type */
+        /**
+         * Placement options for Tooltip positioning.
+         *
+         * @remarks
+         * Controls where the tooltip appears relative to its trigger element.
+         * Supports all cardinal directions with start/end variations.
+         *
+         * @property top - Centered above the trigger
+         * @property top-start - Above, aligned to start
+         * @property top-end - Above, aligned to end
+         * @property bottom - Centered below the trigger
+         * @property bottom-start - Below, aligned to start
+         * @property bottom-end - Below, aligned to end
+         * @property left - Centered to the left
+         * @property left-start - Left, aligned to start
+         * @property left-end - Left, aligned to end
+         * @property right - Centered to the right
+         * @property right-start - Right, aligned to start
+         * @property right-end - Right, aligned to end
+         */
         Placement: PlacementType,
     },
 };

package/dist/src/overlays/menu/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/overlays/menu/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAGH,IAAI,EACJ,OAAO,EACP,UAAU,EACV,WAAW,EACX,SAAS,EACT,UAAU,EACV,UAAU,GACb,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EACH,YAAY,EACZ,aAAa,EAEb,aAAa,GAChB,MAAM,YAAY,CAAC;AAEpB,kBAAkB;AAClB,OAAO,EACH,YAAY,EACZ,aAAa,EAEb,aAAa,GAEhB,MAAM,YAAY,CAAC;AAEpB,+EAA+E;AAC/E,YAAY;AACZ,+EAA+E;AAE/E;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,UAAU,CAAC;IAC/B,OAAO,EAAE,eAAe;IACxB,KAAK,EAAE,SAAS,CAAC,YAAY,CAAC;IAC9B,SAAS,EAAE,UAAU,CAAC,aAAa,CAAC;CACvC,CAAC,CAAC;AAOH,+EAA+E;AAC/E,sBAAsB;AACtB,+EAA+E;AAE/E;;;;;;;;;;;;;;;GAeG;AACH,SAAS,cAAc,CACnB,KAA4C,EAC5C,KAA4C,EAC5C,QAAiD;IAEjD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE;QAC9B,KAAK,EAAE,KAAK;QACZ,KAAK,EAAE,KAAK;QACZ,QAAQ,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC;KACvF,CAAC,EAAE,YAAY,CAAC,CAAC;AACtB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,mBAAmB;IACxB,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC;AAChE,CAAC;AAED,+EAA+E;AAC/E,eAAe;AACf,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAS,UAAU,CACf,OAA4C,EAC5C,KAAkD,EAClD,KAAiB;IAEjB,MAAM,cAAc,GAAG,KAAK,EAAE,SAAS;QACnC,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ;YAClC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,aAAa,CAAC;YAC3D,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC;QACtB,CAAC,CAAC,SAAS,CAAC;IAEhB,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE;QAC9B,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,KAAK;QACZ,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC;KACtF,CAAC,EAAE,eAAe,CAAC,CAAC;AACzB,CAAC;AAED,+EAA+E;AAC/E,wBAAwB;AACxB,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAChB,+BAA+B;IAC/B,IAAI,EAAE,UAAU;IAChB,0BAA0B;IAC1B,IAAI,EAAE,cAAc;IACpB,+BAA+B;IAC/B,SAAS,EAAE,mBAAmB;IAC9B,uBAAuB;IACvB,KAAK,EAAE;QACH,uBAAuB;QACvB,IAAI,EAAE,QAAQ;QACd,6BAA6B;QAC7B,IAAI,EAAE,YAAY;QAClB,6BAA6B;QAC7B,KAAK,EAAE,aAAa;QACpB,6BAA6B;QAC7B,SAAS,EAAE,aAAa;KAC3B;CACK,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/overlays/menu/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAGH,IAAI,EACJ,OAAO,EACP,UAAU,EACV,WAAW,EACX,SAAS,EACT,UAAU,EACV,UAAU,GACb,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EACH,YAAY,EACZ,aAAa,EAEb,aAAa,GAChB,MAAM,YAAY,CAAC;AAEpB,kBAAkB;AAClB,OAAO,EACH,YAAY,EACZ,aAAa,EAEb,aAAa,GAEhB,MAAM,YAAY,CAAC;AAEpB,+EAA+E;AAC/E,YAAY;AACZ,+EAA+E;AAE/E;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,UAAU,CAAC;IAC/B,OAAO,EAAE,eAAe;IACxB,KAAK,EAAE,SAAS,CAAC,YAAY,CAAC;IAC9B,SAAS,EAAE,UAAU,CAAC,aAAa,CAAC;CACvC,CAAC,CAAC;AAOH,+EAA+E;AAC/E,sBAAsB;AACtB,+EAA+E;AAE/E;;;;;;;;;;;;;;;GAeG;AACH,SAAS,cAAc,CACnB,KAA4C,EAC5C,KAA4C,EAC5C,QAAiD;IAEjD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE;QAC9B,KAAK,EAAE,KAAK;QACZ,KAAK,EAAE,KAAK;QACZ,QAAQ,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC;KACvF,CAAC,EAAE,YAAY,CAAC,CAAC;AACtB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,mBAAmB;IACxB,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC;AAChE,CAAC;AAED,+EAA+E;AAC/E,eAAe;AACf,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAS,UAAU,CACf,OAA4C,EAC5C,KAAkD,EAClD,KAAiB;IAEjB,MAAM,cAAc,GAAG,KAAK,EAAE,SAAS;QACnC,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ;YAClC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,aAAa,CAAC;YAC3D,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC;QACtB,CAAC,CAAC,SAAS,CAAC;IAEhB,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE;QAC9B,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,KAAK;QACZ,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC;KACtF,CAAC,EAAE,eAAe,CAAC,CAAC;AACzB,CAAC;AAED,+EAA+E;AAC/E,wBAAwB;AACxB,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAChB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,IAAI,EAAE,UAAU;IAChB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,IAAI,EAAE,cAAc;IACpB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,SAAS,EAAE,mBAAmB;IAC9B,KAAK,EAAE;QACH;;;;;;;;;;WAUG;QACH,IAAI,EAAE,QAAQ;QACd;;;;;;;;WAQG;QACH,IAAI,EAAE,YAAY;QAClB;;;;;;;WAOG;QACH,KAAK,EAAE,aAAa;QACpB;;;;;;;;;;;;;;;;;;;WAmBG;QACH,SAAS,EAAE,aAAa;KAC3B;CACK,CAAC"}