https://github.com/botui/botui

🤖 A JavaScript framework for building conversational UIs
https://github.com/botui/botui

bot botui chat conversational-ui javascript react typescript

Last synced: 5 days ago
JSON representation

🤖 A JavaScript framework for building conversational UIs

• Host: GitHub
• URL: https://github.com/botui/botui
• Owner: botui
• License: mit
• Created: 2017-06-29T15:54:57.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-04-25T18:31:50.000Z (over 1 year ago)
• Last Synced: 2024-12-18T22:05:31.388Z (12 days ago)
• Topics: bot, botui, chat, conversational-ui, javascript, react, typescript
• Language: TypeScript
• Homepage: https://botui.org
• Size: 3.11 MB
• Stars: 2,866
• Watchers: 57
• Forks: 373
• Open Issues: 72
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
![logo](packages/botui/assets/logo.svg)

[![join discussion](https://img.shields.io/badge/discussions-🤝-blueviolet?style=flat-square)](https://github.com/botui/botui/discussions) [![npm](https://img.shields.io/npm/v/botui.svg?style=flat-square)](https://www.npmjs.com/package/botui) [![npm](https://img.shields.io/npm/dm/botui.svg?style=flat-square)](https://www.npmjs.com/package/botui) [![Twitter Follow](https://img.shields.io/twitter/follow/moinism)](https://twitter.com/moinism)

> A JavaScript framework for creating conversational UIs.

[Main Site](https://botui.org) - [Read Docs](https://docs.botui.org) - [Examples](https://github.com/moinism/botui-examples) - [🪄 Quickstart](https://github.com/botui/react-quickstart)

## Showcase 🎇✨

We are listing all the cool projects that people are building with BotUI, [here](https://github.com/botui/botui/blob/master/Showcase.md). See others' and add yours!

🚨 **Note**

This version is using a completely different approach for building UIs. Do not use it as a drop-in replacement for the previous version. If you want to use the previous (vue-only) approach, install the `0.3.9` version: `npm i [email protected]`.

### Quick look

![preview](packages/botui/assets/botui_preview.gif)

## Installation

```bash

npm i botui @botui/react

```

### Example usage in React

```js

import { useEffect } from 'react'

import { createRoot } from 'react-dom/client'

import { createBot } from 'botui'

import { BotUI, BotUIMessageList, BotUIAction } from '@botui/react'

const myBot = createBot()

```

```html



```


```js

const App = () => {

  useEffect(() => {

    myBot

      .wait({ waitTime: 1000 })

      .then(() => myBot.message.add({ text: 'hello, what is your name?' }))

      .then(() => myBot.action.set(

          {

            options: [

              { label: 'John', value: 'john' },

              { label: 'Jane', value: 'jane' },

            ],

          },

          { actionType: 'select' }

      ))

      .then((data) => myBot.message.add({ text: `nice to meet you ${data.selected.label}` }))

  }, [])

  return 


    

      

      

    

  

}


const containerElement = document.getElementById('botui-app')

const root = createRoot(containerElement)

root.render()

```

### License

[MIT License](https://github.com/moinism/botui/blob/master/LICENSE) - Copyrights (c) 2017-23 - Moin Uddin