{"id":28630899,"url":"https://github.com/appflowy-io/appflowy-chat","last_synced_at":"2025-06-26T00:05:17.406Z","repository":{"id":266437869,"uuid":"898346898","full_name":"AppFlowy-IO/AppFlowy-Chat","owner":"AppFlowy-IO","description":null,"archived":false,"fork":false,"pushed_at":"2025-06-20T07:17:09.000Z","size":734,"stargazers_count":2,"open_issues_count":1,"forks_count":5,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-20T08:27:57.918Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AppFlowy-IO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-04T08:28:27.000Z","updated_at":"2025-04-28T05:40:53.000Z","dependencies_parsed_at":null,"dependency_job_id":"530f9832-5ae9-47eb-a9d3-d7e94abf3cde","html_url":"https://github.com/AppFlowy-IO/AppFlowy-Chat","commit_stats":null,"previous_names":["appflowy-io/appflowy-chat"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AppFlowy-IO/AppFlowy-Chat","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2FAppFlowy-Chat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2FAppFlowy-Chat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2FAppFlowy-Chat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2FAppFlowy-Chat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AppFlowy-IO","download_url":"https://codeload.github.com/AppFlowy-IO/AppFlowy-Chat/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2FAppFlowy-Chat/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260914436,"owners_count":23082000,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-12T13:09:02.161Z","updated_at":"2025-06-26T00:05:17.370Z","avatar_url":"https://github.com/AppFlowy-IO.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AppFlowy Web Chat\n\n## 📦 Installation\n\n```bash\nnpm i @appflowyinc/ai-chat\n# or\nyarn add @appflowyinc/ai-chat\n# or\npnpm add @appflowyinc/ai-chat\n```\n\n## 🚀 Quick Start\n\n\u003e NB: Many functionalities of AppFlowy Web Chat are meant to work very closely with an instance of [AppFlowy Cloud](https://github.com/AppFlowy-IO/AppFlowy-Cloud). Some features will require token access as well.\n\nTo get started with AppFlowy Web Chat, import `Chat` from the package and supply it with necessary `ChatProps`.\n\n```tsx\nimport { Chat, ChatProps } from \"@appflowyinc/ai-chat\";\n\nconst App = () =\u003e {\n  const props: ChatProps = {\n    // fill with data\n    ...\n  };\n\n  return \u003cChat {...props} /\u003e;\n};\n\nexport default App;\n```\n\n## 💡 Theming\n\nAppFlowy Web Chat will use dark mode when `document.documentelement.dataset.darkMode` is set to true.\n\n## 📖 API\n\n### `ChatProps`\n\n| Prop                 | Type                                  | Default | Description                                                     |\n| -------------------- | ------------------------------------- | ------- | --------------------------------------------------------------- |\n| chatId               | `string`                              | -       | The id of the chat                                              |\n| requestInstance      | `ChatRequest`                         | -       | ChatRequest which handles chat-related API requests             |\n| currentUser          | `User` (optional)                     | -       | Current user in the chat, determines the sender                 |\n| openingViewId        | `string` (optional)                   | -       | id of the currently-opened view                                 |\n| onOpenView           | `(viewId: string) =\u003e void` (optional) | -       | Callback when clicking on a view link in the chat               |\n| onCloseView          | `() =\u003e void` (optional)               | -       | Callback when closing an opened view                            |\n| selectionMode        | `boolean` (optional)                  | -       | When true, disable input and allows selecting multiple messages |\n| onOpenSelectionMode  | `() =\u003e void` (optional)               | -       | Callback when turning on selection mode                         |\n| onCloseSelectionMode | `() =\u003e void` (optional)               | -       | Callback when turning off selection mode                        |\n\n### `ChatRequest`\n\nSupply the `workspaceId` and `chatId`. For saving messages to AppFlowy Cloud, an access token will be required in local storage.\n\n## 🔨 Development Guide\n\n### Development Mode\n\n```bash\n# Install dependencies\npnpm i\n\n# Start development server\npnpm run dev\n\n# Build library\npnpm run build\n```\n\nTo run the demo locally, first run:\n\n```bash\npnpm i\npnpm run dev\n```\n\nThen open http://localhost:3001/ in your browser to see the demo application.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappflowy-io%2Fappflowy-chat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappflowy-io%2Fappflowy-chat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappflowy-io%2Fappflowy-chat/lists"}