Giter Club home page Giter Club logo

feedback's Introduction

Feedback Widget for Next.js

Create a Feedback Widget for your Next.js site with two steps. The submitted message will be sent to your Slack channel.

No backend required! See the demo

Install

1. Install Package

yarn add @upstash/feedback

2. Environment Variables

Then create a .env file at the root directory of your application and add your webhook URL (Slack, Discord etc).

SLACK_WEBHOOK_URL='my-secret-webhook-url'

SLACK_WEBHOOK_URL can be found at the Slack integration page in https://api.slack.com/messaging/webhooks

3. Import CSS and Widget

// pages/_app.js

import "@upstash/feedback/index.css";
import FeedbackWidget from "@upstash/feedback";

export default function MyApp({ Component, pageProps }) {
  return (
    <>
      <FeedbackWidget />
      <Component {...pageProps} />
    </>
  );
}

4. Create API

// pages/api/feedback.js

import createFeedbackAPI from "@upstash/feedback/api";

export default createFeedbackAPI({
  webhooks: [process.env.SLACK_WEBHOOK_URL],
});

You can create multiple webhooks for multiple channels. Seperate them with a comma [process.env.SLACK1_WEBHOOK_URL, process.env.SLACK2_WEBHOOK_URL, process.env.DISCORD_WEBHOOK_URL]

Options

The options can be passed as React props

key type default accept
user? string
metadata? object null
type? string "form" 'form', 'rate', 'full'
apiPath? string 'api/feedback'
themeColor? string '#5f6c72'
textColor? string '#ffffff'
title string, React.ReactElement
description string, React.ReactElement
showOnInitial? boolean false

If you already have an id (or email) for the current user, you can pass it to the component as a parameter, so the feedback will be stored together with the user's id.

<FeedbackWidget type="full" user={currentUser.email} />

Also, you can set a user id just to hide email input, so the form can be submitted anonymously.

<FeedbackWidget type="full" user="anything" />

feedback's People

Contributors

ademilter avatar tuanductran avatar renovate[bot] avatar enesakar avatar chronark avatar itssiva avatar dependabot[bot] avatar

Watchers

 avatar

feedback's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

  • chore(deps): update dependency autoprefixer to v10.4.19
  • chore(deps): update dependency postcss to v8.4.40
  • fix(deps): update dependency classnames to v2.5.1
  • ๐Ÿ” Create all rate-limited PRs at once ๐Ÿ”

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

npm
demo/package.json
  • @tailwindcss/forms ^0.5.1
  • next ^13.0.0
  • react ^18.1.0
  • react-dom ^18.1.0
  • @types/node ^18.0.0
  • @types/react ^18.0.9
  • autoprefixer ^10.4.7
  • postcss ^8.4.13
  • tailwindcss ^3.0.24
  • typescript ^5.0.0
package.json
  • classnames ^2.3.1
  • next ^13.0.0
  • react ^18.1.0
  • react-dom ^18.1.0
  • @types/node ^18.0.0
  • @types/react ^18.0.9
  • @types/react-dom ^18.0.3
  • autoprefixer ^10.4.7
  • postcss ^8.4.31
  • prettier ^3.0.0
  • tsup ^7.0.0
  • typescript ^5.0.0

  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.