material 3.2.6 → 3.2.7

package/dist/components/checkbox/constants.d.ts

@@ -1,49 +1,16 @@
-/**
- * Label position options for the checkbox
- *
- * Controls whether the label appears before or after the checkbox.
- *
- * @category Components
- */
 export declare const CHECKBOX_LABEL_POSITION: {
-    /** Label appears before (to the left of) the checkbox */
     readonly START: "start";
-    /** Label appears after (to the right of) the checkbox (default) */
     readonly END: "end";
 };
-/**
- * Checkbox state classes
- *
- * These classes are applied to the checkbox element to reflect its current state.
- * They can be used for styling or for selection in tests.
- *
- * @category Components
- */
 export declare const CHECKBOX_STATES: {
-    /** Applied when the checkbox is checked */
     readonly CHECKED: "checked";
-    /** Applied when the checkbox is in indeterminate state */
     readonly INDETERMINATE: "indeterminate";
-    /** Applied when the checkbox is disabled */
     readonly DISABLED: "disabled";
-    /** Applied when the checkbox has focus */
     readonly FOCUSED: "focused";
 };
-/**
- * Checkbox element classes
- *
- * These classes are applied to different parts of the checkbox component.
- * They follow the BEM naming convention used throughout the library.
- *
- * @category Components
- */
 export declare const CHECKBOX_CLASSES: {
-    /** The main checkbox container element */
     readonly ROOT: "checkbox";
-    /** The actual input element (usually hidden) */
     readonly INPUT: "checkbox__input";
-    /** The visual checkbox icon */
     readonly ICON: "checkbox__icon";
-    /** The text label associated with the checkbox */
     readonly LABEL: "checkbox__label";
 };

package/dist/components/checkbox/index.d.ts

@@ -1,28 +1,3 @@
-/**
- * Checkbox Component Module
- *
- * A Material Design 3 checkbox implementation with support
- * for different variants, indeterminate state, and label positioning.
- *
- * @module components/checkbox
- * @category Components
- */
 export { default, default as createCheckbox } from "./checkbox.js";
 export type { CheckboxConfig, CheckboxComponent, CheckboxEvents, CheckboxChangePayload, CheckboxLabelPosition } from "./types.js";
-/**
- * Constants for checkbox configuration
- *
- * Use these constants instead of string literals for better
- * code completion, type safety, and to follow best practices.
- *
- * @example
- * import { createCheckbox } from 'material';
- *
- * const checkbox = createCheckbox({
- *   label: 'Accept terms',
- *   error: !accepted
- * });
- *
- * @category Components
- */
 export { CHECKBOX_LABEL_POSITION, CHECKBOX_STATES, CHECKBOX_CLASSES } from "./constants.js";

package/dist/components/checkbox/types.d.ts

@@ -1,239 +1,53 @@
 import type { TouchEvents } from "../../core/utils/mobile.js";
 import type { EventCallback } from "../../core/state/emitter.js";
-/**
- * Checkbox label position types - controls where the label appears
- *
- * @category Components
- * @remarks
- * - start: Label appears before (to the left of) the checkbox
- * - end: Label appears after (to the right of) the checkbox (default)
- */
 export type CheckboxLabelPosition = "start" | "end";
-/**
- * Configuration interface for the Checkbox component
- *
- * @category Components
- * @description
- * Defines the appearance and behavior of a checkbox component.
- * All properties are optional with sensible defaults.
- */
 export interface CheckboxConfig {
-    /**
-     * Input name attribute, used for form submission
-     * @example "accept-terms"
-     */
     name?: string;
-    /**
-     * Initial checked state
-     * @default false
-     */
     checked?: boolean;
-    /**
-     * Initial indeterminate state (partially checked)
-     * Used when a checkbox represents a mixed selection state
-     * @default false
-     */
     indeterminate?: boolean;
-    /**
-     * Whether input is required for form validation
-     * @default false
-     */
     required?: boolean;
-    /**
-     * Whether checkbox is disabled (non-interactive)
-     * @default false
-     */
     disabled?: boolean;
-    /**
-     * Input value attribute, used for form submission
-     * @example "true" | "selected" | "1"
-     */
     value?: string;
-    /**
-     * Label text displayed next to the checkbox
-     * @example "Accept terms and conditions"
-     */
     label?: string;
-    /**
-     * Label position (start/end)
-     * Controls whether the label appears before or after the checkbox
-     * @default "end"
-     */
     labelPosition?: CheckboxLabelPosition | string;
-    /**
-     * Error state: the outline, the selected container and the state layers
-     * take the error role, and the input is marked `aria-invalid`.
-     * @default false
-     */
     error?: boolean;
-    /**
-     * Accessible name when there is no visible label
-     */
     ariaLabel?: string;
-    /**
-     * Whether Enter toggles as Space does. Off for a checkbox.
-     * @internal
-     */
     enterToggles?: boolean;
-    /**
-     * Additional CSS classes to apply to the checkbox
-     * @example "terms-checkbox primary-checkbox"
-     */
     class?: string;
-    /**
-     * CSS class prefix for all checkbox classes
-     * @default "mtrl"
-     */
     prefix?: string;
-    /**
-     * Component name used in CSS class generation
-     * @default "checkbox"
-     * @internal
-     */
     componentName?: string;
 }
-/** A checked-state change from native input activation. Public setters are silent. */
 export interface CheckboxChangePayload {
-    /** The new checked state. */
     checked: boolean;
-    /** The checked model value, matching getValue() at dispatch. */
     value: boolean;
-    /** The input's HTML value attribute, used for native form submission. */
     valueAttribute: string;
-    /** The original native change event, when supplied by the emitter. */
     nativeEvent?: Event;
 }
-/** Events emitted by the checkbox API. DOM clicks/focus are not forwarded. */
 export interface CheckboxEvents extends TouchEvents {
     change: (payload: CheckboxChangePayload) => void;
 }
-/**
- * Checkbox component interface
- *
- * Provides methods for controlling a Material Design 3 checkbox
- *
- * @category Components
- */
 export interface CheckboxComponent {
-    /**
-     * The checkbox's root DOM element (container)
-     */
     element: HTMLElement;
-    /**
-     * The actual input element (native checkbox)
-     */
     input: HTMLInputElement;
-    /**
-     * Gets the checkbox's checked state (boolean) for form compatibility
-     * @returns Whether the checkbox is checked
-     */
     getValue: () => boolean;
-    /**
-     * Sets the checkbox's checked state.
-     * Clears indeterminate, as a user click does.
-     * @param value - Boolean or string ("true"/"false"/"1"/"0") value
-     * @returns Checkbox component for method chaining
-     */
     setValue: (value: boolean | string) => CheckboxComponent;
-    /**
-     * Gets the HTML value attribute (rarely needed)
-     * @returns The input's value attribute
-     */
     getValueAttribute: () => string;
-    /**
-     * Sets the HTML value attribute (rarely needed)
-     * @param value - New value attribute to set
-     * @returns Checkbox component for method chaining
-     */
     setValueAttribute: (value: string) => CheckboxComponent;
-    /**
-     * Checks the checkbox (sets checked=true).
-     * Clears indeterminate, as a user click does.
-     * @returns Checkbox component for method chaining
-     */
     check: () => CheckboxComponent;
-    /**
-     * Unchecks the checkbox (sets checked=false).
-     * Clears indeterminate, as a user click does.
-     * @returns Checkbox component for method chaining
-     */
     uncheck: () => CheckboxComponent;
-    /**
-     * Toggles the checkbox's checked state.
-     * Clears indeterminate, as a user click does.
-     * @returns Checkbox component for method chaining
-     */
     toggle: () => CheckboxComponent;
-    /**
-     * Checks if the checkbox is currently checked
-     * @returns True if checkbox is checked, false otherwise
-     */
     isChecked: () => boolean;
-    /**
-     * Sets the checkbox's indeterminate state
-     * An indeterminate checkbox appears partially checked
-     * and is used to represent a mixed selection state
-     *
-     * @param state - Whether to set indeterminate state
-     * @returns Checkbox component for method chaining
-     */
     setIndeterminate: (state: boolean) => CheckboxComponent;
-    /**
-     * Sets or clears the error state
-     * @param error - Whether the checkbox is in error
-     * @returns Checkbox component for method chaining
-     */
     setError: (error: boolean) => CheckboxComponent;
-    /**
-     * Sets the checkbox's label text
-     * @param text - New label text
-     * @returns Checkbox component for method chaining
-     */
     setLabel: (text: string) => CheckboxComponent;
-    /**
-     * Gets the checkbox's current label text
-     * @returns Current label text
-     */
     getLabel: () => string;
-    /**
-     * Adds an event listener to the checkbox
-     * @param event - 'change'; listen on input for native click/focus events
-     * @param handler - Receives checked state, HTML value, and an optional native event
-     * @returns Checkbox component for method chaining
-     * @example
-     * checkbox.on('change', (e) => console.log('Checkbox state:', e.checked));
-     */
     on: <K extends keyof CheckboxEvents>(event: K, handler: CheckboxEvents[K]) => CheckboxComponent;
-    /**
-     * Removes an event listener from the checkbox
-     * @param event - Event name
-     * @param handler - Event handler function
-     * @returns Checkbox component for method chaining
-     */
     off: <K extends keyof CheckboxEvents>(event: K, handler: CheckboxEvents[K]) => CheckboxComponent;
-    /**
-     * Enables the checkbox, making it interactive
-     * @returns Checkbox component for method chaining
-     */
     enable: () => CheckboxComponent;
-    /**
-     * Disables the checkbox, making it non-interactive
-     * @returns Checkbox component for method chaining
-     */
     disable: () => CheckboxComponent;
-    /** Whether the checkbox is disabled */
     isDisabled: () => boolean;
-    /**
-     * Destroys the checkbox component and cleans up resources
-     * Removes event listeners and DOM references
-     */
     destroy: () => void;
 }
-/**
- * API options interface for internal use
- * @category Components
- * @internal
- */
 export interface ApiOptions {
     disabled: {
         enable: () => void;
@@ -250,11 +64,6 @@ export interface ApiOptions {
         isChecked: () => boolean;
     };
 }
-/**
- * Base component interface for internal composition
- * @category Components
- * @internal
- */
 export interface BaseComponent {
     element: HTMLElement;
     input?: HTMLInputElement;
@@ -283,22 +92,7 @@ export interface BaseComponent {
         isChecked: () => boolean;
     };
 }
-/**
- * Component as it reaches the API step of the pipeline.
- *
- * `BaseComponent` marks the feature controllers optional because a component
- * part-way through the pipeline has not got them yet. By the time
- * `getApiConfig` runs, the checkable, disabled and lifecycle features have all
- * been applied, so they are there.
- * @category Components
- * @internal
- */
 export type ApiComponent = BaseComponent & Required<Pick<BaseComponent, "checkable" | "disabled" | "lifecycle">>;
-/**
- * Registers CheckboxConfig with the global defaults map, so
- * `setComponentDefaults("checkbox", ...)` is typed without core
- * importing anything from this component.
- */
 declare module "../../core/config/global" {
     interface ComponentConfigMap {
         checkbox?: Partial<CheckboxConfig>;

package/dist/components/chips/chips.d.ts

@@ -1,17 +1,3 @@
 import { ChipsConfig, ChipsComponent } from "./types.js";
-/**
- * Creates a chips container for grouping related chips
- *
- * Chips follows a clear architectural pattern:
- * 1. Base component - Creates the foundation with event system
- * 2. Feature enhancement - Adds specific capabilities (container, items, etc.)
- * 3. DOM creation - Creates DOM elements directly using optimized createElement
- * 4. Controller - Manages behavior, events, and UI rendering
- * 5. Lifecycle - Handles component lifecycle events
- * 6. Public API - Exposes a clean, consistent API
- *
- * @param {ChipsConfig} config - Chips configuration object
- * @returns {ChipsComponent} Chips component instance
- */
 declare const createChips: (config?: ChipsConfig) => ChipsComponent;
 export default createChips;

package/dist/components/chips/constants.d.ts

@@ -1,4 +1,3 @@
-/** Material Design chip types. Visual elevation is a separate option. */
 export declare const CHIP_TYPES: {
     readonly ASSIST: "assist";
     readonly FILTER: "filter";

package/dist/components/chips/factories.d.ts

@@ -1,9 +1,5 @@
 import type { AssistChipConfig, FilterChipConfig, InputChipConfig, SuggestionChipConfig, ChipComponent } from "./types.js";
-/** Action chip; flat and outlined by default. */
 export declare const createAssistChip: (config: AssistChipConfig) => ChipComponent;
-/** Toggleable filter; selected chips show a checkmark. */
 export declare const createFilterChip: (config: FilterChipConfig) => ChipComponent;
-/** Selectable input token with an optional independent removal action. */
 export declare const createInputChip: (config: InputChipConfig) => ChipComponent;
-/** Suggested action; flat and outlined by default. */
 export declare const createSuggestionChip: (config: SuggestionChipConfig) => ChipComponent;