@xmesh/system-design 0.0.4 → 0.0.6

package/dist/react/XmProgress.d.ts

@@ -0,0 +1,75 @@
+import React from "react";
+import { XmProgress as XmProgressElement } from "../lit/components/progress/index.js";
+
+export type { XmProgressElement };
+
+export interface XmProgressProps extends Pick<
+  React.AllHTMLAttributes<HTMLElement>,
+  | "children"
+  | "dir"
+  | "hidden"
+  | "id"
+  | "lang"
+  | "slot"
+  | "style"
+  | "title"
+  | "translate"
+  | "onClick"
+  | "onFocus"
+  | "onBlur"
+> {
+  /** undefined */
+  indeterminate?: boolean;
+
+  /** undefined */
+  showLabel?: boolean;
+
+  /** undefined */
+  variant?: XmProgressElement["variant"];
+
+  /** undefined */
+  value?: XmProgressElement["value"];
+
+  /** undefined */
+  size?: XmProgressElement["size"];
+
+  /** undefined */
+  label?: XmProgressElement["label"];
+
+  /** A space-separated list of the classes of the element. Classes allows CSS and JavaScript to select and access specific elements via the class selectors or functions like the method `Document.getElementsByClassName()`. */
+  className?: string;
+
+  /** Contains a space-separated list of the part names of the element that should be exposed on the host element. */
+  exportparts?: string;
+
+  /** Used for labels to link them with their inputs (using input id). */
+  htmlFor?: string;
+
+  /** Used to help React identify which items have changed, are added, or are removed within a list. */
+  key?: number | string;
+
+  /** Contains a space-separated list of the part names of the element. Part names allows CSS to select and style specific elements in a shadow tree via the ::part pseudo-element. */
+  part?: string;
+
+  /** A mutable ref object whose `.current` property is initialized to the passed argument (`initialValue`). The returned object will persist for the full lifetime of the component. */
+  ref?: React.Ref<XmProgressElement>;
+
+  /** Allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the `Tab` key, hence the name) and determine their relative ordering for sequential focus navigation. */
+  tabIndex?: number;
+}
+
+/**
+ *
+ *
+ * ## Attributes & Properties
+ *
+ * Component attributes and properties that can be applied to the element or by using JavaScript.
+ *
+ * - `variant`: undefined
+ * - `value`: undefined
+ * - `indeterminate`: undefined
+ * - `size`: undefined
+ * - `label`: undefined
+ * - `show-label`/`showLabel`: undefined
+ */
+export const XmProgress: React.ForwardRefExoticComponent<XmProgressProps>;

package/dist/react/XmProgress.js

@@ -0,0 +1,42 @@
+import React, { forwardRef, useRef } from "react";
+import "../lit/components/progress/index.js";
+import { createForwardedRefHandler } from "./react-utils.js";
+
+export const XmProgress = forwardRef((props, forwardedRef) => {
+  const ref = useRef(null);
+  const {
+    indeterminate,
+    showLabel,
+    variant,
+    value,
+    size,
+    label,
+    className,
+    exportparts,
+    htmlFor,
+    part,
+    tabIndex,
+    ...restProps
+  } = props;
+
+  return React.createElement(
+    "xm-progress",
+    {
+      ref: createForwardedRefHandler(ref, forwardedRef),
+      ...restProps,
+      variant: variant,
+      value: value,
+      size: size,
+      label: label,
+      class: className,
+      exportparts: exportparts,
+      for: htmlFor ?? props["for"],
+      part: part,
+      tabindex: tabIndex ?? props["tabindex"],
+      indeterminate: indeterminate ? true : undefined,
+      "show-label": showLabel ? true : undefined,
+      style: { ...props.style },
+    },
+    props.children,
+  );
+});

package/dist/react/XmRadio.d.ts

@@ -0,0 +1,88 @@
+import React from "react";
+import { XmRadio as XmRadioElement } from "../lit/components/radio-group/index.js";
+
+/**
+ * A generic type for strongly typing custom events with their targets
+ * @template T - The type of the event target (extends EventTarget)
+ * @template D - The type of the detail payload for the custom event
+ */
+type TypedEvent<T extends EventTarget, E = Event> = E & {
+  target: T;
+};
+/** `XmRadio` component event */
+export type XmRadioElementEvent<E = Event> = TypedEvent<XmRadioElement, E>;
+
+export type { XmRadioElement };
+
+export interface XmRadioProps extends Pick<
+  React.AllHTMLAttributes<HTMLElement>,
+  | "children"
+  | "dir"
+  | "hidden"
+  | "id"
+  | "lang"
+  | "slot"
+  | "style"
+  | "title"
+  | "translate"
+  | "onClick"
+  | "onFocus"
+  | "onBlur"
+> {
+  /** Own disabled — OR'd with the group's disabled by the group. */
+  disabled?: boolean;
+
+  /** Driven by the group; never set directly by authors. */
+  checked?: boolean;
+
+  /** Effective disabled the group computes (group OR own). */
+  groupDisabled?: boolean;
+
+  /** The primitive value this radio contributes to the group when selected. */
+  value?: XmRadioElement["value"];
+
+  /** A space-separated list of the classes of the element. Classes allows CSS and JavaScript to select and access specific elements via the class selectors or functions like the method `Document.getElementsByClassName()`. */
+  className?: string;
+
+  /** Contains a space-separated list of the part names of the element that should be exposed on the host element. */
+  exportparts?: string;
+
+  /** Used for labels to link them with their inputs (using input id). */
+  htmlFor?: string;
+
+  /** Used to help React identify which items have changed, are added, or are removed within a list. */
+  key?: number | string;
+
+  /** Contains a space-separated list of the part names of the element. Part names allows CSS to select and style specific elements in a shadow tree via the ::part pseudo-element. */
+  part?: string;
+
+  /** A mutable ref object whose `.current` property is initialized to the passed argument (`initialValue`). The returned object will persist for the full lifetime of the component. */
+  ref?: React.Ref<XmRadioElement>;
+
+  /** Allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the `Tab` key, hence the name) and determine their relative ordering for sequential focus navigation. */
+  tabIndex?: number;
+
+  /** Fired on commit with the new value in `detail`. */
+  onChange?: (event: XmRadioElementEvent) => void;
+}
+
+/**
+ *
+ *
+ * ## Attributes & Properties
+ *
+ * Component attributes and properties that can be applied to the element or by using JavaScript.
+ *
+ * - `value`: The primitive value this radio contributes to the group when selected.
+ * - `disabled`: Own disabled — OR'd with the group's disabled by the group.
+ * - `checked`: Driven by the group; never set directly by authors.
+ * - `group-disabled`/`groupDisabled`: Effective disabled the group computes (group OR own).
+ * - `effectiveDisabled`: undefined (property only) (readonly)
+ *
+ * ## Events
+ *
+ * Events that will be emitted by the component.
+ *
+ * - `change`: Fired on commit with the new value in `detail`.
+ */
+export const XmRadio: React.ForwardRefExoticComponent<XmRadioProps>;

package/dist/react/XmRadio.js

@@ -0,0 +1,42 @@
+import React, { forwardRef, useRef } from "react";
+import "../lit/components/radio-group/index.js";
+import { useEventListener, createForwardedRefHandler } from "./react-utils.js";
+
+export const XmRadio = forwardRef((props, forwardedRef) => {
+  const ref = useRef(null);
+  const {
+    disabled,
+    checked,
+    groupDisabled,
+    value,
+    className,
+    exportparts,
+    htmlFor,
+    part,
+    tabIndex,
+    onChange,
+    ...restProps
+  } = props;
+
+  /** Event listeners - run once */
+  useEventListener(ref, "change", props.onChange);
+
+  return React.createElement(
+    "xm-radio",
+    {
+      ref: createForwardedRefHandler(ref, forwardedRef),
+      ...restProps,
+      value: value,
+      class: className,
+      exportparts: exportparts,
+      for: htmlFor ?? props["for"],
+      part: part,
+      tabindex: tabIndex ?? props["tabindex"],
+      disabled: disabled ? true : undefined,
+      checked: checked ? true : undefined,
+      "group-disabled": groupDisabled ? true : undefined,
+      style: { ...props.style },
+    },
+    props.children,
+  );
+});

package/dist/react/XmRadioGroup.d.ts

@@ -0,0 +1,139 @@
+import React from "react";
+import {
+  XmRadioGroup as XmRadioGroupElement,
+  CustomEvent,
+} from "../lit/components/radio-group/index.js";
+
+/**
+ * A generic type for strongly typing custom events with their targets
+ * @template T - The type of the event target (extends EventTarget)
+ * @template D - The type of the detail payload for the custom event
+ */
+type TypedEvent<T extends EventTarget, E = Event> = E & {
+  target: T;
+};
+/** `XmRadioGroup` component event */
+export type XmRadioGroupElementEvent<E = Event> = TypedEvent<
+  XmRadioGroupElement,
+  E
+>;
+
+export type { XmRadioGroupElement, CustomEvent };
+
+export interface XmRadioGroupProps extends Pick<
+  React.AllHTMLAttributes<HTMLElement>,
+  | "children"
+  | "dir"
+  | "hidden"
+  | "id"
+  | "lang"
+  | "slot"
+  | "style"
+  | "title"
+  | "translate"
+  | "onClick"
+  | "onFocus"
+  | "onBlur"
+> {
+  /** undefined */
+  required?: boolean;
+
+  /** undefined */
+  disabled?: boolean;
+
+  /** undefined */
+  readOnly?: boolean;
+
+  /** undefined */
+  loading?: boolean;
+
+  /** INITIAL checked for toggle subclasses; mapped from attribute `checked`. */
+  initialChecked?: boolean;
+
+  /** undefined */
+  label?: XmRadioGroupElement["label"];
+
+  /** undefined */
+  helper?: XmRadioGroupElement["helper"];
+
+  /** Severity copy. Non-empty ⇒ the field is in error (icon + copy, never color). */
+  error?: XmRadioGroupElement["error"];
+
+  /** undefined */
+  size?: XmRadioGroupElement["size"];
+
+  /** Form-control name — mirrors native <input name>. */
+  name?: XmRadioGroupElement["name"];
+
+  /** INITIAL value (uncontrolled-first, AD-6): the `value` attribute seeds the
+live state once, then never overrides user input. Mapped from attribute
+`value` so authors write `<xm-text-field value="…">`. */
+  initialValue?: XmRadioGroupElement["initialValue"];
+
+  /** A space-separated list of the classes of the element. Classes allows CSS and JavaScript to select and access specific elements via the class selectors or functions like the method `Document.getElementsByClassName()`. */
+  className?: string;
+
+  /** Contains a space-separated list of the part names of the element that should be exposed on the host element. */
+  exportparts?: string;
+
+  /** Used for labels to link them with their inputs (using input id). */
+  htmlFor?: string;
+
+  /** Used to help React identify which items have changed, are added, or are removed within a list. */
+  key?: number | string;
+
+  /** Contains a space-separated list of the part names of the element. Part names allows CSS to select and style specific elements in a shadow tree via the ::part pseudo-element. */
+  part?: string;
+
+  /** A mutable ref object whose `.current` property is initialized to the passed argument (`initialValue`). The returned object will persist for the full lifetime of the component. */
+  ref?: React.Ref<XmRadioGroupElement>;
+
+  /** Allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the `Tab` key, hence the name) and determine their relative ordering for sequential focus navigation. */
+  tabIndex?: number;
+
+  /** Fired on commit with the new value in `detail` (inherited by every field). */
+  onChange?: (event: XmRadioGroupElementEvent) => void;
+
+  /** Fired on each edit with the current value in `detail` (inherited by every field). */
+  onInput?: (event: XmRadioGroupElementEvent) => void;
+}
+
+/**
+ *
+ *
+ * ## Attributes & Properties
+ *
+ * Component attributes and properties that can be applied to the element or by using JavaScript.
+ *
+ * - `label`: undefined
+ * - `helper`: undefined
+ * - `error`: Severity copy. Non-empty ⇒ the field is in error (icon + copy, never color).
+ * - `size`: undefined
+ * - `required`: undefined
+ * - `disabled`: undefined
+ * - `readonly`/`readOnly`: undefined
+ * - `loading`: undefined
+ * - `name`: Form-control name — mirrors native <input name>.
+ * - `value`/`initialValue`: INITIAL value (uncontrolled-first, AD-6): the `value` attribute seeds the
+ * live state once, then never overrides user input. Mapped from attribute
+ * `value` so authors write `<xm-text-field value="…">`.
+ * - `checked`/`initialChecked`: INITIAL checked for toggle subclasses; mapped from attribute `checked`.
+ * - `readonly`: undefined (property only)
+ * - `value`: Programmatic reset support — setting `value` after first paint updates live state. (property only)
+ * - `checked`: Public read contract for toggle subclasses (AD-6a). (property only)
+ *
+ * ## Events
+ *
+ * Events that will be emitted by the component.
+ *
+ * - `change`: Fired on commit with the new value in `detail` (inherited by every field).
+ * - `input`: Fired on each edit with the current value in `detail` (inherited by every field).
+ *
+ * ## Methods
+ *
+ * Methods that can be called to access component functionality.
+ *
+ * - `setFormDisabled(disabled: boolean) => void`: Down-propagation hook: xm-form (Story 2.10) sets this; it OR's with the
+ * field's own disabled and can never re-enable a self-disabled field.
+ */
+export const XmRadioGroup: React.ForwardRefExoticComponent<XmRadioGroupProps>;

package/dist/react/XmRadioGroup.js

@@ -0,0 +1,58 @@
+import React, { forwardRef, useRef } from "react";
+import "../lit/components/radio-group/index.js";
+import { useEventListener, createForwardedRefHandler } from "./react-utils.js";
+
+export const XmRadioGroup = forwardRef((props, forwardedRef) => {
+  const ref = useRef(null);
+  const {
+    required,
+    disabled,
+    readOnly,
+    loading,
+    initialChecked,
+    label,
+    helper,
+    error,
+    size,
+    name,
+    initialValue,
+    className,
+    exportparts,
+    htmlFor,
+    part,
+    tabIndex,
+    onChange,
+    onInput,
+    ...restProps
+  } = props;
+
+  /** Event listeners - run once */
+  useEventListener(ref, "change", props.onChange);
+  useEventListener(ref, "input", props.onInput);
+
+  return React.createElement(
+    "xm-radio-group",
+    {
+      ref: createForwardedRefHandler(ref, forwardedRef),
+      ...restProps,
+      label: label,
+      helper: helper,
+      error: error,
+      size: size,
+      name: name,
+      value: initialValue ?? props["value"],
+      class: className,
+      exportparts: exportparts,
+      for: htmlFor ?? props["for"],
+      part: part,
+      tabindex: tabIndex ?? props["tabindex"],
+      required: required ? true : undefined,
+      disabled: disabled ? true : undefined,
+      readonly: readOnly ? true : undefined,
+      loading: loading ? true : undefined,
+      checked: initialChecked ? true : undefined,
+      style: { ...props.style },
+    },
+    props.children,
+  );
+});

package/dist/react/XmSelect.d.ts

@@ -0,0 +1,152 @@
+import React from "react";
+import {
+  XmSelect as XmSelectElement,
+  CustomEvent,
+} from "../lit/components/select/index.js";
+
+/**
+ * A generic type for strongly typing custom events with their targets
+ * @template T - The type of the event target (extends EventTarget)
+ * @template D - The type of the detail payload for the custom event
+ */
+type TypedEvent<T extends EventTarget, E = Event> = E & {
+  target: T;
+};
+/** `XmSelect` component event */
+export type XmSelectElementEvent<E = Event> = TypedEvent<XmSelectElement, E>;
+
+export type { XmSelectElement, CustomEvent };
+
+export interface XmSelectProps extends Pick<
+  React.AllHTMLAttributes<HTMLElement>,
+  | "children"
+  | "dir"
+  | "hidden"
+  | "id"
+  | "lang"
+  | "slot"
+  | "style"
+  | "title"
+  | "translate"
+  | "onClick"
+  | "onFocus"
+  | "onBlur"
+> {
+  /** undefined */
+  required?: boolean;
+
+  /** undefined */
+  disabled?: boolean;
+
+  /** undefined */
+  readOnly?: boolean;
+
+  /** undefined */
+  loading?: boolean;
+
+  /** INITIAL checked for toggle subclasses; mapped from attribute `checked`. */
+  initialChecked?: boolean;
+
+  /** Shown on the closed control when nothing is selected. */
+  placeholder?: XmSelectElement["placeholder"];
+
+  /** undefined */
+  label?: XmSelectElement["label"];
+
+  /** undefined */
+  helper?: XmSelectElement["helper"];
+
+  /** Severity copy. Non-empty ⇒ the field is in error (icon + copy, never color). */
+  error?: XmSelectElement["error"];
+
+  /** undefined */
+  size?: XmSelectElement["size"];
+
+  /** Form-control name — mirrors native <input name>. */
+  name?: XmSelectElement["name"];
+
+  /** INITIAL value (uncontrolled-first, AD-6): the `value` attribute seeds the
+live state once, then never overrides user input. Mapped from attribute
+`value` so authors write `<xm-text-field value="…">`. */
+  initialValue?: XmSelectElement["initialValue"];
+
+  /** A space-separated list of the classes of the element. Classes allows CSS and JavaScript to select and access specific elements via the class selectors or functions like the method `Document.getElementsByClassName()`. */
+  className?: string;
+
+  /** Contains a space-separated list of the part names of the element that should be exposed on the host element. */
+  exportparts?: string;
+
+  /** Used for labels to link them with their inputs (using input id). */
+  htmlFor?: string;
+
+  /** Used to help React identify which items have changed, are added, or are removed within a list. */
+  key?: number | string;
+
+  /** Contains a space-separated list of the part names of the element. Part names allows CSS to select and style specific elements in a shadow tree via the ::part pseudo-element. */
+  part?: string;
+
+  /** A mutable ref object whose `.current` property is initialized to the passed argument (`initialValue`). The returned object will persist for the full lifetime of the component. */
+  ref?: React.Ref<XmSelectElement>;
+
+  /** Allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the `Tab` key, hence the name) and determine their relative ordering for sequential focus navigation. */
+  tabIndex?: number;
+
+  /** The option model — `{ label, value, disabled? }` shared across
+select / autocomplete / radio-group so one host handler is safe. */
+  options?: XmSelectElement["options"];
+
+  /** Live read for the closed control + xm-form. The inherited string `value`
+stays in sync; this returns the typed primitive for consumers that want it. */
+  selectedValue?: XmSelectElement["selectedValue"];
+
+  /** Fired on commit with the new value in `detail`. */
+  onChange?: (event: XmSelectElementEvent) => void;
+
+  /** Fired on each edit with the current value in `detail` (inherited by every field). */
+  onInput?: (event: XmSelectElementEvent) => void;
+}
+
+/**
+ *
+ *
+ * ## Attributes & Properties
+ *
+ * Component attributes and properties that can be applied to the element or by using JavaScript.
+ *
+ * - `placeholder`: Shown on the closed control when nothing is selected.
+ * - `label`: undefined
+ * - `helper`: undefined
+ * - `error`: Severity copy. Non-empty ⇒ the field is in error (icon + copy, never color).
+ * - `size`: undefined
+ * - `required`: undefined
+ * - `disabled`: undefined
+ * - `readonly`/`readOnly`: undefined
+ * - `loading`: undefined
+ * - `name`: Form-control name — mirrors native <input name>.
+ * - `value`/`initialValue`: INITIAL value (uncontrolled-first, AD-6): the `value` attribute seeds the
+ * live state once, then never overrides user input. Mapped from attribute
+ * `value` so authors write `<xm-text-field value="…">`.
+ * - `checked`/`initialChecked`: INITIAL checked for toggle subclasses; mapped from attribute `checked`.
+ * - `options`: The option model — `{ label, value, disabled? }` shared across
+ * select / autocomplete / radio-group so one host handler is safe. (property only)
+ * - `selectedValue`: Live read for the closed control + xm-form. The inherited string `value`
+ * stays in sync; this returns the typed primitive for consumers that want it. (property only) (readonly)
+ * - `readonly`: undefined (property only)
+ * - `value`: Programmatic reset support — setting `value` after first paint updates live state. (property only)
+ * - `checked`: Public read contract for toggle subclasses (AD-6a). (property only)
+ *
+ * ## Events
+ *
+ * Events that will be emitted by the component.
+ *
+ * - `change`: Fired on commit with the new value in `detail`.
+ * - `input`: Fired on each edit with the current value in `detail` (inherited by every field).
+ *
+ * ## Methods
+ *
+ * Methods that can be called to access component functionality.
+ *
+ * - `setFormDisabled(disabled: boolean) => void`: Down-propagation hook: xm-form (Story 2.10) sets this; it OR's with the
+ * field's own disabled and can never re-enable a self-disabled field.
+ */
+export const XmSelect: React.ForwardRefExoticComponent<XmSelectProps>;

package/dist/react/XmSelect.js

@@ -0,0 +1,70 @@
+import React, { forwardRef, useRef } from "react";
+import "../lit/components/select/index.js";
+import {
+  useEventListener,
+  useProperties,
+  createForwardedRefHandler,
+} from "./react-utils.js";
+
+export const XmSelect = forwardRef((props, forwardedRef) => {
+  const ref = useRef(null);
+  const {
+    required,
+    disabled,
+    readOnly,
+    loading,
+    initialChecked,
+    placeholder,
+    label,
+    helper,
+    error,
+    size,
+    name,
+    initialValue,
+    className,
+    exportparts,
+    htmlFor,
+    part,
+    tabIndex,
+    options,
+    selectedValue,
+    onChange,
+    onInput,
+    ...restProps
+  } = props;
+
+  /** Event listeners - run once */
+  useEventListener(ref, "change", props.onChange);
+  useEventListener(ref, "input", props.onInput);
+
+  /** Properties - run whenever a property has changed */
+  useProperties(ref, "options", options);
+  useProperties(ref, "selectedValue", selectedValue);
+
+  return React.createElement(
+    "xm-select",
+    {
+      ref: createForwardedRefHandler(ref, forwardedRef),
+      ...restProps,
+      placeholder: placeholder,
+      label: label,
+      helper: helper,
+      error: error,
+      size: size,
+      name: name,
+      value: initialValue ?? props["value"],
+      class: className,
+      exportparts: exportparts,
+      for: htmlFor ?? props["for"],
+      part: part,
+      tabindex: tabIndex ?? props["tabindex"],
+      required: required ? true : undefined,
+      disabled: disabled ? true : undefined,
+      readonly: readOnly ? true : undefined,
+      loading: loading ? true : undefined,
+      checked: initialChecked ? true : undefined,
+      style: { ...props.style },
+    },
+    props.children,
+  );
+});