Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/watson-developer-cloud/assistant-web-chat-react

A React library to make integration of Watson Assistant web chat with a React application easy.
https://github.com/watson-developer-cloud/assistant-web-chat-react

Last synced: 3 days ago
JSON representation

A React library to make integration of Watson Assistant web chat with a React application easy.

Awesome Lists containing this project

README 

        
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![Build and Test](https://github.com/watson-developer-cloud/assistant-web-chat-react/actions/workflows/build-test.yml/badge.svg)](https://github.com/watson-developer-cloud/assistant-web-chat-react/actions/workflows/build-test.yml)



# IBM watsonx Assistant web chat with React



`@ibm-watson/assistant-web-chat-react` is a React library to extend the [web chat](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-deploy-web-chat) feature of [IBM watsonx Assistant](https://www.ibm.com/cloud/watson-assistant) within your React application. This makes it easier to provide user-defined response types written in React, add content to custom elements with React, have the web chat and your site communicate more easily, and more.



The primary utility provided by this library is the `WebChatContainer` functional component. This component will load and render an instance of web chat when it is mounted and destroy that instance when unmounted.



  Table of contents



- [Installation](#installation)

- [Using WebChatContainer](#using-webchatcontainer)

- [WebChatCustomElement](#webchatcustomelement)

- [API](#api)

- [Additional resources](#additional-resources)

- [License](#license)



## Installation



To install using `npm`:



```bash

npm install @ibm-watson/assistant-web-chat-react

```



Or using `yarn`:



```bash

yarn add @ibm-watson/assistant-web-chat-react

```



## Using WebChatContainer



### Basic example



The `WebChatContainer` function component is intended to make it as easy as possible to include web chat in your React application. To use, you simply need to render this component anywhere in your application and provide the [web chat configuration options object](https://web-chat.global.assistant.watson.cloud.ibm.com/docs.html?to=api-configuration#configurationobject) as a prop.



```javascript

import React from 'react';

import { WebChatContainer, setEnableDebug } from '@ibm-watson/assistant-web-chat-react';



const webChatOptions = {

  integrationID: 'XXXX',

  region: 'XXXX',

  serviceInstanceID: 'XXXX',

  // subscriptionID: 'only on enterprise plans',

  // Note that there is no onLoad property here. The WebChatContainer component will override it.

  // Use the onBeforeRender or onAfterRender prop instead.

};



// Include this if you want to get debugging information from this library. Note this is different than

// the web chat "debug: true" configuration option which enables debugging within web chat.

setEnableDebug(true);



function App() {

  return ;

}

```



### Accessing instance methods



You can use the `onBeforeRender` or `onAfterRender` props to get access to the instance of web chat if you need call instance methods later. This example renders a button that toggles web chat open and is only rendered after the instance has become available.



```javascript

import React, { useCallback, useState } from 'react';

import { WebChatContainer } from '@ibm-watson/assistant-web-chat-react';



const webChatOptions = { /* Web chat options */ };



function App() {

  const [instance, setInstance] = useState(null);



  const toggleWebChat = useCallback(() => {

    instance.toggleOpen();

  }, [instance]);



  return (

    <>

      {instance && (

        

          Toggle web chat

        

      )}

       onBeforeRender(instance, setInstance)} />

    >

  );

}



function onBeforeRender(instance, setInstance) {

  // Make the instance available to the React components.

  setInstance(instance);



  // Do any other work you might want to do before rendering. If you don't need any other work here, you can just use

  // onBeforeRender={setInstance} in the component above.

}

```



### User defined responses



This component is also capable of managing user defined responses. To do so, you need to pass a `renderUserDefinedResponse` function as a render prop. This function should return a React component that will render the content for the specific message for that response. You should make sure that the `WebChatContainer` component does not get unmounted in the middle of the life of your application because it will lose all user defined responses that were previously received by web chat.



You should treat the `renderUserDefinedResponse` prop like any typical React render prop; it is different from the `userDefinedResponse` event or a typical event handler. The event is fired only once when web chat initially receives the response from the server. The `renderUserDefinedResponse` prop however is called every time the App re-renders and it should return an up-to-date React component for the provided message item just like the render function would for a typical React component.



Note: in web chat 8.2.0, the custom response event was renamed from `customResponse` to `userDefinedResponse`. If this library detects you are using a prior version of web chat, it will use the `customResponse` event instead of `userDefinedResponse`. 



```javascript

import React from 'react';

import { WebChatContainer } from '@ibm-watson/assistant-web-chat-react';



const webChatOptions = { /* Web chat options */ };



function App() {

  return ;

}



function renderUserDefinedResponse(event) {

  // The event here will contain details for each user defined response that needs to be rendered.

  // The "user_defined_type" property is just an example; it is not required. You can use any other property or

  // condition you want here. This makes it easier to handle different response types if you have more than

  // one user defined response type.

  if (event.data.message.user_defined && event.data.message.user_defined.user_defined_type === 'my-custom-type') {

    return 
My custom content


  }

}

```



## WebChatCustomElement



This library provides the component `WebChatCustomElement` which can be used to aid in rendering web chat inside a custom element. This is needed if you want to be able to change the location where web chat is rendered. This component will render an element in your React app and use that element as the custom element for rendering web chat.



The default behavior of this component will add and remove a classname from the web chat main window as well as your custom element to control the visibility of web chat when it is opened or closed. It will also inject a `style` tag into your application to define the rules for these classnames. When web chat is closed, a classname will be added to the web chat main window to hide the element and a classname will be added to your custom element to set its width and height to 0 so it doesn't take up space. Note that the custom element should remain visible if you want to use the built-in web chat launcher which is also contained in your custom element. If you don't want these behaviors, then provide your own `onViewChange` prop to `WebChatCustomElement` and provide your own logic for controlling the visibility of web chat. If you want custom animations when web chat is opened and closed, this would be the mechanism to do that.



The simplest example is this:



```javascript

import React from 'react';

import { WebChatCustomElement } from '@ibm-watson/assistant-web-chat-react';



import './App.css';



const webChatOptions = { /* Web chat options */ };



function App() {

  return ;

}

```



```css

.MyCustomElement {

  position: absolute;

  left: 100px;

  top: 100px;

  width: 500px;

  height: 500px;

}

```



## API



### WebChatContainer API



The `WebChatContainer` function is a functional component that will load and render an instance of web chat when it is mounted and destroy that instance when unmounted. If the web chat configuration options change, it will also destroy the previous web chat and create a new one with the new configuration. It can also manage React portals for user defined responses.



Note that this component will call the [web chat render](https://web-chat.global.assistant.watson.cloud.ibm.com/docs.html?to=api-instance-methods#render) method for you. You do not need to call it yourself. You can use the `onBeforeRender` or `onAfterRender` prop to execute operations before or after render is called.



#### Props



`WebChatContainer` has the following props.



| Attribute | Required | Type    | Description |

|-----------|----------|---------|-------------|

| config    | Yes      | object  | The [web chat configuration options object](https://web-chat.global.assistant.watson.cloud.ibm.com/docs.html?to=api-configuration#configurationobject). Note that any `onLoad` property will be ignored. If this prop is changed and a new object provided, then the current web chat will  be destroyed and a new one created with the new object. |

| instanceRef    | No      | MutableRefObject  | A convenience prop that is a reference to the web chat instance. This component will set the value of this ref using the `current` property when the instance has been created. |

| onBeforeRender    | No      | function  | This is a callback function that is called after web chat has been loaded and before the `render` function is called. This function is passed a single argument which is the instance of web chat that was loaded. This function can be used to obtain a reference to the web chat instance if you want to make use of the instance methods that are available. |

| onAfterRender    | No      | function  | This is a callback function that is called after web chat has been loaded and after the `render` function is called. This function is passed a single argument which is the instance of web chat that was loaded. This function can be used to obtain a reference to the web chat instance if you want to make use of the instance methods that are available. |

| renderUserDefinedResponse    | No      | function  | This function is a callback function that will be called by this container to render user defined responses. If this prop is provided, then the container will listen for user defined response events from web chat and will generate a React portal for each event. This function will be called once during component render for each user defined response event. This function takes two arguments. The first is the [user defined response event](https://web-chat.global.assistant.watson.cloud.ibm.com/docs.html?to=api-events#userDefinedResponse) that triggered the user defined response. The second is a convenience argument that is the instance of web chat. The function should return a `ReactNode` that renders the user defined content for the response. |



`WebChatCustomElement` inherits all of the props from `WebChatContainer`. It also has the following additional optional props.



| Attribute | Type    | Description |

|-----------|---------|-------------|

| className    | string  | An optional classname that will be added to the custom element. |

| id    | string  | An optional id that will be added to the custom element. |

| onViewChange    | function  | An optional listener for "view:change" events. Such a listener is required when using a custom element in order to control the visibility of the web chat main window. If no callback is provided here, a default one will be used that uses some classnames to control web chat and your custom element. You can provide a different callback here if you want custom behavior such as an animation when the main window is opened or closed. Note that this function can only be provided before web chat is loaded. After web chat is loaded, the event handler will not be updated. See the web chat [view:change documentation](https://web-chat.global.assistant.watson.cloud.ibm.com/docs.html?to=api-events#view:change) for more information. Also see the [tutorial for using animiations with custom elements](https://github.com/watson-developer-cloud/assistant-toolkit/tree/master/integrations/webchat/examples/custom-element/client/javascript-animation) for an example of what can be done here. |



### Debugging



In addition to the props above, the `WebChatContainer` component can output additional debug information. To enable this output, call the `setEnableDebug` function which is exported from this library.



```javascript

setEnableDebug(true);



function App() {

  return ;

}

```



## Additional resources

- [IBM watsonx Assistant](https://www.ibm.com/cloud/watson-assistant)

- [IBM watsonx Assistant web chat feature documentation](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-deploy-web-chat)

- [IBM watsonx Assistant web chat API documentation](https://web-chat.global.assistant.watson.cloud.ibm.com/docs.html?to=api-overview)



## License



This package is available under the [MIT License](./LICENSE).