@purpurds/text-field 5.3.0 → 5.4.1

package/dist/text-field.d.ts

@@ -1,6 +1,6 @@
 import { default as React, ComponentPropsWithoutRef, HTMLInputTypeAttribute, ReactNode } from 'react';
 
-export type TextFieldProps = ComponentPropsWithoutRef<"input"> & {
+type TextFieldBaseProps = {
     ["data-testid"]?: string;
     className?: string;
     /**
@@ -47,51 +47,26 @@ export type TextFieldProps = ComponentPropsWithoutRef<"input"> & {
      */
     valid?: boolean;
 };
-export declare const TextField: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref"> & {
-    "data-testid"?: string | undefined;
-    className?: string | undefined;
+type TextFieldClearProps = {
     /**
-     * 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.
+     * An accessible label for the clear button.
      * */
-    errorText?: string | undefined;
+    clearButtonAllyLabel: string;
     /**
-     * Use to give context about the field's input. Renders below the field.
+     * Event handler called when the clear button is clicked.
      * */
-    helperText?: string | undefined;
+    onClear: () => void;
+} | {
     /**
-     * The label of the text field.
+     * An accessible label for the clear button.
      * */
-    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;
+    clearButtonAllyLabel?: never;
     /**
-     * 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>>;
+     * Event handler called when the clear button is clicked.
+     * */
+    onClear?: never;
+};
+export type TextFieldProps = ComponentPropsWithoutRef<"input"> & TextFieldBaseProps & TextFieldClearProps;
+export declare const TextField: React.ForwardRefExoticComponent<TextFieldProps & React.RefAttributes<HTMLInputElement>>;
+export {};
 //# sourceMappingURL=text-field.d.ts.map

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

@@ -1 +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,EAEV,MAAM,OAAO,CAAC;AAUf,MAAM,MAAM,cAAc,GAAG,wBAAwB,CAAC,OAAO,CAAC,GAAG;IAC/D,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;AAyHF,eAAO,MAAM,SAAS;;;IAvKpB;;;;OAIG;iBACU,SAAS;IACtB;;;;OAIG;mBACY,SAAS;IACxB;;SAEK;;IAEL;;SAEK;;IAEL;;SAEK;;IAEL;;OAEG;;IAEH;;;;OAIG;qBACc,SAAS;IAC1B;;OAEG;;IAKH;;;OAGG;;0CA2HkD,CAAC"}
+{"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,EAEV,MAAM,OAAO,CAAC;AAYf,KAAK,kBAAkB,GAAG;IACxB,CAAC,aAAa,CAAC,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;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;IAElB;;;;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;AAEF,KAAK,mBAAmB,GACpB;IACE;;SAEK;IACL,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;SAEK;IACL,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,GACD;IACE;;SAEK;IACL,oBAAoB,CAAC,EAAE,KAAK,CAAC;IAC7B;;SAEK;IACL,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB,CAAC;AAEN,MAAM,MAAM,cAAc,GAAG,wBAAwB,CAAC,OAAO,CAAC,GAC5D,kBAAkB,GAClB,mBAAmB,CAAC;AA+JtB,eAAO,MAAM,SAAS,yFAAiC,CAAC"}