Skip to main content

Feedback widget for Next.js

Here's a step-by-step guide to help you install PushFeedback in your Next.js project using NPM.

Prerequisites

Before you begin, you'll need to have the following:

  • 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 Next.js application and Node.js installed.

Installation

To integrate the PushFeedback widget into your Next.js site:

  1. Open your terminal or command prompt. Navigate to your project's root directory using the cd command:

    cd path/to/your/project

    Replace path/to/your/project with your project's actual directory path.

  2. With your terminal still open, run the following command to 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.

    This will download and install the PushFeedback package into your project.

  1. Create a wrapper for the feedback button by creating a file under the path components/pushfeedback.tsx and paste the following code:

    import React, { useEffect } from 'react';
    import { FeedbackButton } from 'pushfeedback-react';
    import { JSX, defineCustomElements } from 'pushfeedback/loader';
    import { StyleReactProps } from 'pushfeedback-react/dist/types/react-component-lib/interfaces';
    import 'pushfeedback/dist/pushfeedback/pushfeedback.css';

    const DynamicFeedbackButtonComponent = (props: React.JSX.IntrinsicAttributes & JSX.FeedbackButton & Omit<React.HTMLAttributes<HTMLFeedbackButtonElement>, "style"> & StyleReactProps & React.RefAttributes<HTMLFeedbackButtonElement>) => {
    useEffect(() => {
    defineCustomElements(window);
    }, []);

    return <FeedbackButton {...props} />;
    };

    export default DynamicFeedbackButtonComponent;
  2. In the component where you wish to display the feedback button (often _pages/app.tsx or app/layout.tsx), include it shown below:

    'use client'
    import dynamic from 'next/dynamic';

    export default function Banner() {

    const DynamicFeedbackButton = dynamic(() => import('@/components/utils/pushfeedback'), {
    ssr: false,
    });

    return (
    <div className="App">
    {/* Other components and content */}
    <DynamicFeedbackButton project="c2syqqm916" button-position="bottom-right" modal-position="bottom-right" button-style="light" custom-font="true">Feedback</DynamicFeedbackButton>
    </div>
    );
  3. Start your Next.js app by running npm start or yarn start in your terminal. Once it compiles successfully, verify that the feedback button appears and functions correctly on your site.

Next steps

For more about customization and additional features exploration, check out the Configuration section.

Need assistance? We're here to help! Reach out to us at PushFeedback Support.