Backstage
    Preparing search index...

    Interface SearchModalProps

    interface SearchModalProps {
        children?: (props: SearchModalChildrenProps) => Element;
        hidden?: boolean;
        open?: boolean;
        resultItemComponents?:
            | ReactNode
            | ((resultSet: SearchResultSet) => Element);
        toggleModal: () => void;
    }
    Index

    Properties

    children? hidden? open? resultItemComponents? toggleModal

    Properties

    children?: (props: SearchModalChildrenProps) => Element

    A function that returns custom content to render in the search modal in place of the default.

    hidden?: boolean

    This is supposed to be used together with the open prop. If hidden is true, it hides the modal. If open is false, the value of hidden has no effect on the modal. Use open for controlling whether the modal should be rendered or not.

    open?: boolean

    If true, it renders the modal.

    resultItemComponents?: ReactNode | ((resultSet: SearchResultSet) => Element)

    Optional ability to pass in result item component renderers.

    toggleModal: () => void

    a function invoked when a search item is pressed or when the dialog should be closed.

    Settings

    Member Visibility

    On This Page

    Properties