Widgets

Introduction

featureOS provides highly customizable widget for feedback boards, roadmap, and changelog.

Setup

The basic setup process invovles adding the following snippet into your website and add a trigger button to which will trigger the widget.

<button id="hellonextWidget">Click Here ✨</button>
<script>
  const widget = new window.HellonextWidget({
    token: 'YOUR ORGANIZATION WIDGET TOKEN',
    modules: ['feature_requests', 'changelog'],
    selector: '#hellonextWidget',
  })
  widget.init()
</script>

Options

• token: Your organization widget token. You can find your organization widget token in your organization settings

• jwtToken: The JWT token of the user. This is required if you want to enable the user to create feature requests and vote on them.

• modules: Modules to be enabled in the widget. Currently, we support feature_requests and changelog modules.

• selector: The selector to which the widget should be attached to.

• placement: The position of the widget. Currently, we support left and right positions.

• openFrom: The position from which the widget should open. Currently, we support left and right positions.

• type: The type of the widget. Currently, we support popover and modal types.

• theme: The theme of the widget. Currently, we support light and dark themes.

• accent: The accent color of the widget. This should be the hex color code

• triggerText: The text to be displayed on the trigger button when the selector is not mentioned

• enableIndicator: Enable the indicator to show the number of new changelog published

• submissionBucketIds: The bucket ids to which the feature requests should be submitted to, only the bucket ids mentions here will be show in submission form bucket dropdown

• showOnlySubmission: When this is enabled, only the submission form will be shown for feature_requests module

• changelogFilters: The filters to be applied to the changelog module.

  • per_page: The number of changelog items to be shown per page
  • ids: The ids of the changelog items to be shown
  • labels: The labels of the changelog items to be shown
  • published_at: The date from which the changelog items should be shown

• postFilters: The filters to be applied to the feature requests module.

  • status: The status of the feature requests to be shown
  • bucket_id: The bucket id of the feature requests to be shown

Methods

• widget.open: Open the widget programmatically

• widget.close: Close the widget programmatically

Events

• onInitialized: This event is triggered when the widget is initialized

• onNewChangelogIndicator: This event is triggered when a new changelog is published