Functions
Functions
lazy(p, [props])
Returns: function
Arguments:
p: LazyPlugin<T>
props: T
IntentProvider(props)
Returns: ReactNode
Arguments:
props: ProviderProps<IntentContext>
PluginHost(options)
Bootstraps an application by initializing plugins and rendering root components.
Returns: PluginDefinition<PluginHostProvides>
Arguments:
options: BootstrapPluginsParams
PluginProvider(props)
Returns: ReactNode
Arguments:
props: ProviderProps<PluginContext>
Surface(props)
A surface is a named region of the screen that can be populated by plugins.
Returns: ReactNode
Arguments:
props: Omit<SurfaceProps, "ref"> & RefAttributes<HTMLElement>
SurfaceProvider(props)
Returns: ReactNode
Arguments:
props: ProviderProps<SurfaceRootContext>
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
firstIdInPart(layout, part)
Returns: undefined | string
Arguments:
layout: undefined | object
part: "main" | "solo" | "sidebar" | "complementary" | "fullScreen"
getPlugin(plugins, id)
Find a plugin by ID, or raise an error if not found.
Returns: Plugin<T>
Arguments:
plugins: Plugin[]
id: string
indexInPart(layout, layoutCoordinate)
Returns: undefined | number
Arguments:
layout: undefined | object
layoutCoordinate: undefined | object
initializePlugin(pluginDefinition)
Resolve a PluginDefinition into a fully initialized Plugin .
Returns: Promise<Plugin<T & U>>
Arguments:
pluginDefinition: PluginDefinition<T, U>
isLayoutAdjustment(value)
Returns: value is object
Arguments:
value: unknown
isLayoutMode(value)
Returns: value is "deck" | "solo" | "fullscreen"
Arguments:
value: any
isLayoutParts(value)
Type guard for layout plugins.
Returns: value is object
Arguments:
value: unknown
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
openIds(layout)
Extracts all unique IDs from the layout parts.
Returns: string[]
Arguments:
layout: object
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
parseGraphSerializerPlugin(plugin)
Type guard for graph serializer plugins.
Returns: undefined | Plugin<GraphSerializerProvides>
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)
Returns: undefined | Plugin<object>
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
partLength(layout, part)
Returns: number
Arguments:
layout: undefined | object
part: undefined | "main" | "solo" | "sidebar" | "complementary" | "fullScreen"
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
useResolvePlugins(predicate)
Resolve a collection of plugins by predicate.
Returns: Plugin<T>[]
Arguments:
predicate: function
useSurface()
Returns: SurfaceProps
Arguments: none
useSurfaceRoot()
Returns: SurfaceRootContext
Arguments: none