@m3e/fab-menu 1.0.0-rc.2 → 1.0.0-rc.3

package/dist/src/FabMenuElement.d.ts

@@ -0,0 +1,107 @@
+import { CSSResultGroup, LitElement, PropertyValues } from "lit";
+import { FabMenuVariant } from "./FabMenuVariant";
+declare const M3eFabMenuElement_base: import("node_modules/@m3e/core/dist/src/shared/mixins/Constructor").Constructor & typeof LitElement;
+/**
+ * A menu, opened from a floating action button (FAB), used to display multiple related actions.
+ *
+ * @description
+ * The `m3e-fab-menu` component presents a dynamic menu of related actions, elegantly revealed from a
+ * floating action button (FAB). Designed using expressive, adaptive surfaces, it enables seamless access
+ * to contextual actions in modern, visually rich interfaces.
+ *
+ * @example
+ * The following example illustrates triggering a `m3e-fab-menu` from an `m3e-fab` using a `m3e-fab-menu-trigger`.
+ * ```html
+ * <m3e-fab variant="primary" size="large">
+ *  <m3e-fab-menu-trigger for="fabmenu">
+ *    <m3e-icon name="edit"></m3e-icon>
+ *  </m3e-fab-menu-trigger>
+ * </m3e-fab>
+ * <m3e-fab-menu id="fabmenu" variant="secondary">
+ *  <m3e-fab-menu-item>First</m3e-fab-menu-item>
+ *  <m3e-fab-menu-item>Second</m3e-fab-menu-item>
+ *  <m3e-fab-menu-item>Third</m3e-fab-menu-item>
+ *  <m3e-fab-menu-item>Forth</m3e-fab-menu-item>
+ *  <m3e-fab-menu-item>Fifth</m3e-fab-menu-item>
+ *  <m3e-fab-menu-item>Sixth</m3e-fab-menu-item>
+ * </m3e-fab-menu>
+ * ```
+ *
+ * @tag m3e-fab-menu
+ *
+ * @slot - Renders the contents of the menu.
+ *
+ * @attr variant - The appearance variant of the menu.
+ *
+ * @cssprop --m3e-fab-menu-spacing - Vertical gap between menu items.
+ * @cssprop --m3e-fab-menu-max-width - Maximum width of the menu.
+ * @cssprop --m3e-primary-fab-color - Foreground color for primary variant items.
+ * @cssprop --m3e-primary-fab-container-color - Container color for primary variant items.
+ * @cssprop --m3e-primary-fab-hover-color - Hover background color for primary variant items.
+ * @cssprop --m3e-primary-fab-focus-color - Focus background color for primary variant items.
+ * @cssprop --m3e-primary-fab-ripple-color - Ripple color for primary variant items.
+ * @cssprop --m3e-secondary-fab-color - Foreground color for secondary variant items.
+ * @cssprop --m3e-secondary-fab-container-color - Container color for secondary variant items.
+ * @cssprop --m3e-secondary-fab-hover-color - Hover background color for secondary variant items.
+ * @cssprop --m3e-secondary-fab-focus-color - Focus background color for secondary variant items.
+ * @cssprop --m3e-secondary-fab-ripple-color - Ripple color for secondary variant items.
+ * @cssprop --m3e-tertiary-fab-color - Foreground color for tertiary variant items.
+ * @cssprop --m3e-tertiary-fab-container-color - Container color for tertiary variant items.
+ * @cssprop --m3e-tertiary-fab-hover-color - Hover background color for tertiary variant items.
+ * @cssprop --m3e-tertiary-fab-focus-color - Focus background color for tertiary variant items.
+ * @cssprop --m3e-tertiary-fab-ripple-color - Ripple color for tertiary variant items.
+ */
+export declare class M3eFabMenuElement extends M3eFabMenuElement_base {
+    #private;
+    /** The styles of the element. */
+    static styles: CSSResultGroup;
+    /**
+     * The appearance variant of the menu.
+     * @default "primary"
+     */
+    variant: FabMenuVariant;
+    /** Whether the menu is open. */
+    get isOpen(): boolean;
+    /**
+     * Opens the menu.
+     * @param {HTMLElement} trigger The element that triggered the menu.
+     * @returns {Promise<void>} A `Promise` that resolves when the menu is opened.
+     */
+    show(trigger: HTMLElement): Promise<void>;
+    /**
+     * Hides the menu.
+     * @param {boolean} [restoreFocus=false] A value indicating whether to restore focus to the menu's trigger.
+     */
+    hide(restoreFocus?: boolean): void;
+    /**
+     * Toggles the menu.
+     * @param {HTMLElement} trigger The element that triggered the menu.
+     * @returns {Promise<void>} A `Promise` that resolves when the menu is opened or closed.
+     */
+    toggle(trigger: HTMLElement): Promise<void>;
+    /** @inheritdoc */
+    connectedCallback(): void;
+    /** @inheritdoc */
+    disconnectedCallback(): void;
+    /** @inheritdoc */
+    protected firstUpdated(_changedProperties: PropertyValues): void;
+    /** @inheritdoc */
+    protected render(): unknown;
+}
+interface M3eFabMenuElementEventMap extends HTMLElementEventMap {
+    beforetoggle: ToggleEvent;
+    toggle: ToggleEvent;
+}
+export interface M3eFabMenuElement {
+    addEventListener<K extends keyof M3eFabMenuElementEventMap>(type: K, listener: (this: M3eFabMenuElement, ev: M3eFabMenuElementEventMap[K]) => void, options?: boolean | AddEventListenerOptions): void;
+    addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+    removeEventListener<K extends keyof M3eFabMenuElementEventMap>(type: K, listener: (this: M3eFabMenuElement, ev: M3eFabMenuElementEventMap[K]) => void, options?: boolean | EventListenerOptions): void;
+    removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "m3e-fab-menu": M3eFabMenuElement;
+    }
+}
+export {};
+//# sourceMappingURL=FabMenuElement.d.ts.map

package/dist/src/FabMenuElement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FabMenuElement.d.ts","sourceRoot":"","sources":["../../src/FabMenuElement.ts"],"names":[],"mappings":"AACA,OAAO,EAAO,cAAc,EAAQ,UAAU,EAAE,cAAc,EAAa,MAAM,KAAK,CAAC;AAUvF,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;;AAGlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,qBACa,iBAAkB,SAAQ,sBAAwB;;IAC7D,iCAAiC;IACjC,OAAgB,MAAM,EAAE,cAAc,CA8FpC;IA8BF;;;OAGG;IAC0B,OAAO,EAAE,cAAc,CAAa;IAEjE,gCAAgC;IAChC,IAAI,MAAM,YAET;IAED;;;;OAIG;IACG,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAiC/C;;;OAGG;IACH,IAAI,CAAC,YAAY,GAAE,OAAe,GAAG,IAAI;IAezC;;;;OAIG;IACG,MAAM,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAQjD,kBAAkB;IACT,iBAAiB,IAAI,IAAI;IAYlC,kBAAkB;IACT,oBAAoB,IAAI,IAAI;IAQrC,kBAAkB;cACC,YAAY,CAAC,kBAAkB,EAAE,cAAc,GAAG,IAAI;IAKzE,kBAAkB;cACC,MAAM,IAAI,OAAO;CA2DrC;AAED,UAAU,yBAA0B,SAAQ,mBAAmB;IAC7D,YAAY,EAAE,WAAW,CAAC;IAC1B,MAAM,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,gBAAgB,CAAC,CAAC,SAAS,MAAM,yBAAyB,EACxD,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,IAAI,EAAE,iBAAiB,EAAE,EAAE,EAAE,yBAAyB,CAAC,CAAC,CAAC,KAAK,IAAI,EAC7E,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB,GAC1C,IAAI,CAAC;IAER,gBAAgB,CACd,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,kCAAkC,EAC5C,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB,GAC1C,IAAI,CAAC;IAER,mBAAmB,CAAC,CAAC,SAAS,MAAM,yBAAyB,EAC3D,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,IAAI,EAAE,iBAAiB,EAAE,EAAE,EAAE,yBAAyB,CAAC,CAAC,CAAC,KAAK,IAAI,EAC7E,OAAO,CAAC,EAAE,OAAO,GAAG,oBAAoB,GACvC,IAAI,CAAC;IAER,mBAAmB,CACjB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,kCAAkC,EAC5C,OAAO,CAAC,EAAE,OAAO,GAAG,oBAAoB,GACvC,IAAI,CAAC;CACT;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,cAAc,EAAE,iBAAiB,CAAC;KACnC;CACF"}

package/dist/src/FabMenuItemElement.d.ts

@@ -0,0 +1,74 @@
+import { CSSResultGroup, LitElement, PropertyValues } from "lit";
+import type { M3eFabMenuElement } from "./FabMenuElement";
+declare const M3eFabMenuItemElement_base: import("node_modules/@m3e/core/dist/src/shared/mixins/Constructor").Constructor<import("@m3e/core").LinkButtonMixin> & import("node_modules/@m3e/core/dist/src/shared/mixins/Constructor").Constructor<import("@m3e/core").DisabledMixin> & import("node_modules/@m3e/core/dist/src/shared/mixins/Constructor").Constructor<import("@m3e/core").AttachInternalsMixin> & import("node_modules/@m3e/core/dist/src/shared/mixins/Constructor").Constructor & typeof LitElement;
+/**
+ * An item of a floating action button (FAB) menu.
+ *
+ * @example
+ * The following example illustrates triggering a `m3e-fab-menu` from an `m3e-fab` using a `m3e-fab-menu-trigger`.
+ * ```html
+ * <m3e-fab variant="primary" size="large">
+ *  <m3e-fab-menu-trigger for="fabmenu">
+ *    <m3e-icon name="edit"></m3e-icon>
+ *  </m3e-fab-menu-trigger>
+ * </m3e-fab>
+ * <m3e-fab-menu id="fabmenu" variant="secondary">
+ *  <m3e-fab-menu-item>First</m3e-fab-menu-item>
+ *  <m3e-fab-menu-item>Second</m3e-fab-menu-item>
+ *  <m3e-fab-menu-item>Third</m3e-fab-menu-item>
+ *  <m3e-fab-menu-item>Forth</m3e-fab-menu-item>
+ *  <m3e-fab-menu-item>Fifth</m3e-fab-menu-item>
+ *  <m3e-fab-menu-item>Sixth</m3e-fab-menu-item>
+ * </m3e-fab-menu>
+ * ```
+ *
+ * @tag m3e-menu-item
+ *
+ * @slot - Renders the label of the item.
+ * @slot icon - Renders an icon before the items's label.
+ *
+ * @attr disabled - Whether the element is disabled.
+ * @attr download - A value indicating whether the `target` of the link button will be downloaded, optionally specifying the new name of the file.
+ * @attr href - The URL to which the link button points.
+ * @attr rel - The relationship between the `target` of the link button and the document.
+ * @attr target - The target of the link button.
+ *
+ * @fires click - Emitted when the element is clicked.
+ *
+ * @cssprop --m3e-fab-menu-item-height - Height of the menu item.
+ * @cssprop --m3e-fab-menu-item-font-size - Font size of the menu item label.
+ * @cssprop --m3e-fab-menu-item-font-weight - Font weight of the menu item label.
+ * @cssprop --m3e-fab-menu-item-line-height - Line height of the menu item label.
+ * @cssprop --m3e-fab-menu-item-tracking - Letter spacing of the menu item label.
+ * @cssprop --m3e-fab-menu-item-shape - Border radius of the menu item.
+ * @cssprop --m3e-fab-menu-item-leading-space - Padding at the start of the menu item.
+ * @cssprop --m3e-fab-menu-item-trailing-space - Padding at the end of the menu item.
+ * @cssprop --m3e-fab-menu-item-spacing - Gap between icon and label.
+ * @cssprop --m3e-fab-menu-item-icon-size - Size of the icon in the menu item.
+ */
+export declare class M3eFabMenuItemElement extends M3eFabMenuItemElement_base {
+    #private;
+    /** The styles of the element. */
+    static styles: CSSResultGroup;
+    /** @private */ private readonly _elevation?;
+    /** @private */ private readonly _focusRing?;
+    /** @private */ private readonly _stateLayer?;
+    /** @private */ private readonly _ripple?;
+    /** The floating action button (FAB) menu to which this item belongs. */
+    get menu(): M3eFabMenuElement | null;
+    /** @inheritdoc */
+    connectedCallback(): void;
+    /** @inheritdoc */
+    disconnectedCallback(): void;
+    /** @inheritdoc */
+    protected firstUpdated(_changedProperties: PropertyValues<this>): void;
+    /** @inheritdoc */
+    render(): unknown;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "m3e-fab-menu-item": M3eFabMenuItemElement;
+    }
+}
+export {};
+//# sourceMappingURL=FabMenuItemElement.d.ts.map

package/dist/src/FabMenuItemElement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FabMenuItemElement.d.ts","sourceRoot":"","sources":["../../src/FabMenuItemElement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,cAAc,EAAQ,UAAU,EAAE,cAAc,EAAa,MAAM,KAAK,CAAC;AAiBvF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,qBACa,qBAAsB,SAAQ,0BAE1C;;IACC,iCAAiC;IACjC,OAAgB,MAAM,EAAE,cAAc,CA6HpC;IAEF,eAAe,CAAsB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAsB;IACvF,eAAe,CAAuB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAsB;IACxF,eAAe,CAAwB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAuB;IAC3F,eAAe,CAAmB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAmB;IAI9E,wEAAwE;IACxE,IAAI,IAAI,IAAI,iBAAiB,GAAG,IAAI,CAEnC;IAED,kBAAkB;IACT,iBAAiB,IAAI,IAAI;IAKlC,kBAAkB;IACT,oBAAoB,IAAI,IAAI;IAKrC,kBAAkB;cACC,YAAY,CAAC,kBAAkB,EAAE,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI;IAK/E,kBAAkB;IACT,MAAM,IAAI,OAAO;CAqB3B;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,mBAAmB,EAAE,qBAAqB,CAAC;KAC5C;CACF"}

package/dist/src/FabMenuTriggerElement.d.ts

@@ -0,0 +1,50 @@
+import { CSSResultGroup, LitElement } from "lit";
+import { M3eFabMenuElement } from "./FabMenuElement";
+declare const M3eFabMenuTriggerElement_base: import("node_modules/@m3e/core/dist/src/shared/mixins/Constructor").Constructor<import("@m3e/core").HtmlForMixin> & typeof LitElement;
+/**
+ * An element, nested within a clickable element, used to open a floating action button (FAB) menu.
+ *
+ * @example
+ * The following example illustrates triggering a `m3e-fab-menu` from an `m3e-fab` using a `m3e-fab-menu-trigger`.
+ * ```html
+ * <m3e-fab variant="primary" size="large">
+ *  <m3e-fab-menu-trigger for="fabmenu">
+ *    <m3e-icon name="edit"></m3e-icon>
+ *  </m3e-fab-menu-trigger>
+ * </m3e-fab>
+ * <m3e-fab-menu id="fabmenu" variant="secondary">
+ *  <m3e-fab-menu-item>First</m3e-fab-menu-item>
+ *  <m3e-fab-menu-item>Second</m3e-fab-menu-item>
+ *  <m3e-fab-menu-item>Third</m3e-fab-menu-item>
+ *  <m3e-fab-menu-item>Forth</m3e-fab-menu-item>
+ *  <m3e-fab-menu-item>Fifth</m3e-fab-menu-item>
+ *  <m3e-fab-menu-item>Sixth</m3e-fab-menu-item>
+ * </m3e-fab-menu>
+ * ```
+ *
+ * @tag m3e-fab-menu-trigger
+ */
+export declare class M3eFabMenuTriggerElement extends M3eFabMenuTriggerElement_base {
+    #private;
+    /** The styles of the element. */
+    static styles: CSSResultGroup;
+    /** The menu triggered by the element. */
+    get menu(): M3eFabMenuElement | null;
+    /** @inheritdoc */
+    connectedCallback(): void;
+    /** @inheritdoc */
+    disconnectedCallback(): void;
+    /** @inheritdoc */
+    attach(control: HTMLElement): void;
+    /** @inheritdoc */
+    detach(): void;
+    /** @inheritdoc */
+    protected render(): unknown;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "m3e-fab-menu-trigger": M3eFabMenuTriggerElement;
+    }
+}
+export {};
+//# sourceMappingURL=FabMenuTriggerElement.d.ts.map

package/dist/src/FabMenuTriggerElement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FabMenuTriggerElement.d.ts","sourceRoot":"","sources":["../../src/FabMenuTriggerElement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,cAAc,EAAQ,UAAU,EAAE,MAAM,KAAK,CAAC;AAM5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;;AAErD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBACa,wBAAyB,SAAQ,6BAAmB;;IAC/D,iCAAiC;IACjC,OAAgB,MAAM,EAAE,cAAc,CAOpC;IAIF,yCAAyC;IACzC,IAAI,IAAI,IAAI,iBAAiB,GAAG,IAAI,CAEnC;IAED,kBAAkB;IACT,iBAAiB,IAAI,IAAI;IAKlC,kBAAkB;IACT,oBAAoB,IAAI,IAAI;IAKrC,kBAAkB;IACT,MAAM,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAc3C,kBAAkB;IACT,MAAM,IAAI,IAAI;IAYvB,kBAAkB;cACC,MAAM,IAAI,OAAO;CAUrC;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,sBAAsB,EAAE,wBAAwB,CAAC;KAClD;CACF"}

package/dist/src/FabMenuVariant.d.ts

@@ -0,0 +1,3 @@
+/** Specifies the possible appearance variants of a floating-action button menu. */
+export type FabMenuVariant = "primary" | "secondary" | "tertiary";
+//# sourceMappingURL=FabMenuVariant.d.ts.map

package/dist/src/FabMenuVariant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FabMenuVariant.d.ts","sourceRoot":"","sources":["../../src/FabMenuVariant.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,WAAW,GAAG,UAAU,CAAC"}

package/dist/src/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./FabMenuElement";
+export * from "./FabMenuItemElement";
+export * from "./FabMenuTriggerElement";
+export * from "./FabMenuVariant";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@m3e/fab-menu",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.0-rc.3",
   "description": "FAB Menu for M3E",
   "author": "matraic <matraic@yahoo.com>",
   "license": "MIT",
@@ -27,8 +27,8 @@
     "clean": "rimraf dist"
   },
   "peerDependencies": {
-    "@m3e/core": "1.0.0-rc.2",
-    "@m3e/fab": "1.0.0-rc.2",
+    "@m3e/core": "1.0.0-rc.3",
+    "@m3e/fab": "1.0.0-rc.3",
     "lit": "^3.3.0"
   },
   "devDependencies": {