10xAnswers: ChatBot Component

Welcome to 10xAnswers, a fully customizable and draggable chatbot component built with React and Recoil. This package is designed to help you integrate an intelligent chatbot into your project effortlessly, eliminating the need to create one from scratch. With support for markdown rendering, draggable components, customizable prompts, and state management, 10xAnswers is your go-to solution for chatbot integration.

Table of Contents

1. Introduction
2. Demo
3. Features
4. Installation
5. Quick Example
6. Props
   • Basic Props
   • Styling Props
7. Advanced Usage
8. All Props
   • Props Overview
9. Prompt Guidelines
   • Default Prompt
   • Custom Prompt
10. Gemini API Integration
11. Backend Integration
    • URL-based Integration
12. Warnings and Important Notes
13. Screenshots
14. Upcoming Features
15. Author
16. Contribution and Support

Demo

[Live Demo Link - Coming Soon]

Features

• Plug-and-Play: Simple to install and use.
• Customizable: Style the chat window, bot icon, and entire chat component as per your needs.
• Markdown Support: Renders code snippets, tables, and more.
• State Optimization: Built using React and Recoil for efficient state management.
• Connectivity Check: Includes a custom hook to display internet connectivity status.
• Draggable UI: Make the chatbot draggable for flexible placement.
• Backend Support: Option to use your backend or provided URL for response generation.
• Open Source: Fully accessible codebase for contributions and enhancements.

Installation

npm install 10xanswers
# or
yarn add 10xanswers
# or
pnpm add 10xanswers

Quick Example

import React from 'react';
import { ChatBot } from '10xanswers';

function App() {
  return (
    <ChatBot 
      backendUrl="https://ask-10x-questions.vercel.app/"
      draggable={true}
    />
  );
}

export default App;

Important: The provided URL https://ask-10x-questions.vercel.app/ is a pre-configured backend that works seamlessly with the 10xAnswers component.

Props

Basic Props

Styling Props

Advanced Usage

<ChatBot 
  backendUrl="https://ask-10x-questions.vercel.app/"
  title="100xQuestions"
  stylizeTitle={{emphasized:"100x",normal:"Questions"}}//optional
  botIcon="./logoImg2.jpg"
  userIcon="./logoImg.jpg"
  draggable={true}
  x={500}
  y={625}
  prompt="You're and artisted turned developer, not respond accordingly"
  description="AI-powered conversational assistant"
  cta="Start Asking"
  startOpen={true}
/>

All Props

Props

Prompt Guidelines

• With prompt: If a custom prompt is provided, it will be sent along with the user question.
• Without prompt: If prompt is set to "none", only the user question with no prompt is sent to the ai model- not recommended.

Example Prompts

Default Prompt:
If no prompt is provided, default prompt will be sent to the model along with the questions asked by client

You are 10xAnswers, an intelligent and highly versatile chatbot. Your purpose is to assist users with precision, accuracy, and clarity...

Custom Prompt: You can specify your custom prompts here, every question of client will be sentto model along with this prompt

User is sending a custom prompt about behavior. Prompt: ${prompt}. Question: ${question}. History: ${chatHistory}.

Gemini API Integration

If you don't have a working backend you can directly use Google's Gemini API and pass it in the props, and send requests to the gemini directly from frontend. Not recommended as this exposes the api key to the users of your web app.

Backend Integration

URL-based Integration

POST requests are sent to backend with the following payload:

{
  "method": "POST",
  "body": {
    "contents": [{
      "parts": [{"text": "User question"}]
    }]
  }
}

Warning and Important Notes

Development Caution:

• After changing any prop of the chat component, changes will only be visible after reloading.
• Exposing Gemini API key directly in frontend is NOT recommended as it exposes your key to users.

Screenshots

Upcoming Features

• Media message support
• Voice interaction modes
• Additional themes
• Enhanced customization options

Author

Rajveer Singh

• Twitter: @rajveeerrsingh

Contribution and Support

• Open-source contributions welcome
• Contact on:
  • X (Twitter): https://x.com/RajveeerrSingh
  • GitHub: https://github.com/rajveeerr

Found an issue? Open a GitHub Issue

Enjoying 10xAnswers? Consider starring the repository! ⭐

Start building smarter projects with 10xAnswers today! 🚀