@m3e/slide-group 1.0.0-rc.2 → 1.0.0-rc.3

package/dist/custom-elements.json

@@ -1103,25 +1103,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",
@@ -1419,6 +1400,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",

package/dist/src/SlideGroupElement.d.ts

@@ -0,0 +1,87 @@
+import { CSSResultGroup, LitElement, PropertyValues } from "lit";
+/**
+ * Presents pagination controls used to scroll overflowing content.
+ *
+ * @description
+ * The `m3e-slide-group` component presents directional pagination controls for navigating overflowing content.
+ * It orchestrates scrollable layouts with expressive slot-based icons and adaptive orientation, revealing navigation
+ * affordances only when content exceeds a defined threshold.  It supports both horizontal and vertical flows, and
+ * encodes accessibility through customizable labels and interaction states.
+ *
+ * @example
+ * The following example illustrates a horizontally scrollable group of items with directional pagination buttons.
+ * The scroll controls appear when content exceeds the `48px` threshold.
+ * ```html
+ * <m3e-slide-group threshold="48">
+ *  <div>Item 1</div>
+ *  <div>Item 2</div>
+ *  <div>Item 3</div>
+ *  <div>Item 4</div>
+ *  <div>Item 5</div>
+ * </m3e-slide-group>
+ * ```
+ *
+ * @tag m3e-slide-group
+ *
+ * @slot - Renders the content to paginate.
+ * @slot next-icon - Renders the icon to present for the next button.
+ * @slot prev-icon - Renders the icon to present for the previous button.
+ *
+ * @attr disabled - Whether scroll buttons are disabled.
+ * @attr next-page-label - The accessible label given to the button used to move to the previous page.
+ * @attr previous-page-label - The accessible label given to the button used to move to the next page.
+ * @attr threshold - A value, in pixels, indicating the scroll threshold at which to begin showing pagination controls.
+ * @attr vertical - Whether content is oriented vertically.
+ *
+ * @cssprop --m3e-slide-group-button-icon-size - Sets icon size for scroll buttons; overrides default small icon size.
+ * @cssprop --m3e-slide-group-button-size - Defines scroll button size; used for width (horizontal) or height (vertical).
+ * @cssprop --m3e-slide-group-divider-top - Adds top border to content container for visual separation.
+ * @cssprop --m3e-slide-group-divider-bottom - Adds bottom border to content container for visual separation.
+ */
+export declare class M3eSlideGroupElement extends LitElement {
+    #private;
+    /** The styles of the element. */
+    static styles: CSSResultGroup;
+    /** @internal A reference to the container used to scroll content. */
+    scrollContainer: HTMLElement;
+    /** @private */ private _canPage;
+    /** @private */ private _canPageStart;
+    /** @private */ private _canPageEnd;
+    /**
+     * Whether scroll buttons are disabled.
+     * @default false
+     */
+    disabled: boolean;
+    /**
+     * Whether content is oriented vertically.
+     * @default false
+     */
+    vertical: boolean;
+    /**
+     * A value, in pixels, indicating the scroll threshold at which to begin showing pagination controls.
+     * @default 0
+     */
+    threshold: number;
+    /**
+     * The accessible label given to the button used to move to the previous page.
+     * @default "Previous page"
+     */
+    previousPageLabel: string;
+    /**
+     * The accessible label given to the button used to move to the next page.
+     * @default "Next page"
+     */
+    nextPageLabel: string;
+    /** @inheritdoc */
+    protected firstUpdated(_changedProperties: PropertyValues): void;
+    /** @inheritdoc */
+    protected render(): unknown;
+    /** @private */
+    private _updatePaging;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "m3e-slide-group": M3eSlideGroupElement;
+    }
+}
+//# sourceMappingURL=SlideGroupElement.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SlideGroupElement.d.ts","sourceRoot":"","sources":["../../src/SlideGroupElement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,cAAc,EAAQ,UAAU,EAAW,cAAc,EAAE,MAAM,KAAK,CAAC;AAKrF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,qBACa,oBAAqB,SAAQ,UAAU;;IAClD,iCAAiC;IACjC,OAAgB,MAAM,EAAE,cAAc,CAiDpC;IAQF,qEAAqE;IAClD,eAAe,EAAG,WAAW,CAAC;IAEjD,eAAe,CAAU,OAAO,CAAC,QAAQ,CAAS;IAClD,eAAe,CAAU,OAAO,CAAC,aAAa,CAAS;IACvD,eAAe,CAAU,OAAO,CAAC,WAAW,CAAS;IAErD;;;OAGG;IACyC,QAAQ,UAAS;IAE7D;;;OAGG;IACyC,QAAQ,UAAS;IAE7D;;;OAGG;IACyB,SAAS,SAAK;IAE1C;;;OAGG;IAC6C,iBAAiB,SAAmB;IAEpF;;;OAGG;IACyC,aAAa,SAAe;IAExE,kBAAkB;cACC,YAAY,CAAC,kBAAkB,EAAE,cAAc,GAAG,IAAI;IAKzE,kBAAkB;cACC,MAAM,IAAI,OAAO;IAoEpC,eAAe;IAEf,OAAO,CAAC,aAAa;CA2BtB;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,iBAAiB,EAAE,oBAAoB,CAAC;KACzC;CACF"}

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./SlideGroupElement";
+//# 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,qBAAqB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@m3e/slide-group",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.0-rc.3",
   "description": "Slide Group 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/icon-button": "1.0.0-rc.2",
+    "@m3e/core": "1.0.0-rc.3",
+    "@m3e/icon-button": "1.0.0-rc.3",
     "lit": "^3.3.0"
   },
   "devDependencies": {