# @kbee-app/embedded

> Embed a Kbee knowledge base into your website

Latest version **1.0.3** (published 2021-08-16) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @kbee-app/embedded
pnpm add @kbee-app/embedded
yarn add @kbee-app/embedded
bun add @kbee-app/embedded
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-08-16 |
| First published | 2021-08-12 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 62.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Sandeep Dinesh |
| Maintainers | sandeep-simplemnt |
| Keywords | Kbee, Knowledge, Base, Help, Center, Google, Docs |

## Links

- npm: https://www.npmjs.com/package/@kbee-app/embedded
- Repository: https://github.com/kbee-app/embedded
- Homepage: https://github.com/kbee-app/embedded#readme
- Issues: https://github.com/kbee-app/embedded/issues
- npm.io page: https://npm.io/package/@kbee-app/embedded

## Dependencies (1)

- [@ungap/url-search-params](https://npm.io/package/@ungap/url-search-params.md) ^0.2.2

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads
- [datasets-fi-postalcodes](https://npm.io/package/datasets-fi-postalcodes.md) — 1.1K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2021-08-16
- 1.0.2 — 2021-08-12
- 1.0.1 — 2021-08-12
- 1.0.0 — 2021-08-12

## README

# Kbee Embedded
Embed a Kbee knowledge base into your website

## Usage

### Via NPM

Install the package

```
npm i @kbee-app/embedded --save
```

Then use the package

```javascript
const renderKbee = require('@kbee-app/embedded')
renderKbee({
  target: '#kbee-content',
  spaceUrl: 'http://yourspace.kbee.app',
  apiKey: '<YOUR-API-KEY>'
})
```

### Via JSDeliver

If you can't use npm, you can use a pre-built bundle from JSDeliver

First, include the Kbee script tag in your page's `<head>`:

```
<script src="https://cdn.jsdelivr.net/gh/kbee-app/embedded@latest/dist/kbee-embedded.js"></script>
```

Then, call the Kbee function to render the help center into the target of your choosing:

```javascript
Kbee.render({
  target: '#kbee-content',
  spaceUrl: 'http://yourspace.kbee.app',
  apiKey: '<YOUR-API-KEY>'
})
```

## Options

```javascript
Kbee.render({
  // Where to render the content. Either pass a query string or a DOM Element
  // Kbee will overwrite the content in the container
  target: '#kbee-content',
  // URL of your Kbee Space
  spaceUrl: 'https://yourspace.kbee.app',
  // A JWT token generated from your server using the Kbee private key.
  // This is the reccomended method as it is fully secure, however it requires you to run the JWT creation code on your server
  // Note: Do not hardcode a JWT token, instead use the apiKey method.
  token: '<JWT-TOKEN>',
  // If you do not want to or cannot generate a JWT token, you can whitelist your domain and use the API key to generate a JWT from the Kbee servers
  // This method is much simpler and does not require you to run any server code, but a dedicated attacker can steal your API key and manually spoof requests to generate a JWT.
  apiKey: '<YOUR-API-KEY>',
  // For React and other view libraries, the DOMContentLoaded event fires too early to be used, so it should be bypassed
  bypassDocumentLoadEvent: true
})
```

## React Example

```javascript
import { useEffect } from 'react'

const renderKbee = require('@kbee-app/embedded')

export default function Test() {
  useEffect(() => {
    renderKbee({
      target: '#kbee-content',
      spaceUrl: 'http://yourspace.kbee.app',
      apiKey: '<YOUR-API-KEY>',
      bypassDocumentLoadEvent: true
    })
  }, [])
  return <div id='kbee-content' style={{ width: '100vw', height: '100vh' }} />
}
```

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