SearchModalProps

Home > @backstage/plugin-search > SearchModalProps

Signature:

export interface SearchModalProps 

Properties

Property	Modifiers	Type	Description
children?		(props: SearchModalChildrenProps) => JSX.Element	(Optional) A function that returns custom content to render in the search modal in place of the default.
hidden?		boolean	(Optional) 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	(Optional) If true, it renders the modal.
resultItemComponents?		SearchModalChildrenProps['resultItemComponents']	(Optional) 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.