@m3e/button-group 1.0.0-rc.2 → 1.0.0-rc.4

package/README.md

@@ -27,7 +27,7 @@ Alternately, you can explicitly reference the `html-custom-data.json` and `css-c
 }
 ```
 
-## 🚀 Browser Usage
+## 🚀 Native Module Support
 
 This package uses [JavaScript Modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules#module_specifiers). To use it directly in a browser without a bundler, use a module script similar to the following.
 

package/dist/custom-elements.json

@@ -1128,25 +1128,6 @@
           "kind": "mixin",
           "description": "Mixin that adds support for custom event attributes.",
           "name": "EventAttribute",
-          "members": [
-            {
-              "kind": "method",
-              "name": "dispatchEvent",
-              "return": {
-                "type": {
-                  "text": "boolean"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "event",
-                  "type": {
-                    "text": "Event"
-                  }
-                }
-              ]
-            }
-          ],
           "parameters": [
             {
               "name": "base",
@@ -1444,6 +1425,17 @@
           "description": "Mixin to augment an element with behavior used to submit a form.",
           "name": "FormSubmitter",
           "members": [
+            {
+              "kind": "field",
+              "name": "formAssociated",
+              "type": {
+                "text": "boolean"
+              },
+              "static": true,
+              "readonly": true,
+              "default": "true",
+              "description": "Indicates that this custom element participates in form submission, validation, and form state restoration."
+            },
             {
               "kind": "field",
               "name": "name",
@@ -1980,6 +1972,11 @@
       "kind": "javascript-module",
       "path": "../core/src/shared/mixins/Labelled.ts",
       "declarations": [
+        {
+          "kind": "variable",
+          "name": "updateLabels",
+          "description": "A symbol through which to update labels to reflect a control's current state."
+        },
         {
           "kind": "function",
           "name": "isLabelledMixin",
@@ -2029,16 +2026,6 @@
               },
               "description": "The label elements that the element is associated with.",
               "readonly": true
-            },
-            {
-              "kind": "method",
-              "name": "[_updateLabels]",
-              "privacy": "private",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              }
             }
           ],
           "parameters": [
@@ -2053,6 +2040,14 @@
         }
       ],
       "exports": [
+        {
+          "kind": "js",
+          "name": "updateLabels",
+          "declaration": {
+            "name": "updateLabels",
+            "module": "../core/src/shared/mixins/Labelled.ts"
+          }
+        },
         {
           "kind": "js",
           "name": "isLabelledMixin",

package/dist/src/ButtonGroupElement.d.ts

@@ -0,0 +1,98 @@
+import { CSSResultGroup, LitElement, PropertyValues } from "lit";
+import { M3eButtonElement } from "@m3e/button";
+import { M3eIconButtonElement } from "@m3e/icon-button";
+import { ButtonGroupVariant } from "./ButtonGroupVariant";
+import { ButtonGroupSize } from "./ButtonGroupSize";
+declare const M3eButtonGroupElement_base: import("node_modules/@m3e/core/dist/src/shared/mixins/Constructor").Constructor & typeof LitElement;
+/**
+ * Organizes buttons and adds interactions between them.
+ *
+ * @description
+ * The `m3e-button-group` component arranges multiple buttons into a unified, expressive layout,
+ * supporting both `standard` and `connected` variants. It enables seamless, accessible grouping
+ * of actions, adapts to various sizes, and ensures consistent spacing, shape, and alignment.
+ * Designed according to Material 3 principles, it empowers users to interact with related actions
+ * in a visually harmonious and intuitive way.
+ *
+ * @example
+ * The following example illustrates a standard button group.
+ * ``` html
+ * <m3e-button-group>
+ *  <m3e-icon-button variant="tonal" toggle><m3e-icon name="format_bold"></m3e-icon></m3e-icon-button>
+ *  <m3e-icon-button variant="tonal" toggle><m3e-icon name="format_italic"></m3e-icon></m3e-icon-button>
+ *  <m3e-icon-button variant="tonal" toggle><m3e-icon name="format_underlined"></m3e-icon></m3e-icon-button>
+ * </m3e-button-group>
+ * ```
+ * @example
+ * The next example illustrates a connected button group.
+ * ```html
+ * <m3e-button-group variant="connected">
+ *  <m3e-button variant="tonal" shape="square" toggle>Start</m3e-button>
+ *  <m3e-button variant="tonal" shape="square" toggle>Directions</m3e-button>
+ *  <m3e-button variant="tonal" shape="square" toggle>Share</m3e-button>
+ * </m3e-button-group>
+ * ```
+ *
+ * @tag m3e-button-group
+ *
+ * @slot - Renders the buttons of the group.
+ *
+ * @attr multi - Whether multiple toggle buttons can be selected.
+ * @attr size - The size of the group.
+ * @attr variant - The appearance variant of the group.
+ *
+ * @cssprop --m3e-standard-button-group-extra-small-spacing - Spacing between buttons in standard variant, extra-small size.
+ * @cssprop --m3e-standard-button-group-small-spacing - Spacing between buttons in standard variant, small size.
+ * @cssprop --m3e-standard-button-group-medium-spacing - Spacing between buttons in standard variant, medium size.
+ * @cssprop --m3e-standard-button-group-large-spacing - Spacing between buttons in standard variant, large size.
+ * @cssprop --m3e-standard-button-group-extra-large-spacing - Spacing between buttons in standard variant, extra-large size.
+ * @cssprop --m3e-connected-button-group-spacing - Spacing between buttons in connected variant.
+ * @cssprop --m3e-connected-button-group-extra-small-inner-shape - Corner shape for connected variant, extra-small size.
+ * @cssprop --m3e-connected-button-group-extra-small-inner-pressed-shape - Pressed corner shape for connected variant, extra-small size.
+ * @cssprop --m3e-connected-button-group-small-inner-shape - Corner shape for connected variant, small size.
+ * @cssprop --m3e-connected-button-group-small-inner-pressed-shape - Pressed corner shape for connected variant, small size.
+ * @cssprop --m3e-connected-button-group-medium-inner-shape - Corner shape for connected variant, medium size.
+ * @cssprop --m3e-connected-button-group-medium-inner-pressed-shape - Pressed corner shape for connected variant, medium size.
+ * @cssprop --m3e-connected-button-group-large-inner-shape - Corner shape for connected variant, large size.
+ * @cssprop --m3e-connected-button-group-large-inner-pressed-shape - Pressed corner shape for connected variant, large size.
+ * @cssprop --m3e-connected-button-group-extra-large-inner-shape - Corner shape for connected variant, extra-large size.
+ * @cssprop --m3e-connected-button-group-extra-large-inner-pressed-shape - Pressed corner shape for connected variant, extra-large size.
+ */
+export declare class M3eButtonGroupElement extends M3eButtonGroupElement_base {
+    #private;
+    /** The styles of the element. */
+    static styles: CSSResultGroup;
+    private readonly _base?;
+    /**
+     * The appearance variant of the group.
+     * @default "standard"
+     */
+    variant: ButtonGroupVariant;
+    /**
+     * The size of the group.
+     * @default "small"
+     */
+    size: ButtonGroupSize;
+    /**
+     * Whether multiple toggle buttons can be selected.
+     * @default false
+     */
+    multi: boolean;
+    /** The buttons contained by the group. */
+    readonly buttons: ReadonlyArray<M3eButtonElement | M3eIconButtonElement>;
+    /** @inheritdoc */
+    connectedCallback(): void;
+    /** @inheritdoc */
+    disconnectedCallback(): void;
+    /** @inheritdoc */
+    protected update(changedProperties: PropertyValues<this>): void;
+    /** @inheritdoc */
+    protected render(): unknown;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "m3e-button-group": M3eButtonGroupElement;
+    }
+}
+export {};
+//# sourceMappingURL=ButtonGroupElement.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ButtonGroupElement.d.ts","sourceRoot":"","sources":["../../src/ButtonGroupElement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,cAAc,EAAQ,UAAU,EAAE,cAAc,EAAE,MAAM,KAAK,CAAC;AAI5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAExD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,qBACa,qBAAsB,SAAQ,0BAAyB;;IAClE,iCAAiC;IACjC,OAAgB,MAAM,EAAE,cAAc,CAuMpC;IAmBc,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAc;IAErD;;;OAGG;IAC0B,OAAO,EAAE,kBAAkB,CAAc;IAEtE;;;OAGG;IAC0B,IAAI,EAAE,eAAe,CAAW;IAE7D;;;OAGG;IAC0B,KAAK,UAAS;IAE3C,0CAA0C;IAE1C,QAAQ,CAAC,OAAO,EAAG,aAAa,CAAC,gBAAgB,GAAG,oBAAoB,CAAC,CAAC;IAE1E,kBAAkB;IACT,iBAAiB,IAAI,IAAI;IAQlC,kBAAkB;IACT,oBAAoB,IAAI,IAAI;IAMrC,kBAAkB;cACC,MAAM,CAAC,iBAAiB,EAAE,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI;IAWxE,kBAAkB;cACC,MAAM,IAAI,OAAO;CAqDrC;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,kBAAkB,EAAE,qBAAqB,CAAC;KAC3C;CACF"}

package/dist/src/ButtonGroupSize.d.ts

@@ -0,0 +1,3 @@
+/** Specifies the possible sizes of a button a group. */
+export type ButtonGroupSize = "extra-small" | "small" | "medium" | "large" | "extra-large";
+//# sourceMappingURL=ButtonGroupSize.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ButtonGroupSize.d.ts","sourceRoot":"","sources":["../../src/ButtonGroupSize.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,aAAa,CAAC"}

package/dist/src/ButtonGroupVariant.d.ts

@@ -0,0 +1,3 @@
+/** Specifies the possible appearance variants of a button group. */
+export type ButtonGroupVariant = "standard" | "connected";
+//# sourceMappingURL=ButtonGroupVariant.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ButtonGroupVariant.d.ts","sourceRoot":"","sources":["../../src/ButtonGroupVariant.ts"],"names":[],"mappings":"AAAA,oEAAoE;AACpE,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG,WAAW,CAAC"}

package/dist/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./ButtonGroupElement";
+export * from "./ButtonGroupSize";
+export * from "./ButtonGroupVariant";
+//# 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,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@m3e/button-group",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.0-rc.4",
   "description": "Button Group for M3E",
   "author": "matraic <matraic@yahoo.com>",
   "license": "MIT",
@@ -29,9 +29,9 @@
     "clean": "rimraf dist"
   },
   "peerDependencies": {
-    "@m3e/core": "1.0.0-rc.2",
-    "@m3e/button": "1.0.0-rc.2",
-    "@m3e/icon-button": "1.0.0-rc.2",
+    "@m3e/core": "1.0.0-rc.4",
+    "@m3e/button": "1.0.0-rc.4",
+    "@m3e/icon-button": "1.0.0-rc.4",
     "lit": "^3.3.0"
   },
   "devDependencies": {