Appearance
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
| Option | Type | Default | Description |
|---|---|---|---|
publicKey | string | from init() | Only needed when init() did not run on the page. |
apiUrl | string | from init() | Backend origin. |
routing | "query" | "path" | "none" | "query" | How the open item is kept in the URL. |
basePath | string | none | Path prefix for routing: "path". |
onNavigate | (slug | null) => void | none | Called when the user opens or leaves an item. |
inheritFont | boolean | true | Use the host page font. |
colorScheme | "light" | "dark" | "auto" | workspace theme | Force a scheme. |
Panels
ts
openChangelog(options?) // What's new panel
openRoadmap(options?) // roadmap panel
getUnreadChangelogCount(): number
onUnreadChangelogCountChange(listener): () => voidoptions 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
| Attribute | Option |
|---|---|
data-boards-url | boardsUrl for init |