Skip to content

Commit

Permalink
Add shadcn-chatbot-kit files
Browse files Browse the repository at this point in the history
  • Loading branch information
iipanda committed Oct 26, 2024
1 parent 630afe8 commit db26489
Show file tree
Hide file tree
Showing 2,618 changed files with 3,575 additions and 217,464 deletions.
8 changes: 0 additions & 8 deletions .changeset/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions .changeset/config.json

This file was deleted.

12 changes: 0 additions & 12 deletions .github/changeset-version.js

This file was deleted.

21 changes: 0 additions & 21 deletions .github/version-script-beta.js

This file was deleted.

21 changes: 0 additions & 21 deletions .github/version-script-next.js

This file was deleted.

18 changes: 0 additions & 18 deletions .kodiak.toml

This file was deleted.

175 changes: 0 additions & 175 deletions CONTRIBUTING.md

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 shadcn
Copyright (c) 2023 - 2024 shadcn, Blazity

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
84 changes: 76 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,85 @@
# shadcn/ui
# shadcn-chatbot-kit

Accessible and customizable components that you can copy and paste into your apps. Free. Open Source. **Use this to build your own component library**.
A comprehensive chatbot component kit built on top of and fully compatible with the [shadcn/ui](https://ui.shadcn.com/) ecosystem. Build beautiful, customizable AI chatbots in minutes while maintaining full control over your components.

![hero](apps/www/public/og.jpg)

## Documentation
[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
[![shadcn/ui](https://img.shields.io/badge/built%20with-shadcn%2Fui-black.svg)](https://ui.shadcn.com)

Visit http://ui.shadcn.com/docs to view the documentation.
## ✨ Features

## Contributing
- 🎨 **Fully Themeable**: Leverages shadcn/ui's theming system for complete visual customization
- 📦 **Copy & Paste Components**: Install only what you need, own your components
- 🔧 **Highly Customizable**: Modify any aspect of the components to match your needs
- 📱 **Responsive Design**: Works seamlessly across all device sizes
- 🚀 **Modern Code**: Built with the latest web standards and best practices

Please read the [contributing guide](/CONTRIBUTING.md).
## 🧩 Components

## License
The kit includes everything you need to build a full-featured chatbot:

Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.md).
- **Chat**: Pre-built chat component, with option to build a custom one with composable components
- **Auto-Scroll Message Area**: Smart scrolling behavior for new messages
- **Message Input**:
- Auto-resize textarea
- File upload support
- Preview attached files
- **Prompt Suggestions**: Help users with quick action buttons
- **Message Actions**: Built-in copy, rate response, and other utility buttons
- **Loading States**: Elegant loading indicators and transitions

## 📦 Installation

1. First, follow the [installation instructions](https://ui.shadcn.com/docs/installation) for shadcn/ui in your project.

2. Make sure you're using the modern `shadcn` CLI (not the legacy `shadcn-ui`).

3. Install components using the CLI.

Visit [the documentation](https://shadcn-chatbot-kit.vercel.app/docs/components/chat) for detailed installation instructions and a full list of available components.

## 🚀 Quick Start

**Note:** This example uses the Vercel AI SDK. Follow the [official Getting Started guide](https://sdk.vercel.ai/docs/getting-started/nextjs-app-router#create-your-application), before using it.

```tsx
"use client"

import { useChat } from "ai/react"

import { Chat } from "@/components/ui/chat"

export function ChatDemo() {
const { messages, input, handleInputChange, handleSubmit, isLoading, stop } =
useChat()

return (
<Chat
messages={messages}
input={input}
handleInputChange={handleInputChange}
handleSubmit={handleSubmit}
isGenerating={isLoading}
stop={stop}
/>
)
}
```

## 🎨 Customization

All components are built using shadcn/ui's styling system, making them fully customizable using CSS variables.
Visit our [theme customizer](https://shadcn-chatbot-kit.vercel.app/themes) to visually design your chatbot's appearance.

## 🤝 Contributing

Contributions are always welcome! Feel free to:

- Submit bug reports and feature requests
- Open pull requests to improve the codebase
- Share feedback and suggestions

## 👨‍⚖️ License

Licensed under the [MIT license](https://github.com/Blazity/shadcn-chatbot-kit/blob/main/LICENSE.md).
Loading

0 comments on commit db26489

Please sign in to comment.