feedyourback-client v1.0.0
FeedYourBack Client
A lightweight and easy-to-use React component for seamless integration of FeedYourBack into your React and Next.js applications. FeedYourBack is a powerful feedback collection tool that helps you gather valuable insights from your users.
Learn more about FeedYourBack on the FeedYourBack official website.
Features
- Simple integration with React and Next.js applications
- Customizable appearance
- Automatic script loading and cleanup
- TypeScript support
Installation
You can install the FeedYourBack Client using npm or yarn:
# Using npm
npm install feedyourback-client
# Using yarn
yarn add feedyourback-client
Usage
Basic Usage
import { FeedYourBack } from "feedyourback-client";
export default function YourComponent() {
return (
<FeedYourBack
dataId="your-feedyourback-id"
className="custom-class" // optional
/>
);
}
Next.js Usage
For Next.js applications, use dynamic imports to avoid SSR issues:
import dynamic from "next/dynamic";
const FeedYourBack = dynamic(
() => import("feedyourback-client").then((mod) => mod.FeedYourBack),
{ ssr: false }
);
export default function YourNextJsComponent() {
return (
<FeedYourBack
dataId="your-feedyourback-id"
className="custom-class" // optional
/>
);
}
Configuration
The FeedYourBack component accepts the following props:
Prop | Type | Required | Description |
---|---|---|---|
dataId | string | Yes | Your unique FeedYourBack form ID (found in the <script> integration code) |
className | string | No | Additional CSS classes to add to the container (default: "") |
Browser Compatibility
FeedYourBack Client is compatible with all modern browsers, including:
- Chrome (latest)
- Firefox (latest)
- Safari (latest)
- Edge (latest)
Troubleshooting
If you encounter any issues while using FeedYourBack Client, try the following:
- Ensure you're using the correct
dataId
from your FeedYourBack account. - Check that the FeedYourBack script is loading correctly in your browser's network tab.
- For Next.js applications, make sure you're using the dynamic import method to avoid SSR issues.
If problems persist, please open an issue on our GitHub repository.
Contributing
We welcome contributions to FeedYourBack Client! Please read our contributing guidelines before submitting pull requests.
License
FeedYourBack Client is released under the MIT License. See the LICENSE file for details.
Additional Resources
Support
If you need help with FeedYourBack Client, please contact our support team or join our community forum.
Made with ❤️ by the Oumarou Sanda Souley
5 months ago