Interface HomeRegistration

clientAPIVersion

workspaceVersion

setSearchQuery

• setSearchQuery(query: string, options?: SetSearchQueryOptions): Promise<void>

  Function to inject search string into home search

  Parameters

  • query: string

    search string

  • Optionaloptions: SetSearchQueryOptions

  Returns Promise<void>

  A promise that resolves when the search string has been injected into home search

  Remarks

  Calling this will switch the active provider within Home to the provider that was registered with this HomeRegistration.

  Throws

  An error if the Home Provider is no longer registered.

  Optional

  additional options to set the search query

  Example: Injecting a search string into Home search

  import { Home, type CLIProvider } from '@openfin/workspace';
  
  import { fetchMySearchResults } from "./my-fetch-implementation";
  
  const searchQueryMap: Map<string, (query: string) => void> = new Map();
  
  // CLIProvider or HomeProvider
  const myCLIProvider: CLIProvider = {
       id: "my-cli-provider",
       title: "My CLI Provider",
       icon: "https://google.com/favicon.ico",
       onUserInput: (req) => fetchMySearchResults(req.query)
  };
  
  // register home and get back a function to inject search string into home search
  const { setSearchQuery } = await Home.register(myCLIProvider);
  
  // Store set query function in a map if you're using multiple providers
  searchQueryMap.set(myCLIProvider.id, setSearchQuery);
  
  // Call the set query function for a specific provider the search should be injected into
  const searchButton = document.createElement('button');
  searchButton.innerHTML = 'Search';
  document.body.appendChild(searchButton);
  
  searchButton.addEventListener('click', () => {
      searchQueryMap.get('my-cli-provider')?.('my search string');
  });
  
  Copy