npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@openbot/react

v0.0.10

Published

React library to display openbots on your website

Downloads

335

Readme

Install

npm install @openbot/js2 @openbot/react

Standard

import { Standard } from '@openbot/react'

const App = () => {
  return (
    <Standard
      agent={{
        id: 'agent id',
        options: {
          avatar: {
            type: '3d',
            options: {
              modelSrc: 'https://your_model_url'
            }
          }
        }
      }}
      showAvatar
      style={{ width: '100%', height: '600px' }}
    />
  )
}

This code is creating a container with a 100% width (will match parent width) and 600px height.

Popup

import { Popup } from '@openbot/react'

const App = () => {
  return (
    <Popup 
      agent={{
        id: 'agent id',
        options: {
          avatar: {
            type: '3d',
            options: {
              modelSrc: 'https://your_model_url'
            }
          }
        }
      }}
      showAvatar
      autoShowDelay={3000}
    />
  )
}

This code will automatically trigger the popup window after 3 seconds.

Open or Close a popup

You can use these commands:

import {
    open
} from '@openbot/react'

open()
import {
    close
} from '@openbot/react'

close()
import {
    toggle
} from '@openbot/react'

toggle()

Bubble

import { Bubble } from '@openbot/react'

const App = () => {
  return (
    <Bubble
      agent={{
        id: 'agent id',
        options: {
          avatar: {
            type: '3d',
            options: {
              modelSrc: 'https://your_model_url'
            }
          }
        }
      }}
      showAvatar
      previewMessage={{
        message: 'I have a question for you!',
        autoShowDelay: 5000,
        avatarUrl: 'https://avatars.githubusercontent.com/u/16015833?v=4',
      }}
      theme={{
        button: { backgroundColor: '#0042DA', iconColor: '#FFFFFF' },
        previewMessage: { backgroundColor: '#ffffff', textColor: 'black' },
      }}
    />
  )
}

This code will show the bubble and let a preview message appear after 5 seconds.

Open or close the preview message

You can use these commands:

import {
    showPreviewMessage
} from '@openbot/react'

Openbot.showPreviewMessage()
import {
    hidePreviewMessage
} from '@openbot/react'

Openbot.hidePreviewMessage()

Open or close the chat window

You can use these commands:

import {
    open
} from '@openbot/react'

open()
import {
    close
} from '@openbot/react'

close()
import {
    toggle
} from '@openbot/react'

toggle()