placer-toolkit 0.5.1 → 1.0.0-alpha.2

package/dist/components/button/button.d.ts

@@ -1,6 +1,105 @@
-import { PcButton } from "./button.component.js";
-export * from "./button.component.js";
-export default PcButton;
+import { PlacerElement } from "../../internal/placer-element.js";
+import type { PlacerFormControl } from "../../internal/placer-form-control.js";
+/**
+ * @summary Buttons represent actions that are available to the user.
+ * @status experimental
+ * @since 0.1.0
+ *
+ * @slot - The button’s label.
+ * @slot prefix - A presentational prefix icon or similar element.
+ * @slot suffix - A presentational suffix icon or similar element.
+ *
+ * @event pc-focus - Emitted when the button gains focus.
+ * @event pc-blur - Emitted when the button loses focus (i.e., is blurred).
+ * @event pc-invalid - Emitted when the form control has been checked for validity and its constraints aren’t satisfied.
+ *
+ * @csspart base - The component’s base wrapper.
+ * @csspart prefix - The container that wraps the prefix.
+ * @csspart label - The button’s label.
+ * @csspart suffix - The container that wraps the suffix.
+ */
+export declare class PcButton extends PlacerElement implements PlacerFormControl {
+    /** @internal This is an internal static property. */
+    static css: string[];
+    private readonly formControlController;
+    private readonly hasSlotController;
+    /** @internal This is an internal class property. */
+    button: HTMLButtonElement | HTMLLinkElement;
+    /** @internal This is an internal class property. */
+    labelSlot: HTMLSlotElement;
+    private hasFocus;
+    /** @internal This is an internal class property. */
+    isIconButton: boolean;
+    /** @internal This is an internal class property. */
+    invalid: boolean;
+    /** @internal This is an internal property. */
+    title: string;
+    /** The button’s appearance. */
+    appearance: "primary" | "success" | "neutral" | "warning" | "danger" | "text";
+    /** The button’s variant. */
+    variant: "accent" | "filled" | "outlined" | "plain";
+    /** The button’s size. */
+    size: "small" | "medium" | "large";
+    /** Disables the button. */
+    disabled: boolean;
+    /** Draws a pill‐style button. */
+    pill: boolean;
+    /** The type of button. Note that the default value is `button` instead of `submit`, which is opposite of how native `<button>` elements behave. When the type is `submit`, the button will submit the surrounding form. */
+    type: "button" | "submit" | "reset";
+    /** The name of the button, submitted as a name/value pair with form data, but only when this button is the submitter. */
+    name: string;
+    /** The value of the button, submitted as a pair with the button’s name as part of the form data, but only when this button is the submitter. This attribute is ignored when the `href` attribute is present. */
+    value: string;
+    /** When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`. */
+    href: string;
+    /** Tells the browser where to open the link. It should only be used when the `href` attribute is present. */
+    target?: "_blank" | "_parent" | "_self" | "_top";
+    /** When using the `href` attribute, this attribute will map to the underlying link’s `rel` attribute. Unlike regular links, the default set for this attribute is `noreferrer noopener` to prevent security exploits. However, if you’re using `target` to point to a specific tab or window, this will prevent that from working properly. You can remove or change the default value by setting the attribute to an empty string or a value of your choice, respectively. */
+    rel: string;
+    /** Tells the browser to download the linked file as this file name. Only used when the `href` attribute is present. */
+    download?: string;
+    /** This is the “form owner” to associate the button with. If omitted, the closest containing form will be used instead. The value of this attribute must be an id of a form in the same document or shadow root as the button. */
+    form?: string;
+    /** Used to override the form owner’s `action` attribute. */
+    formAction?: string;
+    /** Used to override the form owner’s `enctype` attribute. */
+    formEnctype?: "application/x-www-form-url-encoded" | "multipart/form-data" | "text/plain";
+    /** Used to override the form owner’s `method` attribute. */
+    formMethod?: "GET" | "POST";
+    /** Used to override the form owner’s `novalidate` attribute. */
+    formNoValidate?: boolean;
+    /** Used to override the form owner’s `target` attribute. */
+    formTarget?: "_self" | "_blank" | "_parent" | "_top" | string;
+    /** Gets the validity state object. */
+    get validity(): ValidityState;
+    /** Gets the validation message. */
+    get validationMessage(): string;
+    firstUpdated(): void;
+    private handleClick;
+    private handleFocus;
+    private handleBlur;
+    private handleInvalid;
+    private isButton;
+    private isLink;
+    private handleLabelSlotChange;
+    /** @internal This is an internal method. */
+    handleDisabledChange(): void;
+    /** Simulates a click on the button. */
+    click(): void;
+    /** Focuses the button. */
+    focus(options?: FocusOptions): void;
+    /** Unfocuses the button (i.e., blurs it). */
+    blur(): void;
+    /** Checks for validity but doesn’t show a validation message. Returns `true` when valid and `false` when invalid. */
+    checkValidity(): boolean;
+    /** Gets the associated form if one exists. */
+    getForm(): HTMLFormElement | null;
+    /** Checks for validity and shows the browser’s validation message if the control is invalid. */
+    reportValidity(): boolean;
+    /** Sets a custom validation message. Pass an empty string to restore validity. */
+    setCustomValidity(message: string): void;
+    render(): import("lit-html").TemplateResult<1>;
+}
 declare global {
     interface HTMLElementTagNameMap {
         "pc-button": PcButton;