# omnimind-react

> Easily integrate Omnimind widgets into your React app with "omnimind-react-widgets."

Latest version **0.1.3** (published 2023-08-28) · ISC license · 0 weekly downloads

## Install

```sh
npm install omnimind-react
pnpm add omnimind-react
yarn add omnimind-react
bun add omnimind-react
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2023-08-28 |
| First published | 2023-08-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 9.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | OmnimindAI |
| Maintainers | givensss |

## Links

- npm: https://www.npmjs.com/package/omnimind-react
- npm.io page: https://npm.io/package/omnimind-react

## Recent versions

- 0.1.3 (latest) — 2023-08-28
- 0.1.2 — 2023-08-28
- 0.1.1 — 2023-08-17
- 0.1.0 — 2023-08-17
- 0.0.9 — 2023-08-17
- 0.0.8 — 2023-08-17
- 0.0.7 — 2023-08-16
- 0.0.6 — 2023-08-16
- 0.0.5 — 2023-08-16
- 0.0.4 — 2023-08-15
- 0.0.3 — 2023-08-15

## README

# Omnimind-React

[![npm version](https://badge.fury.io/js/omnimind-react.svg)](https://badge.fury.io/js/omnimind-react)

Easily integrate Omnimind widgets into your React app with the `omnimind-react` package.

## Installation

You can install the `omnimind-react` package using npm:

```bash
npm install omnimind-react
```

## Usage
1. First, make sure you have an account with [Omnimind](https://omnimind.ai/)  and have obtained the necessary credentials.

2. Import the necessary components from the omnimind-react package into your React application:

```js
import { OmnimindWidget } from 'omnimind-react';
```

3. Use the OmnimindWidget component in your JSX to display the desired Omnimind widget. Pass the required props, such as `widgetId` and `projectId`

```jsx
import { OmnindWidget } from "omnimind-react";

function App() {
  return (
    <div className="App">
        <OmnimindWidget
            widgetType="chat"
            widgetId="your-widget-id" 
            projectId="your-project-id"
        />
    </div>
  );
}

export default App;
```

## Props


| Prop       | Type        | Description                                |
|------------|-------------|--------------------------------------------|
| widgetType | WidgetTypes | The type of the Omnimind widget.           |
| widgetId   | string      | The ID of the Omnimind widget to display.  |
| projectId  | string      | The ID of the Omnimind project associated. |


### Widget types
The `widgetType` prop accepts the following values:

- `'chat'`: Display a chat widget.
- `'search'`: Display a search widget.
- `'popup-chat'`: Display a popup chat widget.
- `'doc-search'`: Display a document search widget.
- `'explain'`: Display an explanation widget.
- `'summarize'`: Display a summarization widget.

---
_Source: https://npm.io/package/omnimind-react · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._