ICardSearchBoxParameters interface

Package:

@microsoft/sp-adaptive-card-extension-base

Search box component parameters. Represents a search box rendered in the card view.

Extends

ICardComponentParameters<CardSearchBoxEventNames>

Properties

button	Button displayed on the search box.
componentName	Unique component name.
defaultValue	Default value to display.
onChange	Callback function for when the search query text has changed.
placeholder	Placeholder text to display.
value	Current value of the search box.

Property Details

button

Button displayed on the search box.

button: ICardSearchBoxButton;

Property Value

ICardSearchBoxButton

componentName

Unique component name.

componentName: 'searchBox';

Property Value

'searchBox'

defaultValue

Default value to display.

defaultValue?: string;

Property Value

string

Remarks

Provide this if the searchbox should be an uncontrolled component which tracks its current state internally; otherwise, use value.

onChange

Callback function for when the search query text has changed.

onChange?: (newValue?: string) => void;

Property Value

(newValue?: string) => void

placeholder

Placeholder text to display.

placeholder?: string;

Property Value

string

value

Current value of the search box.

value?: string;

Property Value

string

Remarks

Provide this if the search box is a controlled component where you are maintaining its current state. Use empty string as initial value if needed.