Archbee React Component Widget

Table of Contents

• Installation
• API documentation
• Examples

Installation

To install, use pnpm:

$ pnpm add @archbee/app-widget

If you need to install Archbee Contextual Widget SDK, you can find more details here.

API documentation

The primary documentation for Archbee React component Widget can be found in docs, which describes the API and gives examples of its usage.

Examples

Here is a simple example of Archbee React widget being used in an app with some action variations:

import React from 'react'
import { ArchbeeAppWidget } from '@archbee/app-widget'

function App() {
  return (
    <div>
      <ArchbeeAppWidget
        spaceId={/** published space id **/}
        onWidgetOpen={() => {
          /** ... **/
        }} // callback function called after widget has open
        // onWidgetClose={() => { /** ... **/ }} // callback function called after widget has open
      >
        <button type="button">Open</button>
      </ArchbeeAppWidget>
    </div>
  )
}

ReactDOM.render(<App />, appElement)

Can also be used with ref for a more programmatic approach:

import React from 'react';
import { ArchbeeAppWidget, AbWidgetRef } from '@archbee/app-widget'

function App() {
const widgetRef = useRef<AbWidgetRef>(null);

  return (
    <div>
        <ArchbeeAppWidget
            ref={widgetRef}
            spaceId={ /** published space id **/ }
            onWidgetOpen={() => { /** ... **/ }} // callback function called after widget has open
            onWidgetClose={() => { /** ... **/ }} // callback function called after widget has open
      >
        <button type='button' onClick={() => {
        <!-- Opens widget -->
            widgetRef.current?.open();
        }}>
          Open
        </button>

        <button type='button' onClick={() => {
        <!-- Closes widget -->
            widgetRef.current?.close();
        }}>
          Close
        </button>

        <button type='button' onClick={() => {
        <!-- Gets the instance of the widget if needed for various event manipulations. -->
            widgetRef.current?.instance();
        }}>
          Get widget instance
        </button>
      </ArchbeeAppWidget>
    </div>
  );
}

ReactDOM.render(<App />, appElement);

Component Props

Bubble

Use bubble prop whenever you want an easy search button to browse your entire documentation.

Ref Methods

If ref is not passed to ArchbeeAppWidget, the children will automatically open the modal popup upon click.

Demos

Down below is a demo setup in CodeSandbox, which demonstrate various features of archbee-app:

• Demo