@ditadi/feedback v0.1.0

Feedback is a simple React component that has the goal to be added on your website to continuous feedback collection. You can use as open ui or as popover, triggered by a button.

Usage

To start using the library, install it in your project:,

npm install @ditadi/feedback
bun install @ditadi/feedback

Use the feedback in your app.

"use client";

import { Feedback } from "@ditadi/feedback";
import "@ditadi/feedback/index.css";

export const FeedbackComponent = () => {
    return (
        <Feedback
            renderType="open"
            labelFeedbackPlaceholder="Your feedback..."
            labelFeedbackAction="Send"
            labelFeedbackMoodMissing="Please select a mood."
            labelFeedbackTextMissing="Please enter feedback."
            labelFinishTitle="Your feedback has been received."
            labelFinishSubtitle="Thank you for your help."
            onFeedbackSent={(e) => console.log(e)}
        />
    );
};

API Reference

Feedback

Contains all the possible texts you want to customize, ui style and callbacks when a feedback is sent or the ui is shown.

Props:

renderType: UI Style of the Feedback. Can be open or popover. Required.

labelTitle: String added as small title above the text area. Optional.

labelFeedbackPlaceholder: String added on text area placeholder. Optional.

labelFeedbackAction: String added on button to send feedback. Optional.

labelFeedbackTextMissing: String added to show when the feedback text is empty. Optional.

labelFeedbackMoodMissing: String added to show when no emoji is selected. Optional.

labelFinishTitle: String added to inform that the feedback was sent. Optional.

labelFinishSubtitle: String added to increase your message when the feedback was sent. Optional.

onFeedbackSent: Callback returning the response of the feedback.

interface FeedbackResponse {
    feedbackText: string;
    feedbackMood: number;
}

License

this project website was heavily inspired by https://vaul.emilkowal.ski/

MIT