Skip to content

Boards API ​

Functions the SDK exports for the roadmap, ideas and changelog. See Embed for use.

ts
mountRoadmap(target, options?)
mountIdeas(target, options?)
mountChangelog(target, options?)

target is an element or a CSS selector. Each returns a handle { destroy(), navigate(slug | null), on(event, callback) }.

Options ​

OptionTypeDefaultDescription
publicKeystringfrom init()Only needed when init() did not run on the page.
apiUrlstringfrom init()Backend origin.
routing"query" | "path" | "none""query"How the open item is kept in the URL.
basePathstringnonePath prefix for routing: "path".
onNavigate(slug | null) => voidnoneCalled when the user opens or leaves an item.
inheritFontbooleantrueUse the host page font.
colorScheme"light" | "dark" | "auto"workspace themeForce a scheme.

Panels ​

ts
openChangelog(options?)   // What's new panel
openRoadmap(options?)     // roadmap panel
getUnreadChangelogCount(): number
onUnreadChangelogCountChange(listener): () => void

options is { anchor?: HTMLElement, placement?: "popover" | "sidebar" }. See What's new widget.

Custom elements ​

<justonecx-roadmap>, <justonecx-ideas> and <justonecx-changelog> take routing and base-path attributes. The script tag registers them.

Script tag attributes ​

AttributeOption
data-boards-urlboardsUrl for init

JustOneCX