Feedback widget for Antora

Add PushFeedback to your Antora site.

Prerequisites

• A PushFeedback project. Copy its project ID from Projects > your project > Snippet and replace <YOUR_PROJECT_ID> in the examples.
• An Antora project.

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

The examples extend the Antora Default UI with supplemental UI files. Keep your existing UI bundle.

Installation

Floating button

1. Add supplemental_files under your existing playbook ui configuration:

   ui:
     supplemental_files: ./supplemental-ui

2. Copy partials/head-scripts.hbs from your UI bundle to supplemental-ui/partials/head-scripts.hbs. Keep its contents and append:

   <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. Copy partials/footer-content.hbs from the bundle to supplemental-ui/partials/footer-content.hbs. Keep the existing footer and append:

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

Inline button

1. Add supplemental_files under your existing playbook ui configuration:

   ui:
     supplemental_files: ./supplemental-ui

2. Copy partials/head-scripts.hbs from your UI bundle to supplemental-ui/partials/head-scripts.hbs. Keep its contents and append:

   <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. Copy partials/footer-content.hbs from the bundle to supplemental-ui/partials/footer-content.hbs. Keep the existing footer and append:

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

Embedded form

1. Add supplemental_files under your existing playbook ui configuration:

   ui:
     supplemental_files: ./supplemental-ui

2. Copy partials/head-scripts.hbs from your UI bundle to supplemental-ui/partials/head-scripts.hbs. Keep its contents and append:

   <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. Copy partials/footer-content.hbs from the bundle to supplemental-ui/partials/footer-content.hbs. Keep the existing footer and append:

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

Like and dislike buttons

1. Add supplemental_files under your existing playbook ui configuration:

   ui:
     supplemental_files: ./supplemental-ui

2. Copy partials/head-scripts.hbs from your UI bundle to supplemental-ui/partials/head-scripts.hbs. Keep its contents and append:

   <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. Copy partials/footer-content.hbs from the bundle to supplemental-ui/partials/footer-content.hbs. Keep the existing footer and append:

   <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>

Verify the installation

Run your Antora build command, such as npx antora antora-playbook.yml. Open your site and send a test message. Confirm it appears in your PushFeedback project. Check allowed URLs if submission fails.

Next steps

See Layout, Styles, and Text for widget options.