@edux-design/buttons 0.3.0 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @edux-design/buttons
 
+## 0.3.1
+
+### Patch Changes
+
+- Correct ButtonGroupItem declarations to describe its render-null option marker and seven existing fields. DOM refs and handlers remain on Button or ButtonGroup; JavaScript behaviour is unchanged.
+
 ## 0.3.0
 
 ### Minor Changes

package/dist/index.d.mts

@@ -207,10 +207,59 @@ type ButtonGroupProps = Omit<React.HTMLAttributes<HTMLDivElement>, "onChange" |
     isStretched?: boolean;
 };
 
-declare function ButtonGroupItem(_props: any): any;
+/**
+ * Option marker consumed by ButtonGroup; it does not render a DOM element.
+ *
+ * @typedef {Object} ButtonGroupItemProps
+ * @property {React.ReactNode} [children] - Label used when label is omitted.
+ * @property {React.ReactNode} [label] - Main label for the option.
+ * @property {React.ReactNode} [startAdornment] - Optional leading element.
+ * @property {React.ReactNode} [endAdornment] - Optional trailing element.
+ * @property {React.ReactNode} [endIcon] - Legacy trailing-element alias.
+ * @property {string|number} [value] - Selection value; defaults to the option index.
+ * @property {boolean} [disabled] - Whether the option is disabled.
+ */
+/**
+ * @param {ButtonGroupItemProps} _props
+ * @returns {null}
+ */
+declare function ButtonGroupItem(_props: ButtonGroupItemProps): null;
 declare namespace ButtonGroupItem {
     let displayName: string;
 }
+/**
+ * Option marker consumed by ButtonGroup; it does not render a DOM element.
+ */
+type ButtonGroupItemProps = {
+    /**
+     * - Label used when label is omitted.
+     */
+    children?: React.ReactNode;
+    /**
+     * - Main label for the option.
+     */
+    label?: React.ReactNode;
+    /**
+     * - Optional leading element.
+     */
+    startAdornment?: React.ReactNode;
+    /**
+     * - Optional trailing element.
+     */
+    endAdornment?: React.ReactNode;
+    /**
+     * - Legacy trailing-element alias.
+     */
+    endIcon?: React.ReactNode;
+    /**
+     * - Selection value; defaults to the option index.
+     */
+    value?: string | number;
+    /**
+     * - Whether the option is disabled.
+     */
+    disabled?: boolean;
+};
 
 /**
  * ButtonCounter (stepper) component.

package/dist/index.d.ts

@@ -207,10 +207,59 @@ type ButtonGroupProps = Omit<React.HTMLAttributes<HTMLDivElement>, "onChange" |
     isStretched?: boolean;
 };
 
-declare function ButtonGroupItem(_props: any): any;
+/**
+ * Option marker consumed by ButtonGroup; it does not render a DOM element.
+ *
+ * @typedef {Object} ButtonGroupItemProps
+ * @property {React.ReactNode} [children] - Label used when label is omitted.
+ * @property {React.ReactNode} [label] - Main label for the option.
+ * @property {React.ReactNode} [startAdornment] - Optional leading element.
+ * @property {React.ReactNode} [endAdornment] - Optional trailing element.
+ * @property {React.ReactNode} [endIcon] - Legacy trailing-element alias.
+ * @property {string|number} [value] - Selection value; defaults to the option index.
+ * @property {boolean} [disabled] - Whether the option is disabled.
+ */
+/**
+ * @param {ButtonGroupItemProps} _props
+ * @returns {null}
+ */
+declare function ButtonGroupItem(_props: ButtonGroupItemProps): null;
 declare namespace ButtonGroupItem {
     let displayName: string;
 }
+/**
+ * Option marker consumed by ButtonGroup; it does not render a DOM element.
+ */
+type ButtonGroupItemProps = {
+    /**
+     * - Label used when label is omitted.
+     */
+    children?: React.ReactNode;
+    /**
+     * - Main label for the option.
+     */
+    label?: React.ReactNode;
+    /**
+     * - Optional leading element.
+     */
+    startAdornment?: React.ReactNode;
+    /**
+     * - Optional trailing element.
+     */
+    endAdornment?: React.ReactNode;
+    /**
+     * - Legacy trailing-element alias.
+     */
+    endIcon?: React.ReactNode;
+    /**
+     * - Selection value; defaults to the option index.
+     */
+    value?: string | number;
+    /**
+     * - Whether the option is disabled.
+     */
+    disabled?: boolean;
+};
 
 /**
  * ButtonCounter (stepper) component.

package/docs/button-group.md

@@ -0,0 +1,25 @@
+# ButtonGroup option types
+
+`ButtonGroupItem` is an option marker read by `ButtonGroup`. It accepts `value`
+(string or number), `disabled` (boolean), `label`, `children`, `startAdornment`,
+`endAdornment`, and the legacy `endIcon` alias. Omitted values use the option's
+index. The label falls back to children, then an automatically numbered label.
+
+The marker renders no DOM element. It does not forward a ref, native button
+attributes, or event handlers. Put selection handling on `ButtonGroup.onChange`,
+which receives the selected value and option. The group forwards a div ref and
+native div attributes. Use `Button` for a native button ref, attributes, and events.
+
+```tsx
+<ButtonGroup defaultValue="draft" onChange={(value) => setFilter(value)}>
+  <ButtonGroupItem value="draft">Draft</ButtonGroupItem>
+  <ButtonGroupItem value="published" endAdornment={<span>3</span>}>
+    Published
+  </ButtonGroupItem>
+  <ButtonGroupItem value="archived" disabled>Archived</ButtonGroupItem>
+</ButtonGroup>
+```
+
+The package-local `test/button-group-api.tsx` fixture checks the public entry point
+under strict TypeScript, including no-`any` assertions, native button refs/events,
+selection values, disabled options, and rejection of unsupported marker props.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edux-design/buttons",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "private": false,
   "sideEffects": [
     "**/*.css"
@@ -25,8 +25,6 @@
     "dist",
     "docs",
     "README.md",
-    "CHANGELOG.md",
-    "LICENSE",
-    "LICENSE.md"
+    "CHANGELOG.md"
   ]
 }