@purpurds/text-field 3.0.0

package/dist/text-field.d.ts

@@ -0,0 +1,98 @@
+import React, { ComponentPropsWithoutRef, HTMLInputTypeAttribute, ReactNode } from "react";
+export type TextFieldProps = ComponentPropsWithoutRef<"input"> & {
+    id: string;
+    ["data-testid"]?: string;
+    className?: string;
+    /**
+     * Use to display e.g. a button after the text field.
+     *
+     * _NOTE: Should ideally only be used by other purpur components!_
+     */
+    afterField?: ReactNode;
+    /**
+     * Use to display e.g. an icon at the end inside of the text field.
+     *
+     * _NOTE: Should ideally only be used by other purpur components!_
+     */
+    endAdornment?: ReactNode;
+    /**
+     * Use to render error message below the text field. The text field renders with error appearance.
+     * */
+    errorText?: string;
+    /**
+     * Use to give context about the field's input. Renders below the field.
+     * */
+    helperText?: string;
+    /**
+     * The label of the text field.
+     * */
+    label?: string;
+    /**
+     *  Use to render a spinner at the end inside of the text field.
+     */
+    loading?: boolean;
+    /**
+     * Use to display e.g. an icon at the start inside of the text field.
+     *
+     * _NOTE: Should ideally only be used by other purpur components!_
+     */
+    startAdornment?: ReactNode;
+    /**
+     * Use to set the type of the field.
+     */
+    type?: Extract<HTMLInputTypeAttribute, "email" | "number" | "password" | "search" | "tel" | "text">;
+    /**
+     * Use to render text field with valid appearance. A check
+     * icon will render at the start inside of the input.
+     */
+    valid?: boolean;
+};
+export declare const TextField: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref"> & {
+    id: string;
+    "data-testid"?: string | undefined;
+    className?: string | undefined;
+    /**
+     * Use to display e.g. a button after the text field.
+     *
+     * _NOTE: Should ideally only be used by other purpur components!_
+     */
+    afterField?: ReactNode;
+    /**
+     * Use to display e.g. an icon at the end inside of the text field.
+     *
+     * _NOTE: Should ideally only be used by other purpur components!_
+     */
+    endAdornment?: ReactNode;
+    /**
+     * Use to render error message below the text field. The text field renders with error appearance.
+     * */
+    errorText?: string | undefined;
+    /**
+     * Use to give context about the field's input. Renders below the field.
+     * */
+    helperText?: string | undefined;
+    /**
+     * The label of the text field.
+     * */
+    label?: string | undefined;
+    /**
+     *  Use to render a spinner at the end inside of the text field.
+     */
+    loading?: boolean | undefined;
+    /**
+     * Use to display e.g. an icon at the start inside of the text field.
+     *
+     * _NOTE: Should ideally only be used by other purpur components!_
+     */
+    startAdornment?: ReactNode;
+    /**
+     * Use to set the type of the field.
+     */
+    type?: "number" | "search" | "text" | "email" | "password" | "tel" | undefined;
+    /**
+     * Use to render text field with valid appearance. A check
+     * icon will render at the start inside of the input.
+     */
+    valid?: boolean | undefined;
+} & React.RefAttributes<HTMLInputElement>>;
+//# sourceMappingURL=text-field.d.ts.map

package/dist/text-field.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"text-field.d.ts","sourceRoot":"","sources":["../src/text-field.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EACZ,wBAAwB,EAGxB,sBAAsB,EACtB,SAAS,EACV,MAAM,OAAO,CAAC;AAUf,MAAM,MAAM,cAAc,GAAG,wBAAwB,CAAC,OAAO,CAAC,GAAG;IAC/D,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,aAAa,CAAC,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB;;;;OAIG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;;SAEK;IACL,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;SAEK;IACL,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;SAEK;IACL,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,cAAc,CAAC,EAAE,SAAS,CAAC;IAC3B;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CACZ,sBAAsB,EACtB,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,CAC5D,CAAC;IACF;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAoHF,eAAO,MAAM,SAAS;QArKhB,MAAM;;;IAGV;;;;OAIG;iBACU,SAAS;IACtB;;;;OAIG;mBACY,SAAS;IACxB;;SAEK;;IAEL;;SAEK;;IAEL;;SAEK;;IAEL;;OAEG;;IAEH;;;;OAIG;qBACc,SAAS;IAC1B;;OAEG;;IAKH;;;OAGG;;0CAsHkD,CAAC"}