saasupport
v1.0.4
Published
A customizable support widget for SaaS businesses
Downloads
378
Maintainers
Readme
SaaSupport
SaaSupport is a customizable support widget designed for SaaS businesses to enhance customer service and engagement. It offers a seamless integration with React and Next.js, providing a robust solution for managing support tickets, feature suggestions, and user guides.
About the Project
SaaSupport aims to streamline customer support by offering a widget that can be easily integrated into your SaaS platform. With features like ticket management, feature suggestion, and user guides, it helps improve user experience and engagement.
Built With
- React: A JavaScript library for building user interfaces.
- Next.js: A React framework for production.
- Firebase: Used for backend services like authentication and database.
Getting Started
To get started with SaaSupport, follow these steps to integrate it into your React/Next.js application.
Installation
Install the package using npm:
npm install saasupport
Usage
To use the SaaSupport widget in your React/Next.js application, you can follow the example below, inspired by the implementation in the Playground
component:
// dashboard/src/app/dashboard/playground/page.tsx
import dynamic from 'next/dynamic';
import { useState, useEffect } from 'react';
import { auth, onAuthStateChanged } from '../../../../firebase';
const SaaSupport = dynamic(
() => import('saasupport').then((mod) => mod.default),
{ ssr: false }
);
const Playground: React.FC = () => {
const [uid, setUid] = useState<string | null>(null);
useEffect(() => {
const unsubscribe = onAuthStateChanged(auth, (user) => {
if (user) {
setUid(user.uid);
} else {
setUid(null);
}
});
return () => unsubscribe();
}, []);
return (
<div>
{uid && (
<SaaSupport
userId={uid}
apiKey={'your-api-key'}
showSuggestFeature={true}
showSuggestions={true}
showGuide={{
show: true,
title: 'Guide Title',
description: 'Guide Description',
link: 'https://example.com',
imageUrl: 'https://example.com/image.jpg'
}}
backgroundColor="#E5E7EB"
/>
)}
</div>
);
}
export default Playground;
Cross-Platform Support
Currently, SaaSupport is optimized for use with React and Next.js. Future updates will aim to expand compatibility with other frameworks and platforms.
Version History
- 1.0.4: Updated basic UI.
- 1.0.3: Fully functional product release.
- 1.0.2: Basic UI setup.
- 1.0.1: Initial deployment.
License
This project is licensed under the MIT License.