# react-olark

> React component to render an Olark chatbox

Latest version **1.0.0-alpha.9** (published 2021-03-22) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-alpha.9 |
| Published | 2021-03-22 |
| First published | 2020-11-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 47.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ivansky |
| Maintainers | ivansky |
| Keywords | react, olark, component, typescript |

## Links

- npm: https://www.npmjs.com/package/react-olark
- Repository: https://github.com/ivansky/react-olark
- Issues: https://github.com/ivansky/react-olark/issues
- npm.io page: https://npm.io/package/react-olark

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.0-alpha.9 (latest) — 2021-03-22
- 1.0.0-alpha.8 — 2021-01-26
- 1.0.0-alpha.7 — 2021-01-26
- 1.0.0-alpha.6 — 2021-01-26
- 1.0.0-alpha.5 — 2021-01-26
- 1.0.0-alpha.4 — 2021-01-26
- 1.0.0-alpha.3 — 2021-01-26
- 1.0.0-alpha.2 — 2021-01-26
- 1.0.0-alpha.1 — 2020-11-23
- 1.0.0-alpha — 2020-11-23

## README

# react-olark

React component to render an Olark chatbox on your page. \
This is based on the work completed by [jgnewman](https://github.com/jgnewman/react-olark).

## How it works

1. Sign up for Olark at [olark.com](https://olark.com). After signing up, you'll have access to your unique site ID.
2. Import `Olark` from react-olark and pass it your site id.
3. That's it!

```jsx
import Olark from "react-olark";

import React from "react";
import ReactDOM from "react-dom";

ReactDOM.render(
  <Olark siteId={YOUR_SITE_ID} />,
  document.getElementById("root")
);
```

**Note that you _should not_ use the Olark JavaScript snippet on your page \
if you are using react-olark because it will be automatically generated for you.**

## Options

Olark allows you to to [configure your chatbox](https://www.olark.com/api) in lots of cool ways.\ 
These mainly come in the form of "system" configurations and "locale" configurations. \
System values change how the chatbox does things \
and locale values allow you to customize text strings for use with different languages.

You can pass these configuration options to the `Olark` component as props:

```jsx
<Olark
  siteId={YOUR_SITE_ID}
  systemConfig={{ hb_dark_theme: true, ... }}
  localeConfig={{ chatting_title: 'Chat ki a tatou!', ... }}
/>
```

## Styling

React-olark will generate a div with the id `olark-box-container`. Once the chatbox has successfully loaded, that div will be given an extra class called `olark-loaded`. You can use these labels to do simple things like specify position and size. However, further customizations should mostly be handled through the Olark dashboard.

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