README.md

This package is archived.

@feedbackfarm/core

Feedback.farm core api

This small package allow you to call the Feedback.farm api from your custom UI.

Demos

• Code Sandbox

Usage

1. Create a project on the feedback.farm platform and then grab the project id.

2. npm install @feedbackfarm/core

3. Insert the following snippet

// index.jsx
import { seendFeedback } from "@feedbackfarm/core";

async function handleSubmitFeedback() {
    const result = await sendFeedback(
        projectId,
        feedbackText,
        type,
        identifier,
        pageName
    );
}

Parameters

Parameters	Type	Description	Required
projectId	string	Project identifier available on feedback.farm platform	✅
feedbackText	string	User feedback	✅
type	BUG ; FEATURE ; OTHER	Feedback type	✅
identifier	string	User identifier (email, id, ...)
pageName	string	Page name / page url
logs	Log[]	Logs

Full documentation