Interface SearchBarHandle

Readonlyelement

destroy

• destroy(): void

  Destroys and detaches the owned element without destroying its parent.

  Returns void

setData

• setData(data: SearchBarData): void

  Re-renders component content using complete replacement data.

  The element identity is preserved. Call screen.render() explicitly when one or more updates should become visible.

  Parameters

  • data: SearchBarData

  Returns void

activeScope

• activeScope(): SearchBarScope | undefined

  Current scope, when configured.

  Returns SearchBarScope | undefined

clear

• clear(): boolean

  Clears the query when enabled.

  Returns boolean

nextScope

• nextScope(): SearchBarScope | undefined

  Advances to the next scope.

  Returns SearchBarScope | undefined

previousScope

• previousScope(): SearchBarScope | undefined

  Moves to the previous scope.

  Returns SearchBarScope | undefined

query

• query(): string

  Current controlled or uncontrolled query.

  Returns string

setQuery

• setQuery(query: string): boolean

  Requests a query change and reports whether enabled.

  Parameters

  • query: string

  Returns boolean

setScope

• setScope(scopeId: string): boolean

  Requests a scope change and reports whether enabled.

  Parameters

  • scopeId: string

  Returns boolean

submit

• submit(): boolean

  Submits the current query and scope when enabled.

  Returns boolean