import React from "react"; import { XmForm as XmFormElement, CustomEvent, } from "../lit/components/form/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 = E & { target: T; }; /** `XmForm` component event */ export type XmFormElementEvent = TypedEvent; export type { XmFormElement, CustomEvent }; export interface XmFormProps extends Pick< React.AllHTMLAttributes, | "children" | "dir" | "hidden" | "id" | "lang" | "slot" | "style" | "title" | "translate" | "onClick" | "onFocus" | "onBlur" > { /** undefined */ disabled?: boolean; /** undefined */ readOnly?: boolean; /** 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; /** 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 when the form is submitted with its values in `detail`. */ onSubmit?: (event: XmFormElementEvent) => void; } /** * * * ## Attributes & Properties * * Component attributes and properties that can be applied to the element or by using JavaScript. * * - `disabled`: undefined * - `readonly`/`readOnly`: undefined * - `readonly`: undefined (property only) * * ## Events * * Events that will be emitted by the component. * * - `submit`: Fired when the form is submitted with its values in `detail`. * * ## Methods * * Methods that can be called to access component functionality. * * - `validate() => FormResult`: Public read contract: pull each child's live value at read time (children * are uncontrolled — the form does not drive their renders, AD-6). * - `submit() => FormResult`: Imperative submit — same path the submit button / Enter take. */ export const XmForm: React.ForwardRefExoticComponent;