@protonradio/proton-ui 0.6.7 → 0.6.8

package/dist/index.d.ts

@@ -146,6 +146,66 @@ declare interface BannerProps extends BannerIconProps, default_2.HTMLAttributes<
 
 export declare type BannerVariant = "default" | "success" | "warning" | "danger";
 
+declare interface BaseInputProps {
+    /**
+     * onChange handler for the input
+     */
+    onChange?: (value: string) => void;
+    /** Whether the input is disabled. */
+    isDisabled?: boolean;
+    /** Description text shown above the input. */
+    description?: default_2.ReactNode | string;
+    /**
+     * The position of the description text.
+     * @default "top"
+     */
+    descriptionPosition?: "top" | "bottom";
+    /** Error state that changes the input's visual style and displays an error message. */
+    error?: default_2.ReactNode | string;
+    /**
+     * Label for the input element.
+     * @note When a label is provided, the input will have extra padding, and the label will float above the text input when focused or filled.
+     */
+    label?: string;
+    /** Test ID for the component. */
+    "data-testid"?: string;
+    /** Content to display before the input. Typically used for icons. */
+    prefix?: default_2.ReactNode;
+    /** Content to display after the input. Typically used for icons. */
+    suffix?: default_2.ReactNode;
+    /**
+     * Should the browser's autocomplete be enabled?
+     * @external https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete
+     */
+    autoComplete?: boolean;
+    /**
+     * Should the input be autofocused?
+     * @external https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autofocus
+     */
+    autoFocus?: boolean;
+    /**
+     * The name attribute of the input element.
+     * @external https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/name
+     */
+    name: string;
+    /**
+     * The placeholder text to display when the input is empty.
+     * @note Placeholder takes precedence over label, if both are provided.
+     * @external https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/placeholder
+     */
+    placeholder?: string;
+    /**
+     * The type attribute of the input element.
+     * @external https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/type
+     */
+    type?: string;
+    /**
+     * The value of the input.
+     * @external https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#value
+     */
+    value?: string;
+}
+
 declare const BRAND: {
     PRIMARY: string;
     PRIMARY_LIGHT: string;
@@ -294,6 +354,11 @@ declare interface IconProps {
     color?: string;
 }
 
+/**
+ * A controlled and customizable input component with support for labels, prefixes, suffixes, and error states.
+ */
+export declare const Input: default_2.ForwardRefExoticComponent<BaseInputProps & default_2.RefAttributes<HTMLInputElement>>;
+
 export declare function Popover({ children, state, arrow, offset, ...props }: PopoverProps): JSX_2.Element;
 
 /**
@@ -342,6 +407,24 @@ declare type RGBArray = [number, number, number];
 
 export { Row }
 
+/**
+ * A search input component with optional clear functionality and URL parameter sync.
+ */
+export declare const SearchInput: ({ name, placeholder, autoComplete, isClearable, error, defaultValue, value: controlledValue, "data-testid": testId, onChange, onClear, }: SearchInputProps) => JSX_2.Element;
+
+declare interface SearchInputProps extends Omit<BaseInputProps, "prefix" | "suffix" | "value" | "onChange" | "description" | "descriptionPosition" | "label"> {
+    /** Should the clear button be shown when there is text? */
+    isClearable?: boolean;
+    /** Called when the input value changes. */
+    onChange?: (value: string) => void;
+    /** Called when the clear button is clicked. */
+    onClear?: () => void;
+    /** The initial value of the input. */
+    defaultValue?: string;
+    /** The current value of the input (for controlled usage) */
+    value?: string;
+}
+
 export { Section }
 
 export declare const Select: {