Back to Fluentui

React Search.Api

packages/react-components/react-search/library/etc/react-search.api.md

4.40.2-hotfix22.0 KB
Original Source

API Report File for "@fluentui/react-search"

Do not edit this file. It is a report generated by API Extractor.

ts

import type { ComponentProps } from '@fluentui/react-utilities';
import type { ComponentState } from '@fluentui/react-utilities';
import type { ForwardRefComponent } from '@fluentui/react-utilities';
import type { InputOnChangeData } from '@fluentui/react-input';
import type { InputProps } from '@fluentui/react-input';
import type { InputSlots } from '@fluentui/react-input';
import type { InputState } from '@fluentui/react-input';
import type { JSXElement } from '@fluentui/react-utilities';
import * as React_2 from 'react';
import type { Slot } from '@fluentui/react-utilities';
import type { SlotClassNames } from '@fluentui/react-utilities';

// @public
export const renderSearchBox_unstable: (state: SearchBoxState) => JSXElement;

// @public
export const SearchBox: ForwardRefComponent<SearchBoxProps>;

// @public
export type SearchBoxChangeEvent = React_2.ChangeEvent<HTMLInputElement> | React_2.MouseEvent<HTMLSpanElement>;

// @public (undocumented)
export const searchBoxClassNames: SlotClassNames<SearchBoxSlots>;

// @public
export type SearchBoxProps = Omit<ComponentProps<Partial<SearchBoxSlots>, 'input'>, 'children' | 'defaultValue' | 'onChange' | 'size' | 'type' | 'value'> & Omit<InputProps, 'onChange'> & {
    onChange?: (event: SearchBoxChangeEvent, data: InputOnChangeData) => void;
};

// @public (undocumented)
export type SearchBoxSlots = InputSlots & {
    dismiss?: Slot<'span'>;
};

// @public
export type SearchBoxState = ComponentState<SearchBoxSlots> & InputState & Required<Pick<InputState, 'size'>> & Required<Pick<SearchBoxProps, 'disabled'>> & {
    focused: boolean;
};

// @public
export const useSearchBox_unstable: (props: SearchBoxProps, ref: React_2.Ref<HTMLInputElement>) => SearchBoxState;

// @public
export const useSearchBoxStyles_unstable: (state: SearchBoxState) => SearchBoxState;

// (No @packageDocumentation comment for this package)