@carbon/react/es/components/FluidSearch/FluidSearch.d.ts

React components for the Carbon Design System

/**
 * Copyright IBM Corp. 2022, 2025
 *
 * This source code is licensed under the Apache-2.0 license found in the
 * LICENSE file in the root directory of this source tree.
 */
import React, { type ChangeEvent } from 'react';
export interface FluidSearchProps {
    /**
     * Specify an optional value for the `autocomplete` property on the underlying
     * `<input>`, defaults to "off"
     */
    autoComplete?: string;
    /**
     * Specify an optional className to be applied to the container node
     */
    className?: string;
    /**
     * Specify a label to be read by screen readers on the "close" button
     */
    closeButtonLabelText?: string;
    /**
     * Optionally provide the default value of the `<input>`
     */
    defaultValue?: string | number;
    /**
     * Specify whether the `<input>` should be disabled
     */
    disabled?: boolean;
    /**
     * Specify a custom `id` for the input
     */
    id?: string;
    /**
     * Provide the label text for the Search icon
     */
    labelText: React.ReactNode;
    /**
     * Optional callback called when the search value changes.
     */
    onChange?(event: ChangeEvent<HTMLInputElement>): void;
    /**
     * Optional callback called when the search value is cleared.
     */
    onClear?: () => void;
    /**
     * Provide a handler that is invoked on the key down event for the input
     */
    onKeyDown?: React.KeyboardEventHandler<HTMLInputElement>;
    /**
     * Provide an optional placeholder text for the Search.
     * Note: if the label and placeholder differ,
     * VoiceOver on Mac will read both
     */
    placeholder?: string;
    /**
     * Specify the role for the underlying `<input>`, defaults to `searchbox`
     */
    role?: string;
    /**
     * Optional prop to specify the type of the `<input>`
     */
    type?: string;
    /**
     * Specify the value of the `<input>`
     */
    value?: string | number;
}
declare const FluidSearch: React.FC<FluidSearchProps>;
export default FluidSearch;