@awsui/components-react/text-filter/interfaces.d.ts

On July 19th, 2022, we launched [Cloudscape Design System](https://cloudscape.design). Cloudscape is an evolution of AWS-UI. It consists of user interface guidelines, front-end components, design resources, and development tools for building intuitive, en

import { InputAutoCorrect } from '../input/interfaces';
import { BaseComponentProps } from '../internal/base-component';
import { FormFieldControlProps } from '../internal/context/form-field-context';
import { NonCancelableEventHandler } from '../internal/events';
export interface TextFilterProps extends BaseComponentProps, FormFieldControlProps, InputAutoCorrect {
    /**
     * The current value of the filtering input.
     */
    filteringText: string;
    /**
     * Placeholder for the filtering input.
     */
    filteringPlaceholder?: string;
    /**
     * Label for the filtering input clear button.
     */
    filteringClearAriaLabel?: string;
    /**
     * Accepts a human-readable, localized string that indicates the number of results. For example, "1 match" or "165 matches."
     * If the total number of results is unknown, also include an indication that there may be more results than
     * the number listed. For example, "25+ matches."
     *
     * The count text is only displayed when `filteringText` isn't empty.
     * When the `countText` or `filteringText` changes, it will be announced to assistive technologies.
     */
    countText?: string;
    /**
     * Set to `true` while the related collection is loading (e.g. during an async filtering action).
     * If set to `true`, the live announcement of countText by assistive technologies will be paused until it changes back to `false`.
     */
    loading?: boolean;
    /**
     * Specifies if the filtering input is disabled.
     * For example, you can use it if you are fetching new items upon filtering change
     * in order to prevent the user from changing the filtering text.
     */
    disabled?: boolean;
    /**
     * Adds an `aria-label` on the filtering input.
     */
    filteringAriaLabel?: string;
    /**
     * Called when a change in filtering is caused by a user interaction. The event `detail` contains the current `filteringText`.
     */
    onChange?: NonCancelableEventHandler<TextFilterProps.ChangeDetail>;
    /**
     * Called after the user changes the value of the filtering input field and stops typing for a certain
     * period of time. If you want a delayed handler to invoke a filtering API call, you can use this event in addition to `onChange`.
     */
    onDelayedChange?: NonCancelableEventHandler<TextFilterProps.ChangeDetail>;
}
export declare namespace TextFilterProps {
    interface ChangeDetail {
        filteringText: string;
    }
    interface Ref {
        /**
         * Sets focus on the underlying input control.
         */
        focus(): void;
    }
}
//# sourceMappingURL=interfaces.d.ts.map