Skip to main content

Feedback widget for Gatsby

PushFeedback collects user feedback directly from your website. This guide covers installation in a Gatsby project using NPM.

Feedback widget for docs screenshot

Prerequisites​

Before you begin, you need:

  • A PushFeedback account. If you don't have one, sign up for free.
  • A project created in your PushFeedback dashboard. If you haven't created one yet, follow the steps in the Quickstart guide.
  • A Gatsby application and Node.js installed.

Installation​

  1. Install PushFeedback:

    npm install pushfeedback-react
    info

    If you're using yarn as your package manager, run yarn add pushfeedback-react instead of the npm command above.

  2. In the main component where you wish to place the feedback button (often src/pages/index.js), embed the PushFeedback button:

    import React, { useEffect } from 'react';

    import { FeedbackButton } from 'pushfeedback-react';
    import { defineCustomElements } from 'pushfeedback/loader';
    import 'pushfeedback/dist/pushfeedback/pushfeedback.css';

    const IndexPage = () => {
        
        useEffect(() => {
            if (typeof window !== 'undefined') {
                defineCustomElements(window);
            }
        }, []);

        return (
            <div className="page-layout">
                {/* Other components and content */}
                <FeedbackButton project="<YOUR_PROJECT_ID>" button-position="bottom-right" modal-position="bottom-right" button-style="dark">Feedback</FeedbackButton>
            </div>
        );
    }

    export default IndexPage;

    Replace <YOUR_PROJECT_ID> with your project's ID from the PushFeedback dashboard.

  3. Start your Gatsby app by running gatsby develop in your terminal. Once it compiles successfully, verify that the feedback button appears and functions correctly on your site.

Next steps​

Choose what to do next:

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