version of client SDK, set by the API
Icon for the provider.
Unique identifier for the provider.
A UI friendly title for the provider platform.
Get a list of apps to populate the platform's Storefront with.
const app : App = {
appId: 'uid'
title: 'My App'
manifest: `https://openfin-iex.experolabs.com/openfin/manifests/cash-flow.json`,
icons: [
{
src: '/icon.png'
}
],
contactEmail: contact@email.com,
supportEmail: support@email.com,
publisher: 'My Publisher',
tags: [],
images: [],
intents: []
}
const getApps = async (): Promise<App[]> => {
return [app];
}
Get the footer for the platform's Storefront.
const footer: StorefrontFooter = {
logo: { src: './images/image', size: '32' },
text: 'footer text',
links: [
{ title:'title', url: 'https://openfin.co' },
{ title: 'title', url: 'https://openfin.co'}
]
}
const getFooter = async (): Promise<StorefrontFooter> => {
return footer;
}
Get the main landing page for the platform's Storefront.
const landingPage : StorefrontLandingPage = {
hero: {
title: 'My Landing Page',
description: 'description',
cta: navigationItems[0],
image: {
src: './images/image.png'
}
},
topRow: {
title: 'Top Row Title',
items: //array of StorefrontNavigationItem
},
middleRow: {
title: 'Middle Row Title',
apps: //array of apps
},
bottomRow: {
title: 'Bottom Row Title',
items: //array of StorefrontNavigationItem
}
}
const getLandingPage = async (): Promise<StorefrontLandingPage> => {
return landingPage;
}
Get the Storefront navigation sections for the left nav bar.
```ts const navigationSections: [StorefrontNavigationSection, StorefrontNavigationSection] = [ { id: 'first id', title: 'title', items: //array of navigation items }, { id: 'second id' title: 'title', items: //array of navigation items } ]
const getNavigation = async (): Promise<[StorefrontNavigationSection, StorefrontNavigationSection]> => { return navigationSections; }
Launch an app provided by the platform's Storefront.
import { getStorefrontProvider } from "./my-provider";
//Grab your provider
const myStoreFrontProvider: StorefrontProvider = getStorefrontProvider();
const app : App = {
appId: 'uid'
title: 'My App'
manifest: `https://openfin-iex.experolabs.com/openfin/manifests/cash-flow.json`,
icons: [
{
src: './image.png'
}
],
contactEmail: contact@email.com,
supportEmail: support@email.com,
publisher: 'My Publisher',
tags: [],
images: [],
intents: []
}
const launch = async () => {
await myStorefrontProvider.launchApp(app);
}
the app to launch.
Generated using TypeDoc
Describes a Storefront provided by a platform. A platform must provide an object that satisfies this interface in order to register with the Storefront.