Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

References

Enumerations

Interfaces

Type Aliases

Variables

References

Renames and re-exports dock
Renames and re-exports home
Renames and re-exports legacy
Renames and re-exports store

Type Aliases

Action: { hotkey?: string; name: string }

Each action is defined by its title and a hotkey

Type declaration

  • Optional hotkey?: string
  • name: string
BaseCustomDropdownItems: BaseCustomDropdownItem[] | (() => Promise<BaseCustomDropdownItem[]>)
ButtonTemplateFragment: ContainerTemplateFragment<"Button"> & FragmentAction & { buttonStyle?: ButtonStyle }
CLIDispatchedSearchResult: DispatchedSearchResult

A rendered search result that has been actioned by a user.

CLISearchListenerRequest: SearchListenerRequest
CLISearchListenerResponse: SearchListenerResponse
CLISearchResult<A>: SearchResult<A>

A search result that can be rendered by a Workspace component.

Type Parameters

CustomTemplateData: Record<string, string | ListPairs>
DispatchedAction: Action & { trigger: ActionTrigger }

The triggered action that should be performed by the search provider.

Dock button types

HomeAction: CLISuggestion | Action

Union type that includes Home's built in search result actions.

HomeDispatchedSearchResult: HomeSearchResult & DispatchedSearchResult

A rendered Home search result that has been actioned by a user.

HomeSearchListenerResponse: Omit<CLISearchListenerResponse, "respond"> & { respond: any }

Representation of a search response from a specific invocation of a HomeProvider's onUserInput listener function. Can optionally be used to push search results to the Home UI.

function onUserInput(req: HomeSearchListenerRequest, res: HomeSearchListenerResponse) {
searchListenerResponse.open();

const myLongRunningQuery = makeMyLongRunningQuery(searchListenerRequest.query);
myLongRunningQuery.onNewResults(myNewResults => {
searchListenerResponse.respond(myNewResults);
});

searchListenerRequest.onClose(() => {
myLongRunningQuery.close();
});
}

A search result that can be rendered by Home UI.

ImageTemplateFragment: PresentationTemplateFragment<"Image"> & FragmentAction & { alternativeText: string }
ListPairs: [string, string][]
ListTemplateFragment: PresentationTemplateFragment<"List">
PageLayout: OpenFin.LayoutOptions & { layoutDetails?: PageLayoutDetails }
PanelConfig: (PanelConfigHorizontal | PanelConfigVertical) & { viewOptions: Omit<OpenFin.PlatformViewCreationOptions, "bounds" | "target"> }

Configuration of an individual fixed view panel

Example:

{
position: PanelPosition.Left,
width: '140px',
viewOptions: { url: 'https://example.com'}
}
PlainContainerTemplateFragment: ContainerTemplateFragment<"Container">
RegisterMetaInfoInternal: Pick<RegistrationMetaInfo, "workspaceVersion">
ResultDispatchListener: ((result: DispatchedSearchResult) => void)

Type declaration

    • A listener called when a search result generated by this provider is dispatched.

      searchTopic.dispatch("My Provider Name", searchResult, "My Action");
      

      Parameters

      Returns void

ScoreOrder: "ascending" | "descending"

The order to sort scored search results in.

StorefrontDetailedNavigationItem: StorefrontNavigationItem & StorefrontNavigationItemDetails

Render an item in the navigation bar of Storefront with a description and image.

StorefrontLandingPageItem: StorefrontDetailedNavigationItem | App

Represents the existing StorefrontDetailedNavigationItem and existing App interfaces Used by StorefrontLandingPage to represent items in the bottom, middle and top rows.

Render an item in the navigation bar of Storefront.

The options to build your custom template composition layout.

TextTemplateFragment: PresentationTemplateFragment<"Text"> & FragmentAction
UserInputListener: ((request: SearchListenerRequest, response: SearchListenerResponse) => Promise<SearchResponse>)

Type declaration

Variables

ContainerTemplateFragmentNames: { Button: "Button"; Container: "Container" } = ...

Type declaration

  • Button: "Button"
  • Container: "Container"
PresentationTemplateFragmentNames: { Image: "Image"; List: "List"; Text: "Text" } = ...

Type declaration

  • Image: "Image"
  • List: "List"
  • Text: "Text"
TemplateFragmentTypes: { Button: "Button"; Container: "Container"; Image: "Image"; List: "List"; Text: "Text" } = ...

Type declaration

  • Button: "Button"
  • Container: "Container"
  • Image: "Image"
  • List: "List"
  • Text: "Text"

Generated using TypeDoc