Options
All
  • Public
  • Public/Protected
  • All
Menu

@openfin/workspace

Index

Enumerations

Interfaces

Type aliases

Variables

Type aliases

Action

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

Each action is defined by its title and a hotkey

Type declaration

  • Optional hotkey?: string
  • name: string

ButtonTemplateFragment

ButtonTemplateFragment: ContainerTemplateFragment<"Button"> & FragmentAction & { buttonStyle?: ButtonStyle }

CLIDispatchedSearchResult

CLIDispatchedSearchResult: DispatchedSearchResult

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

CLISearchListenerRequest

CLISearchListenerRequest: SearchListenerRequest

CLISearchListenerResponse

CLISearchListenerResponse: SearchListenerResponse

CLISearchResult

CLISearchResult<A>: SearchResult<A>

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

Type parameters

ContainerFragmentTypes

CustomTemplateData

CustomTemplateData: Record<string, string | ListPairs>

HomeAction

HomeAction: CLISuggestion | Action

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

HomeSearchListenerResponse

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();
});
}

HomeSearchResult

A search result that can be rendered by Home UI.

ImageTemplateFragment

ImageTemplateFragment: PresentationTemplateFragment<"Image"> & FragmentAction & { alternativeText: string }

InteractiveFragmentTypes

LayoutComponentExtended

LayoutComponentExtended: Omit<OpenFin.LayoutComponent, "componentState"> & { componentState: LayoutComponentStateExtended }

LayoutComponentStateExtended

LayoutComponentStateExtended: OpenFin.LayoutComponent["componentState"] & { name: string; uuid: string }

LayoutContentExtended

LayoutContentExtended: LayoutContentItemExtended[]

LayoutContentItemExtended

LayoutContentItemExtended: OpenFin.LayoutRow | OpenFin.LayoutColumn | LayoutComponentExtended | LayoutStack

LayoutExtended

LayoutExtended: { content: LayoutContentExtended; settings?: LayoutSettingsExtended }

Type declaration

LayoutSettingsExtended

LayoutSettingsExtended: OpenFin.LayoutOptions["settings"] & { reorderEnabled?: boolean }

LayoutStack

LayoutStack: { content: OpenFin.LayoutContent; type: "stack" }

Type declaration

  • content: OpenFin.LayoutContent
  • type: "stack"

ListPairs

ListPairs: [string, string][]

ListTemplateFragment

ListTemplateFragment: PresentationTemplateFragment<"List">

PageLayout

PageLayout: LayoutExtended & { layoutDetails?: PageLayoutDetails }

PlainContainerTemplateFragment

PlainContainerTemplateFragment: ContainerTemplateFragment<"Container">

PresentationFragmentTypes

ResultDispatchListener

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

ScoreOrder: "ascending" | "descending"

The order to sort scored search results in.

StorefrontDetailedNavigationItem

StorefrontDetailedNavigationItem: StorefrontNavigationItem & StorefrontNavigationItemDetails

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

StorefrontNavigationItem

Render an item in the navigation bar of Storefront.

TemplateFragment

The options to build your custom template composition layout.

TextTemplateFragment

TextTemplateFragment: PresentationTemplateFragment<"Text"> & FragmentAction

UserInputListener

UserInputListener: (request: SearchListenerRequest, response: SearchListenerResponse) => Promise<SearchResponse>

Type declaration

Variables

ContainerTemplateFragmentNames

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

Type declaration

  • Button: "Button"
  • Container: "Container"

Home

Home: HomeAPI = ...

Namespace for Home integrations.

Legacy

Legacy: LegacyAPI = ...

Namespace for Legacy integrations.

PresentationTemplateFragmentNames

PresentationTemplateFragmentNames: { Image: "Image"; List: "List"; Text: "Text" } = ...

Type declaration

  • Image: "Image"
  • List: "List"
  • Text: "Text"

Storefront

Storefront: StorefrontAPI = ...

Namespace for Storefront integrations.

TemplateFragmentTypes

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