@nysds/nys-checkbox 1.19.4 → 1.20.1

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./nys-checkbox";
+export * from "./nys-checkboxgroup";

package/dist/nys-checkbox.d.ts

@@ -0,0 +1,150 @@
+import { NysFormControlElement } from "@nysds/internals";
+import "./nys-checkboxgroup";
+import "@nysds/nys-label";
+import "@nysds/nys-errormessage";
+import "@nysds/nys-icon";
+import "@nysds/nys-textinput";
+/**
+ * A checkbox input for binary choices or multi-select lists. Can be used standalone or in a `nys-checkboxgroup`.
+ * Form-associated with validation via ElementInternals.
+ *
+ * Use for binary decisions (agree/disagree) or selecting multiple options from a list.
+ * For single selection from 2-6 options, use `nys-radiobutton`. For immediate state changes, use `nys-toggle`.
+ *
+ * @summary Checkbox for binary choices or multi-select options.
+ * @element nys-checkbox
+ *
+ * @slot description - Custom HTML description content.
+ *
+ * @fires nys-change - Fired when checked state changes. Detail: `{id, checked, name, value}`.
+ * @fires nys-focus - Fired when checkbox gains focus.
+ * @fires nys-blur - Fired when checkbox loses focus.
+ * @fires nys-other-input - Fired when "other" text input value changes. Detail: `{id, name, value}`.
+ *
+ * @example Single
+ * ```html
+ * <nys-checkbox label="I agree to the terms" name="terms"></nys-checkbox>
+ * ```
+ *
+ * @example Preselected
+ * ```html
+ * <nys-checkbox label="I agree to the terms" name="terms" checked></nys-checkbox>
+ * ```
+ */
+export declare class NysCheckbox extends NysFormControlElement {
+    static styles: import("lit").CSSResult;
+    static shadowRootOptions: {
+        delegatesFocus: boolean;
+        clonable?: boolean;
+        customElementRegistry?: CustomElementRegistry;
+        mode: ShadowRootMode;
+        serializable?: boolean;
+        slotAssignment?: SlotAssignmentMode;
+    };
+    /** Whether checkbox is checked. */
+    checked: boolean;
+    /** Prevents interaction. */
+    disabled: boolean;
+    /** Marks as required. Validates that checkbox is checked. */
+    required: boolean;
+    /** Visible label text. Required for accessibility. */
+    label: string;
+    /** Helper text below label. Use slot for custom HTML. */
+    description: string;
+    /** Unique identifier. Auto-generated if not provided. */
+    id: string;
+    /** Name for form submission. Use same name for grouped checkboxes. */
+    name: string;
+    /** Value submitted when checked. */
+    value: string;
+    /** Form `id` to associate with when checkbox is outside form element. */
+    form: string | null;
+    /** Shows error message when true. */
+    showError: boolean;
+    /** Error message text. Shown only when `showError` is true. */
+    errorMessage: string;
+    /** Internal: Set by parent checkboxgroup. Do not set manually. */
+    groupExist: boolean;
+    /** Renders as tile with larger clickable area. Apply to group for consistency. */
+    tile: boolean;
+    /** Tooltip text shown on hover/focus of info icon. */
+    tooltip: string;
+    /**
+     * Checkbox size: `sm` (24px) or `md` (32px, default).
+     * @default "md"
+     */
+    size: "sm" | "md";
+    other: boolean;
+    showOtherError: boolean;
+    /**
+     * Id of an element in the host's light-DOM tree to borrow the accessible name
+     * from (e.g. a table column `<th>`). Enables labelling a checkbox that has no
+     * visible label of its own.
+     */
+    labelledby: string;
+    /**
+     * Suppress the internal visible `<nys-label>` (use with `labelledby` for
+     * table cells).
+     */
+    hideLabel: boolean;
+    private _mobileQuery;
+    private isMobile;
+    private _hasUserInteracted;
+    getInputElement(): Promise<HTMLInputElement | null>;
+    /**
+     * Lifecycle methods
+     * --------------------------------------------------------------------------
+     * Form association, ElementInternals, and id generation are provided by
+     * NysFormControlElement (@nysds/internals).
+     */
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    firstUpdated(): void;
+    willUpdate(changed: Map<string, unknown>): void;
+    updated(changed: Map<string, unknown>): void;
+    /**
+     * Point the native <input> at a light-DOM element that IDREF attributes cannot
+     * reach across the shadow boundary. associateControlRefs sets the control's own
+     * ariaLabelledByElements (honored in Chromium) plus a string aria-label fallback
+     * for engines that do not yet resolve element references.
+     *
+     * Only ever called with an external labelledby set: with no external target the
+     * native input keeps the internal same-root aria-labelledby IDREF that render()
+     * emits, and must not be touched.
+     */
+    private _syncExternalLabel;
+    /**
+     * Form Integration
+     * --------------------------------------------------------------------------
+     */
+    private _setValue;
+    private _manageRequire;
+    private _setValidityMessage;
+    private _validate;
+    formResetCallback(): void;
+    /**
+     * Functions
+     * --------------------------------------------------------------------------
+     */
+    checkValidity(): boolean;
+    private _handleInvalid;
+    private _manageLabelClick;
+    get _hasDescription(): boolean;
+    get _isStandalone(): boolean;
+    /**
+     * Event Handlers
+     * --------------------------------------------------------------------------
+     */
+    private _handleMobileQuery;
+    private _emitChangeEvent;
+    private _emitOtherInputEvent;
+    private _handleChange;
+    private _handleFocus;
+    private _handleBlur;
+    private _handleTextInputBlur;
+    private _handleKeydown;
+    private _handleTextInput;
+    private _validateOtherAndEmitError;
+    private _dispatchClearError;
+    render(): import("lit-html").TemplateResult<1>;
+}

package/dist/nys-checkbox.figma.d.ts

@@ -0,0 +1 @@
+export {};