Widget configuration options

Control the widget's theme, position, default section, and trigger behaviour when you initialise it.

TFTeam FeatulUpdated Oct 241 min read

When you call featul.init() you can pass an options object to adjust how the widget looks and behaves.

Available options

  • widget – true or false. Set to false to load the SDK without showing the launcher.

  • theme – "light", "dark", or "auto". "auto" follows your workspace branding settings, or the OS theme when the workspace uses the system theme. Explicit values override the workspace theme for that embed only.

  • position – "left" or "right". Controls which side the launcher appears on. Defaults to "right".

  • trigger – "default" or "custom". Use "custom" when you want your own button to open the widget instead of the built-in launcher.

  • defaultSection – "home", "feedback", "roadmap", or "changelog". Sets which tab opens first. Falls back to Home if the section is hidden in workspace settings.

  • offset – An object with bottom, left, and right values to adjust the launcher position.

Using a custom trigger

Set trigger: "custom" in your init call, then call featul.showWidget({ section: "feedback" }) from your own button's click handler. This hides the default launcher entirely.

Roadmap and Changelog visibility

If you hide Roadmap or Changelog in Settings → Workspace, those tabs disappear from the widget automatically. The defaultSection and showWidget({ section }) calls fall back to Home when the target section is hidden.

Was this helpful?

Still stuck?

Post it on the board. The team answers there.