vinsta-client

Overview

vinsta-client is a customizable, easy-to-use popup window module for React applications, provided by Vinsta. This package is designed to establish a connection between your website and Vinsta's WebRTC servers, enabling direct access to Vinsta's customer service application. By integrating vinsta-client into your web platform, your users can enjoy seamless customer support experiences directly from your website.

Features

• Seamless Integration: Integrate the support assistant into your application with a few simple steps.
• Customizable Interface: Modify the user interface to match your brand's aesthetics.
• Direct Communication: Utilize built-in WebRTC technology for live, reliable customer service.
• Efficiency: Designed to be lightweight, without compromising your site's performance.
• Responsive: Adaptive design for a consistent experience across various devices.

Installation

To install the package via npm, run:

npm install @vinsta/vinsta-client

Or if you're using yarn, run:

yarn add @vinsta/vinsta-client

Usage

Here's how to incorporate vinsta-client into your React application:

import VinstaClient from '@vinsta/vinsta-client';

const App = () => {
  return (
    <div className="App">
      <VinstaClient serverUrl="your-vinsta-server-url" />
    </div>
  );
};

export default App;

Configuration

You can customize vinsta-client by passing in props:

<VinstaClient
  serverUrl="your-vinsta-server-url"
  themeColor="#00AABB"
  position="bottom-right"
/>

Props

• serverUrl (string): The endpoint for your Vinsta WebRTC server.
• themeColor (string): The primary color for the theme, defined in hex code.
• position (string): Determines where the popup will appear on the screen, with options such as "bottom-right", "bottom-left", "top-right", and "top-left".

Support

If you encounter any issues or have questions, feel free to open an issue on our GitHub repository issue tracker.

Contributing

Contributions are welcome! To contribute, please fork the repository, commit your changes, and open a pull request with a detailed description of your updates.

License

vinsta-client is made available under the MIT License. For more details, refer to the LICENSE file in the repository.