Functions

lazy(p, [props])

Returns: function

Arguments:

p: LazyPlugin<T>

props: T

IntentProvider(props)

NOTE: Exotic components are not callable.

Returns: "null" | ReactElement<any, string | JSXElementConstructor<any>>

Arguments:

props: ProviderProps<IntentContext>

PluginHost(options)

Bootstraps an application by initializing plugins and rendering root components.

Returns: PluginDefinition<PluginHostProvides>

Arguments:

options: BootstrapPluginsParams

PluginProvider(props)

NOTE: Exotic components are not callable.

Returns: "null" | ReactElement<any, string | JSXElementConstructor<any>>

Arguments:

props: ProviderProps<PluginContext>

Surface(props)

A surface is a named region of the screen that can be populated by plugins.

Returns: "null" | ReactElement<any, string | JSXElementConstructor<any>>

Arguments:

props: Pick<SurfaceProps, string | number> & RefAttributes<HTMLElement>

SurfaceProvider(props)

NOTE: Exotic components are not callable.

Returns: "null" | ReactElement<any, string | JSXElementConstructor<any>>

Arguments:

props: ProviderProps<SurfaceRootContext>

activeIds(active)

Returns: Set<string>

Arguments:

active: undefined | string | Record<string, string | string[]>

createApp(options)

Expected usage is for this to be the entrypoint of the application. Initializes plugins and renders the root components.

Returns: function

Arguments:

options: BootstrapPluginsParams

definePlugin(plugin)

Define a plugin

Returns: Plugin<TProvides>

Arguments:

plugin: Plugin<TProvides>

filterPlugins(plugins, predicate)

Filter a list of plugins to only those that match a predicate.

Returns: Plugin<T>[]

Arguments:

plugins: Plugin[]

predicate: function

findPlugin(plugins, id)

Find a plugin by ID.

Returns: undefined | Plugin<T>

Arguments:

plugins: Plugin[]

id: string

firstMainId(active)

Returns: string

Arguments:

active: undefined | string | Record<string, string | string[]>

getPlugin(plugins, id)

Find a plugin by ID, or raise an error if not found.

Returns: Plugin<T>

Arguments:

plugins: Plugin[]

id: string

initializePlugin(pluginDefinition)

Resolve a PluginDefinition into a fully initialized Plugin .

Returns: Promise<Plugin<T & U>>

Arguments:

pluginDefinition: PluginDefinition<T, U>

isActiveParts(active)

Returns: active is Record<string, string | string[]>

Arguments:

active: undefined | string | Record<string, string | string[]>

isAdjustTransaction(data)

Returns: data is NavigationAdjustment

Arguments:

data: undefined | IntentData

isIdActive(active, id)

Returns: boolean

Arguments:

active: undefined | string | Record<string, string | string[]>

id: string

isObject(data)

Checks if the given data is an object and not null.

Useful inside surface component resolvers as a type guard.

Returns: data is object

Arguments:

data: unknown

parseFileManagerPlugin(plugin)

Returns: undefined | Plugin<FileManagerProvides>

Arguments:

plugin: Plugin

parseGraphBuilderPlugin(plugin)

Type guard for graph builder plugins.

Returns: undefined | Plugin<GraphBuilderProvides>

Arguments:

plugin: Plugin

parseGraphPlugin(plugin)

Type guard for graph plugins.

Returns: undefined | Plugin<GraphProvides>

Arguments:

plugin: Plugin

parseIntentPlugin(plugin)

Returns: undefined | Plugin<IntentPluginProvides>

Arguments:

plugin: Plugin

parseIntentResolverPlugin(plugin)

Returns: undefined | Plugin<IntentResolverProvides>

Arguments:

plugin: Plugin

parseLayoutPlugin(plugin)

Type guard for layout plugins.

Returns: undefined | Plugin<LayoutProvides>

Arguments:

plugin: Plugin

parseMetadataRecordsPlugin(plugin)

Returns: undefined | Plugin<MetadataRecordsProvides>

Arguments:

plugin: Plugin

parseMetadataResolverPlugin(plugin)

Returns: undefined | Plugin<MetadataResolverProvides>

Arguments:

plugin: Plugin

parseNavigationPlugin(plugin)

Type guard for layout plugins.

Returns: undefined | Plugin<LocationProvides>

Arguments:

plugin: Plugin

parsePluginHost(plugin)

Returns: undefined | Plugin<PluginHostProvides>

Arguments:

plugin: Plugin

parseRootSurfacePlugin([plugin])

Returns: undefined | Plugin<SurfacePluginProvides>

Arguments:

plugin: Plugin

parseSettingsPlugin(plugin)

Returns: undefined | Plugin<SettingsProvides<Record<string, any>>>

Arguments:

plugin: Plugin

parseSurfacePlugin([plugin])

Returns: undefined | Plugin<SurfaceProvides>

Arguments:

plugin: Plugin

parseTranslationsPlugin(plugin)

Type guard for translation plugins.

Returns: undefined | Plugin<TranslationsProvides>

Arguments:

plugin: Plugin

pluginMeta(meta)

Returns: object

Arguments:

meta: object

resolvePlugin(plugins, predicate)

Resolves a plugin by predicate.

Returns: undefined | Plugin<T>

Arguments:

plugins: Plugin[]

predicate: function

useIntent()

Returns: IntentContext

Arguments: none

useIntentDispatcher()

Returns: IntentDispatcher

Arguments: none

useIntentResolver(plugin, resolver)

Returns: void

Arguments:

plugin: string

resolver: IntentResolver

usePlugin(id)

Get a plugin by ID.

Returns: undefined | Plugin<T>

Arguments:

id: string

usePlugins()

Get all plugins.

Returns: PluginContext

Arguments: none

useResolvePlugin(predicate)

Resolve a plugin by predicate.

Returns: undefined | Plugin<T>

Arguments:

predicate: function

useSurface()

Returns: SurfaceProps

Arguments: none

useSurfaceRoot()

Returns: SurfaceRootContext

Arguments: none