Feedback widget for MadCap Flare

Add the PushFeedback widget in MadCap Flare.

Prerequisites

• A PushFeedback project. Copy its project ID from Projects > your project > Snippet and replace <YOUR_PROJECT_ID> in the examples.
• MadCap Flare installed and a project opened.

Examples use @latest. Replace it with a version number to pin a release.

Installation

Floating button

1. In Content Explorer, open the template page used by your HTML5 target, usually under Resources > TemplatePages. Older projects may call these master pages. See Flare template pages.

2. Add the stylesheet and module script inside <head>:

   <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/pushfeedback@latest/dist/pushfeedback/pushfeedback.css" />
   <script type="module" src="https://cdn.jsdelivr.net/npm/pushfeedback@latest/dist/pushfeedback/pushfeedback.esm.js"></script>

3. Add the widget before </body>, replacing <YOUR_PROJECT_ID> with the ID from Snippet:

   <feedback-button project="<YOUR_PROJECT_ID>" button-position="bottom-right" modal-position="sidebar-right" button-style="dark">Feedback</feedback-button>

4. Assign the template page on the HTML5 target's Advanced tab, save, and build with Project > Build Primary.

5. Open a topic in the generated HTML5 output and send a test response. Confirm it appears in your PushFeedback project.

Tips

• If you have multiple template pages, you'll need to add the feedback button to each template page where you want it to appear.
• See Layout for positions and behavior.
• The feedback button will automatically appear on all pages that use the modified template page.

Other installation modes

Inline button

1. Load the widget inside <head> in the template page assigned to your HTML5 target:

   <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/pushfeedback@latest/dist/pushfeedback/pushfeedback.css" />
   <script type="module" src="https://cdn.jsdelivr.net/npm/pushfeedback@latest/dist/pushfeedback/pushfeedback.esm.js"></script>

2. Place the button in your template page or topic content:

   <feedback-button project="<YOUR_PROJECT_ID>" button-position="default" modal-position="center" button-style="dark" screenshot-positioning="true">Feedback</feedback-button>

Embedded form

1. Load the widget inside <head> in the template page assigned to your HTML5 target:

   <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/pushfeedback@latest/dist/pushfeedback/pushfeedback.css" />
   <script type="module" src="https://cdn.jsdelivr.net/npm/pushfeedback@latest/dist/pushfeedback/pushfeedback.esm.js"></script>

2. Place the form in your template page or topic content:

   <feedback-modal project="<YOUR_PROJECT_ID>" embedded="true"></feedback-modal>

Like and dislike buttons

1. Load the widget inside <head> in the template page assigned to your HTML5 target:

   <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/pushfeedback@latest/dist/pushfeedback/pushfeedback.css" />
   <script type="module" src="https://cdn.jsdelivr.net/npm/pushfeedback@latest/dist/pushfeedback/pushfeedback.esm.js"></script>

2. Place the rating controls in your template page or topic content:

   <p>Was this helpful?</p>
   <div class="pushfeedback-thumbs-row">
     <feedback-button project="<YOUR_PROJECT_ID>" rating="1" button-position="default" modal-position="center" button-style="default" custom-font="true" screenshot-positioning="true" hide-icon="true">
       <svg width="22" height="22" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M7 10v12"/><path d="M15 5.88 14 10h5.83a2 2 0 0 1 1.92 2.56l-2.33 8A2 2 0 0 1 17.5 22H3a2 2 0 0 1-2-2v-8a2 2 0 0 1 2-2h2.76a2 2 0 0 0 1.79-1.11L11 2a3.13 3.13 0 0 1 4 3.88Z"/></svg>
       <span class="pushfeedback-thumb-label">Helpful</span>
     </feedback-button>
     <feedback-button project="<YOUR_PROJECT_ID>" rating="0" button-position="default" modal-position="center" button-style="default" custom-font="true" screenshot-positioning="true" hide-icon="true">
       <svg width="22" height="22" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M17 14V2"/><path d="M9 18.12 10 14H4.17a2 2 0 0 1-1.92-2.56l2.33-8A2 2 0 0 1 6.5 2H21a2 2 0 0 1 2 2v8a2 2 0 0 1-2 2h-2.76a2 2 0 0 0-1.79 1.11L13 22a3.13 3.13 0 0 1-4-3.88Z"/></svg>
       <span class="pushfeedback-thumb-label">Not helpful</span>
     </feedback-button>
   </div>

Clicking a rating opens the form with that rating selected. It does not submit until the visitor sends it.

Next steps

• Customization: Adjust the widget's layout, styles, and text.
• Integrations: Forward feedback to Slack, email, Jira, and more.