@m3e/segmented-button 1.0.0-rc.1

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 matraic
+Contact: matraic@yahoo.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,174 @@
+# @m3e/segmented-button
+
+The `m3e-segmented-button` and `m3e-button-segment` components allows users to select one or more options from a horizontal group. Each segment behaves like a toggle-able button, supporting icon and label content, selection state, and accessibility roles. Built with Material Design 3 principles, it adapts shape, color, and ripple feedback based on interaction state and input modality. Segments are visually unified but independently interactive.
+
+> **Part of the [M3E](../../README.md) monorepo**  
+> This package is maintained within the unified M3E repository, which provides a suite of Material 3 web components.
+
+## 📦 Installation
+
+```bash
+npm install @m3e/segmented-button
+```
+
+## 💻 Editor Integration
+
+This package includes a [Custom Elements Manifest](https://github.com/webcomponents/custom-elements-manifest) to support enhanced editor tooling and developer experience.
+
+### Visual Studio Code
+
+To enable autocomplete and hover documentation for `@m3e/segmented-button`, install the [Custom Elements Manifest Language Server](https://marketplace.visualstudio.com/items?itemName=pwrs.cem-language-server-vscode) extension. It will automatically detect the manifest bundled with this package and surface tag names, attributes, slots, and events in supported files.
+
+Alternately, you can explicitly reference the `html-custom-data.json` and `css-custom-data.json` in your workspace settings:
+
+```json
+{
+  "html.customData": ["./node_modules/@m3e/segmented-button/dist/html-custom-data.json"],
+  "css.customData": ["./node_modules/@m3e/segmented-button/dist/css-custom-data.json"]
+}
+```
+
+## 🚀 Browser Usage
+
+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.
+
+```html
+<script type="module" src="/node_modules/@m3e/segmented-button/dist/index.js"></script>
+```
+
+In addition, you must use an [import map](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/script/type/importmap) to include dependencies.
+
+```html
+<script type="importmap">
+  {
+    "imports": {
+      "lit": "https://cdn.jsdelivr.net/npm/lit@3.3.0/+esm",
+      "@m3e/core": "/node_modules/@m3e/core/dist/index.js",
+      "@m3e/core/a11y": "/node_modules/@m3e/core/dist/a11y.js"
+    }
+  }
+</script>
+```
+
+> For production, use index.min.js and a11y.min.js for faster load times.
+
+## 🗂️ Elements
+
+- `m3e-segmented-button` — A button that allows a user to select from a limited set of options.
+- `m3e-button-segment` — A option that can be selected within a segmented button.
+
+## 🧪 Example
+
+The following example illustrates a single-select segmented button with four segments.
+
+```html
+<m3e-segmented-button>
+  <m3e-button-segment checked>8 oz</m3e-button-segment>
+  <m3e-button-segment>12 oz</m3e-button-segment>
+  <m3e-button-segment>16 oz</m3e-button-segment>
+  <m3e-button-segment>20 oz</m3e-button-segment>
+</m3e-segmented-button>
+```
+
+## 📖 API Reference
+
+### 🗂️ m3e-segmented-button
+
+This section details the attributes, slots, events and CSS custom properties available for the `m3e-segmented-button` component.
+
+#### 🛠️ Attributes
+
+| Attribute                  | Type      | Default | Description                                                               |
+| -------------------------- | --------- | ------- | ------------------------------------------------------------------------- |
+| `disabled`                 | `boolean` | `false` | Whether the element is disabled.                                          |
+| `hide-selection-indicator` | `boolean` | `false` | Whether to hide the selection indicator.                                  |
+| `multi`                    | `boolean` | `false` | Whether multiple options can be selected.                                 |
+| `name`                     | `string`  |         | The name that identifies the element when submitting the associated form. |
+
+#### 🔔 Events
+
+| Event    | Description                                          |
+| -------- | ---------------------------------------------------- |
+| `input`  | Emitted when the checked state of a segment changes. |
+| `change` | Emitted when the checked state of a segment changes. |
+
+#### 🧩 Slots
+
+| Slot        | Description                         |
+| ----------- | ----------------------------------- |
+| _(default)_ | Renders the segments of the button. |
+
+#### 🎛️ CSS Custom Properties
+
+| Property                             | Description                                                |
+| ------------------------------------ | ---------------------------------------------------------- |
+| `--m3e-segmented-button-start-shape` | Border radius for the first segment in a segmented button. |
+| `--m3e-segmented-button-end-shape`   | Border radius for the last segment in a segmented button.  |
+
+### 🗂️ m3e-button-segment
+
+This section details the attributes, slots, events and CSS custom properties available for the `m3e-button-segment` component.
+
+#### 🛠️ Attributes
+
+| Attribute  | Type      | Default | Description                                     |
+| ---------- | --------- | ------- | ----------------------------------------------- |
+| `checked`  | `boolean` | `false` | Whether the element is checked.                 |
+| `disabled` | `boolean` | `false` | Whether the element is disabled.                |
+| `value`    | `string`  | `"on"`  | A string representing the value of the segment. |
+
+#### 🔔 Events
+
+| Event    | Description                             |
+| -------- | --------------------------------------- |
+| `input`  | Emitted when the checked state changes. |
+| `change` | Emitted when the checked state changes. |
+
+#### 🧩 Slots
+
+| Slot        | Description                                |
+| ----------- | ------------------------------------------ |
+| _(default)_ | Renders the label of the option.           |
+| `icon`      | Renders an icon before the option's label. |
+
+#### 🎛️ CSS Custom Properties
+
+| Property                                                  | Description                                         |
+| --------------------------------------------------------- | --------------------------------------------------- |
+| `--m3e-segmented-button-height`                           | Total height of the segmented button.               |
+| `--m3e-segmented-button-outline-thickness`                | Thickness of the button’s border.                   |
+| `--m3e-segmented-button-outline-color`                    | Color of the button’s border.                       |
+| `--m3e-segmented-button-padding-start`                    | Padding on the leading edge of the button content.  |
+| `--m3e-segmented-button-padding-end`                      | Padding on the trailing edge of the button content. |
+| `--m3e-segmented-button-spacing`                          | Horizontal gap between icon and label.              |
+| `--m3e-segmented-button-font-size`                        | Font size of the label text.                        |
+| `--m3e-segmented-button-font-weight`                      | Font weight of the label text.                      |
+| `--m3e-segmented-button-line-height`                      | Line height of the label text.                      |
+| `--m3e-segmented-button-tracking`                         | Letter spacing of the label text.                   |
+| `--m3e-segmented-button-with-icon-padding-start`          | Leading padding when an icon is present.            |
+| `--m3e-segmented-button-icon-size`                        | Font size of the icon.                              |
+| `--m3e-segmented-button-selected-container-color`         | Background color of a selected segment.             |
+| `--m3e-segmented-button-selected-container-hover-color`   | Hover state-layer color for selected segments.      |
+| `--m3e-segmented-button-selected-container-focus-color`   | Focus state-layer color for selected segments.      |
+| `--m3e-segmented-button-selected-ripple-color`            | Ripple color for selected segments.                 |
+| `--m3e-segmented-button-selected-label-text-color`        | Label text color for selected segments.             |
+| `--m3e-segmented-button-selected-icon-color`              | Icon color for selected segments.                   |
+| `--m3e-segmented-button-unselected-container-hover-color` | Hover state-layer color for unselected segments.    |
+| `--m3e-segmented-button-unselected-container-focus-color` | Focus state-layer color for unselected segments.    |
+| `--m3e-segmented-button-unselected-ripple-color`          | Ripple color for unselected segments.               |
+| `--m3e-segmented-button-unselected-label-text-color`      | Label text color for unselected segments.           |
+| `--m3e-segmented-button-unselected-icon-color`            | Icon color for unselected segments.                 |
+| `--m3e-segmented-button-disabled-outline-color`           | Base color for disabled segment borders.            |
+| `--m3e-segmented-button-disabled-outline-opacity`         | Opacity applied to disabled segment borders.        |
+| `--m3e-segmented-button-disabled-label-text-color`        | Base color for disabled label text.                 |
+| `--m3e-segmented-button-disabled-label-text-opacity`      | Opacity applied to disabled label text.             |
+| `--m3e-segmented-button-disabled-icon-color`              | Base color for disabled icons.                      |
+| `--m3e-segmented-button-disabled-icon-opacity`            | Opacity applied to disabled icons.                  |
+
+## 🤝 Contributing
+
+See the root monorepo `CONTRIBUTING.md` for guidelines on contributing to this package.
+
+## 📄 License
+
+This package is licensed under the MIT License.

package/cem.config.mjs

@@ -0,0 +1,16 @@
+import { customElementVsCodePlugin } from "custom-element-vs-code-integration";
+
+export default {
+  globs: ["src/**/*.ts"],
+  exclude: ["src/**/*.spec.ts"],
+  packagejson: true,
+  outdir: "dist",
+  litelement: true,
+  plugins: [
+    customElementVsCodePlugin({
+      outdir: "dist",
+      htmlFileName: "html-custom-data.json",
+      cssFileName: "css-custom-data.json",
+    }),
+  ],
+};

package/demo/index.html

@@ -0,0 +1,105 @@
+<!doctype html>
+<html lang="en" style="overflow-y: auto">
+  <head>
+    <title>Segmented Button for M3E</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="description" content="Segmented Button for M3E" />
+    <base href="./" />
+    <link rel="preconnect" href="https://fonts.googleapis.com" />
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
+    <link
+      href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100..900;1,100..900&display=swap"
+      rel="stylesheet"
+    />
+    <link
+      href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0..1,0"
+      rel="stylesheet"
+    />
+    <script type="importmap">
+      {
+        "imports": {
+          "lit": "https://cdn.jsdelivr.net/npm/lit@3.3.0/+esm",
+          "@m3e/core": "../../core/dist/index.min.js",
+          "@m3e/core/a11y": "../../core/dist/a11y.min.js"
+        }
+      }
+    </script>
+    <script type="module" src="../../icon/dist/index.min.js"></script>
+    <script type="module" src="../../theme/dist/index.min.js"></script>
+    <script type="module" src="../dist/index.min.js"></script>
+    <style>
+      body {
+        font-family: "Roboto";
+      }
+      *:not(:defined) {
+        display: none;
+      }
+    </style>
+  </head>
+  <body>
+    <m3e-theme strong-focus>
+      <m3e-segmented-button>
+        <m3e-button-segment checked>8 oz</m3e-button-segment>
+        <m3e-button-segment>12 oz</m3e-button-segment>
+        <m3e-button-segment>16 oz</m3e-button-segment>
+        <m3e-button-segment>20 oz</m3e-button-segment>
+      </m3e-segmented-button>
+      <br /><br />
+      <m3e-segmented-button>
+        <m3e-button-segment checked><m3e-icon slot="icon" name="home"></m3e-icon>8 oz</m3e-button-segment>
+        <m3e-button-segment><m3e-icon slot="icon" name="home"></m3e-icon>12 oz</m3e-button-segment>
+        <m3e-button-segment><m3e-icon slot="icon" name="home"></m3e-icon>16 oz</m3e-button-segment>
+        <m3e-button-segment><m3e-icon slot="icon" name="home"></m3e-icon>20 oz</m3e-button-segment>
+      </m3e-segmented-button>
+      <br /><br />
+      <m3e-segmented-button disabled>
+        <m3e-button-segment checked>8 oz</m3e-button-segment>
+        <m3e-button-segment>12 oz</m3e-button-segment>
+        <m3e-button-segment>16 oz</m3e-button-segment>
+        <m3e-button-segment>20 oz</m3e-button-segment>
+      </m3e-segmented-button>
+      <br /><br />
+      <m3e-segmented-button>
+        <m3e-button-segment checked>8 oz</m3e-button-segment>
+        <m3e-button-segment disabled>12 oz</m3e-button-segment>
+        <m3e-button-segment>16 oz</m3e-button-segment>
+        <m3e-button-segment>20 oz</m3e-button-segment>
+      </m3e-segmented-button>
+      <m3e-segmented-button multi>
+        <m3e-button-segment checked>$</m3e-button-segment>
+        <m3e-button-segment checked>$$</m3e-button-segment>
+        <m3e-button-segment>$$$</m3e-button-segment>
+        <m3e-button-segment>$$$$</m3e-button-segment>
+      </m3e-segmented-button>
+      <br /><br />
+      <m3e-segmented-button hide-selection-indicator>
+        <m3e-button-segment checked>$</m3e-button-segment>
+        <m3e-button-segment checked>$$</m3e-button-segment>
+        <m3e-button-segment>$$$</m3e-button-segment>
+        <m3e-button-segment>$$$$</m3e-button-segment>
+      </m3e-segmented-button>
+      <br /><br />
+      <m3e-segmented-button style="--md-sys-density-scale: -1">
+        <m3e-button-segment checked>8 oz</m3e-button-segment>
+        <m3e-button-segment>12 oz</m3e-button-segment>
+        <m3e-button-segment>16 oz</m3e-button-segment>
+        <m3e-button-segment>20 oz</m3e-button-segment>
+      </m3e-segmented-button>
+      <br /><br />
+      <m3e-segmented-button style="--md-sys-density-scale: -2">
+        <m3e-button-segment checked>8 oz</m3e-button-segment>
+        <m3e-button-segment>12 oz</m3e-button-segment>
+        <m3e-button-segment>16 oz</m3e-button-segment>
+        <m3e-button-segment>20 oz</m3e-button-segment>
+      </m3e-segmented-button>
+      <br /><br />
+      <m3e-segmented-button style="--md-sys-density-scale: -3">
+        <m3e-button-segment checked>8 oz</m3e-button-segment>
+        <m3e-button-segment>12 oz</m3e-button-segment>
+        <m3e-button-segment>16 oz</m3e-button-segment>
+        <m3e-button-segment>20 oz</m3e-button-segment>
+      </m3e-segmented-button>
+    </m3e-theme>
+  </body>
+</html>

package/dist/css-custom-data.json

@@ -0,0 +1,162 @@
+{
+  "$schema": "https://raw.githubusercontent.com/microsoft/vscode-css-languageservice/main/docs/customData.schema.json",
+  "version": 1.1,
+  "properties": [
+    {
+      "name": "--m3e-segmented-button-height",
+      "description": "Total height of the segmented button.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-outline-thickness",
+      "description": "Thickness of the button’s border.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-outline-color",
+      "description": "Color of the button’s border.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-padding-start",
+      "description": "Padding on the leading edge of the button content.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-padding-end",
+      "description": "Padding on the trailing edge of the button content.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-spacing",
+      "description": "Horizontal gap between icon and label.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-font-size",
+      "description": "Font size of the label text.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-font-weight",
+      "description": "Font weight of the label text.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-line-height",
+      "description": "Line height of the label text.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-tracking",
+      "description": "Letter spacing of the label text.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-with-icon-padding-start",
+      "description": "Leading padding when an icon is present.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-selected-container-color",
+      "description": "Background color of a selected segment.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-selected-container-hover-color",
+      "description": "Hover state-layer color for selected segments.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-selected-container-focus-color",
+      "description": "Focus state-layer color for selected segments.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-selected-ripple-color",
+      "description": "Ripple color for selected segments.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-selected-label-text-color",
+      "description": "Label text color for selected segments.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-selected-icon-color",
+      "description": "Icon color for selected segments.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-unselected-container-hover-color",
+      "description": "Hover state-layer color for unselected segments.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-unselected-container-focus-color",
+      "description": "Focus state-layer color for unselected segments.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-unselected-ripple-color",
+      "description": "Ripple color for unselected segments.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-unselected-label-text-color",
+      "description": "Label text color for unselected segments.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-unselected-icon-color",
+      "description": "Icon color for unselected segments.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-icon-size",
+      "description": "Font size of the icon.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-disabled-outline-color",
+      "description": "Base color for disabled segment borders.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-disabled-outline-opacity",
+      "description": "Opacity applied to disabled segment borders.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-disabled-label-text-color",
+      "description": "Base color for disabled label text.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-disabled-label-text-opacity",
+      "description": "Opacity applied to disabled label text.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-disabled-icon-color",
+      "description": "Base color for disabled icons.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-disabled-icon-opacity",
+      "description": "Opacity applied to disabled icons.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-start-shape",
+      "description": "Border radius for the first segment in a segmented button.",
+      "values": []
+    },
+    {
+      "name": "--m3e-segmented-button-end-shape",
+      "description": "Border radius for the last segment in a segmented button.",
+      "values": []
+    }
+  ],
+  "pseudoElements": []
+}