@purpur/library 9.0.9 → 9.1.0

package/dist/components/search-field/src/search-field.d.ts

@@ -1,55 +1,137 @@
-import { default as React, ChangeEvent, FormEvent, RefObject } from 'react';
-import { TextFieldProps } from '../../text-field/src/text-field';
-export declare const searchFieldVariants: readonly ["button-attached", "no-button"];
-type Variant = (typeof searchFieldVariants)[number];
-type DefaultProps = {
-    ["data-testid"]?: string;
-    /**
-     * An accessible label for the clear button.
-     * */
+import { default as React } from 'react';
+import { SearchFieldAutocompleteEnhancements, SearchFieldBaseProps, searchFieldVariants } from './search-field-base';
+export { searchFieldVariants };
+export type SearchFieldProps = SearchFieldBaseProps & SearchFieldAutocompleteEnhancements;
+export declare const SearchField: React.ForwardRefExoticComponent<(Omit<{
+    "data-testid"?: string;
     clearButtonAriaLabel: string;
-    /**
-     * Disables both the input field and submit button if `true`.
-     * */
     disabled?: boolean;
-    /**
-     * Will display only a search icon in the search button if `true`.
-     * */
     iconOnlySearchButton?: boolean;
-    /**
-     * Event handler called when the value of the search field changes.
-     * */
-    onChange?: (e: ChangeEvent<HTMLInputElement>) => void;
-    /**
-     * Event handler called when the clear button is clicked.
-     * */
+    onChange?: (e: React.ChangeEvent<HTMLInputElement>) => void;
     onClear: () => void;
-    /**
-     * Event handler called when the search form is submitted.
-     * */
-    onSearch?: (e: FormEvent<HTMLFormElement>) => void;
-    /**
-     * The label text (or `aria-label` if `iconOnlySearchButton` is `true`) of the search button.
-     * */
+    onSearch?: (e: React.FormEvent<HTMLFormElement>) => void;
     searchButtonLabel?: string;
-    variant: Variant;
-    formRef?: RefObject<HTMLFormElement>;
-};
-type TextSearchButton = {
+    variant: "button-attached" | "no-button";
+    formRef?: React.RefObject<HTMLFormElement>;
+} & {
     iconOnlySearchButton?: false;
     searchButtonLabel: string;
     variant: "button-attached";
-};
-type IconOnlySearchButton = {
+} & Omit<import('../../text-field/src/text-field').TextFieldProps, "onChange" | "variant" | "afterField" | "endAdornment" | "startAdornment"> & {
+    onSelectSuggestion?: (option: import('@purpur/use-autocomplete').AutocompleteOption) => void;
+    openSuggestionsOnFocus?: boolean;
+    suggestionsMaxHeight?: string | number;
+} & {
+    suggestions: import('@purpur/use-autocomplete').AutocompleteOption[];
+    suggestionsLabel: string;
+}, "ref"> | Omit<{
+    "data-testid"?: string;
+    clearButtonAriaLabel: string;
+    disabled?: boolean;
+    iconOnlySearchButton?: boolean;
+    onChange?: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    onClear: () => void;
+    onSearch?: (e: React.FormEvent<HTMLFormElement>) => void;
+    searchButtonLabel?: string;
+    variant: "button-attached" | "no-button";
+    formRef?: React.RefObject<HTMLFormElement>;
+} & {
     iconOnlySearchButton: true;
     searchButtonLabel: string;
     variant: "button-attached";
-};
-type NoButton = {
+} & Omit<import('../../text-field/src/text-field').TextFieldProps, "onChange" | "variant" | "afterField" | "endAdornment" | "startAdornment"> & {
+    onSelectSuggestion?: (option: import('@purpur/use-autocomplete').AutocompleteOption) => void;
+    openSuggestionsOnFocus?: boolean;
+    suggestionsMaxHeight?: string | number;
+} & {
+    suggestions: import('@purpur/use-autocomplete').AutocompleteOption[];
+    suggestionsLabel: string;
+}, "ref"> | Omit<{
+    "data-testid"?: string;
+    clearButtonAriaLabel: string;
+    disabled?: boolean;
+    iconOnlySearchButton?: boolean;
+    onChange?: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    onClear: () => void;
+    onSearch?: (e: React.FormEvent<HTMLFormElement>) => void;
+    searchButtonLabel?: string;
+    variant: "button-attached" | "no-button";
+    formRef?: React.RefObject<HTMLFormElement>;
+} & {
+    searchButtonLabel?: never;
+    variant: "no-button";
+} & Omit<import('../../text-field/src/text-field').TextFieldProps, "onChange" | "variant" | "afterField" | "endAdornment" | "startAdornment"> & {
+    onSelectSuggestion?: (option: import('@purpur/use-autocomplete').AutocompleteOption) => void;
+    openSuggestionsOnFocus?: boolean;
+    suggestionsMaxHeight?: string | number;
+} & {
+    suggestions: import('@purpur/use-autocomplete').AutocompleteOption[];
+    suggestionsLabel: string;
+}, "ref"> | Omit<{
+    "data-testid"?: string;
+    clearButtonAriaLabel: string;
+    disabled?: boolean;
+    iconOnlySearchButton?: boolean;
+    onChange?: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    onClear: () => void;
+    onSearch?: (e: React.FormEvent<HTMLFormElement>) => void;
+    searchButtonLabel?: string;
+    variant: "button-attached" | "no-button";
+    formRef?: React.RefObject<HTMLFormElement>;
+} & {
+    iconOnlySearchButton?: false;
+    searchButtonLabel: string;
+    variant: "button-attached";
+} & Omit<import('../../text-field/src/text-field').TextFieldProps, "onChange" | "variant" | "afterField" | "endAdornment" | "startAdornment"> & {
+    onSelectSuggestion?: (option: import('@purpur/use-autocomplete').AutocompleteOption) => void;
+    openSuggestionsOnFocus?: boolean;
+    suggestionsMaxHeight?: string | number;
+} & {
+    suggestions?: never;
+    suggestionsLabel?: never;
+}, "ref"> | Omit<{
+    "data-testid"?: string;
+    clearButtonAriaLabel: string;
+    disabled?: boolean;
+    iconOnlySearchButton?: boolean;
+    onChange?: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    onClear: () => void;
+    onSearch?: (e: React.FormEvent<HTMLFormElement>) => void;
+    searchButtonLabel?: string;
+    variant: "button-attached" | "no-button";
+    formRef?: React.RefObject<HTMLFormElement>;
+} & {
+    iconOnlySearchButton: true;
+    searchButtonLabel: string;
+    variant: "button-attached";
+} & Omit<import('../../text-field/src/text-field').TextFieldProps, "onChange" | "variant" | "afterField" | "endAdornment" | "startAdornment"> & {
+    onSelectSuggestion?: (option: import('@purpur/use-autocomplete').AutocompleteOption) => void;
+    openSuggestionsOnFocus?: boolean;
+    suggestionsMaxHeight?: string | number;
+} & {
+    suggestions?: never;
+    suggestionsLabel?: never;
+}, "ref"> | Omit<{
+    "data-testid"?: string;
+    clearButtonAriaLabel: string;
+    disabled?: boolean;
+    iconOnlySearchButton?: boolean;
+    onChange?: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    onClear: () => void;
+    onSearch?: (e: React.FormEvent<HTMLFormElement>) => void;
+    searchButtonLabel?: string;
+    variant: "button-attached" | "no-button";
+    formRef?: React.RefObject<HTMLFormElement>;
+} & {
     searchButtonLabel?: never;
     variant: "no-button";
-};
-export type SearchFieldProps = DefaultProps & (TextSearchButton | IconOnlySearchButton | NoButton) & Omit<TextFieldProps, "startAdornment" | "endAdornment" | "afterField" | "onChange">;
-export declare const SearchField: React.ForwardRefExoticComponent<(Omit<DefaultProps & TextSearchButton & Omit<TextFieldProps, "onChange" | "afterField" | "endAdornment" | "startAdornment">, "ref"> | Omit<DefaultProps & IconOnlySearchButton & Omit<TextFieldProps, "onChange" | "afterField" | "endAdornment" | "startAdornment">, "ref"> | Omit<DefaultProps & NoButton & Omit<TextFieldProps, "onChange" | "afterField" | "endAdornment" | "startAdornment">, "ref">) & React.RefAttributes<HTMLInputElement>>;
-export {};
+} & Omit<import('../../text-field/src/text-field').TextFieldProps, "onChange" | "variant" | "afterField" | "endAdornment" | "startAdornment"> & {
+    onSelectSuggestion?: (option: import('@purpur/use-autocomplete').AutocompleteOption) => void;
+    openSuggestionsOnFocus?: boolean;
+    suggestionsMaxHeight?: string | number;
+} & {
+    suggestions?: never;
+    suggestionsLabel?: never;
+}, "ref">) & React.RefAttributes<HTMLInputElement>>;
+export { SearchFieldAutocomplete, type SearchFieldAutocompleteProps, } from './search-field-autocomplete';
 //# sourceMappingURL=search-field.d.ts.map

package/dist/components/search-field/src/search-field.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"search-field.d.ts","sourceRoot":"","sources":["../../../../../../components/search-field/src/search-field.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,KAAK,WAAW,EAAE,KAAK,SAAS,EAAc,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAE5F,OAAO,EAAa,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAMpE,eAAO,MAAM,mBAAmB,2CAA4C,CAAC;AAE7E,KAAK,OAAO,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEpD,KAAK,YAAY,GAAG;IAClB,CAAC,aAAa,CAAC,CAAC,EAAE,MAAM,CAAC;IACzB;;SAEK;IACL,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;SAEK;IACL,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;SAEK;IACL,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;SAEK;IACL,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,WAAW,CAAC,gBAAgB,CAAC,KAAK,IAAI,CAAC;IACtD;;SAEK;IACL,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB;;SAEK;IACL,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,SAAS,CAAC,eAAe,CAAC,KAAK,IAAI,CAAC;IACnD;;SAEK;IACL,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC;CACtC,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACtB,oBAAoB,CAAC,EAAE,KAAK,CAAC;IAC7B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,OAAO,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAEF,KAAK,oBAAoB,GAAG;IAC1B,oBAAoB,EAAE,IAAI,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,OAAO,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAEF,KAAK,QAAQ,GAAG;IACd,iBAAiB,CAAC,EAAE,KAAK,CAAC;IAC1B,OAAO,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,YAAY,GACzC,CAAC,gBAAgB,GAAG,oBAAoB,GAAG,QAAQ,CAAC,GACpD,IAAI,CAAC,cAAc,EAAE,gBAAgB,GAAG,cAAc,GAAG,YAAY,GAAG,UAAU,CAAC,CAAC;AAKtF,eAAO,MAAM,WAAW,qdAiEvB,CAAC"}
+{"version":3,"file":"search-field.d.ts","sourceRoot":"","sources":["../../../../../../components/search-field/src/search-field.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAqB,MAAM,OAAO,CAAC;AAG1C,OAAO,EACL,KAAK,mCAAmC,EAExC,KAAK,oBAAoB,EACzB,mBAAmB,EACpB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,mBAAmB,EAAE,CAAC;AAE/B,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,GAAG,mCAAmC,CAAC;AAE1F,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mDAMtB,CAAC;AAIH,OAAO,EACL,uBAAuB,EACvB,KAAK,4BAA4B,GAClC,MAAM,6BAA6B,CAAC"}