Tock React Kit

A toolkit to easily embed Tock chatbots into Web pages.

The toolkit provides:

simple integration, as a script or React module
connection/dialog with a Tock bot using Bot API (using SSE if available)
user interface for conversations, including default widgets and animations
customizable styles

The toolkit is currently used in production by various conversational assistants from SNCF, Enedis and more (see Tock showcase).

🏠 Home: https://doc.tock.ai

▶️ Live demo: Web frontend / bot backend

💬 Contact: https://gitter.im/tockchat/Lobby

Prerequisites

Run a Tock Bot in API mode (NodeJS alternative)

Quick Start

Include react, react-dom, @emotion-core, @emotion-styled, emotion-theming and tock-react-kit in an HTML page. React must be at least version 16.8 (must have hooks)

<script crossorigin src="https://unpkg.com/react@16/umd/react.development.js"></script>
<script crossorigin src="https://unpkg.com/react-dom@16/umd/react-dom.development.js"></script>
<script crossorigin src="https://unpkg.com/@emotion/core@10/dist/core.umd.min.js"></script>
<script crossorigin src="https://unpkg.com/@emotion/styled@10/dist/styled.umd.min.js"></script>
<script crossorigin src="https://unpkg.com/emotion-theming@10/dist/emotion-theming.umd.min.js"></script>
<script
  crossorigin
  src="https://unpkg.com/tock-react-kit@latest/build/tock-react-kit.umd.js"
></script>

Render your app in an element:

<body>
  <div id="chat"></div>
  <script>
    TockReact.renderChat(document.getElementById('chat'), '<TOCK_BOT_API_URL>');
  </script>
</body>

Use as a module

You can also use it as a module (i.e Create React App) and bundle it:

npm i tock-react-kit
npm i @emotion/core@10
npm i @emotion/styled@10
npm i emotion-theming@10

import { renderChat } from 'tock-react-kit';

renderChat(document.getElementById('chat'), '<TOCK_BOT_API_URL>');

Styling your chat

Use the third argument of renderChat to style your app:

renderChat(document.getElementById('chat'), '<TOCK_BOT_API_URL>', 'referralParameter', {
  palette: {
    text: {
      user: 'limegreen',
      bot: 'rebeccapurple',
      card: 'black',
      input: 'black',
    },
    background: {
      user: 'red',
      bot: 'orange',
      card: 'lightgreen',
      input: 'lightblue',
      inputDisabled: '#b6b4b4',
    },
  },
  sizing: {
    loaderSize: '8px',
    borderRadius: '8px',
    conversation: {
      width: '720px',
    },
  },
  typography: {
    fontFamily: 'monospace',
    fontSize: '24px',
  },
  overrides: {
    chat: `background: #fff;`,
  },
});

You can use createTheme function to init a valid theme.

renderChat(document.getElementById('chat'), '<TOCK_BOT_API_URL>', 'referralParameter', createTheme({}));

Customize interface

If the chat does not suit your needs you can also use the components separately.

API Reference

`renderChat(element, tockBotApiUrl, referralParameter, theme, options)`

Renders an entire chat in a target element.

Argument name	Type	Description
`element`	`Element`	Target element where the chat will be rendered
`tockBotApiUrl`	`string`	URL to the Tock Bot REST API
`referralParameter`	`string`	Optional referal parameter
`theme`	`TockTheme`	Optional theme object
`options`	`TockOptions`	Optional options object

`useTock(tockBotApiUrl)`

Hook that provides chat history and methods to communicate with the Tock Bot. It must be used alongside with TockContext. Returns a useTock interface.

Argument name	Type	Description
`tockBotApiUrl`	`string`	URL to the Tock Bot REST API

`TockTheme`

A TockTheme can be used as a value of a ThemeProvider of emotion-theming (bundled with the library) or as a third argument of renderChat.

Property name	Type	Description
`palette`	`Palette`	Object for customising colors (see below)
`sizing`	`Sizing`	Object for customising elements sizing (see below)
`typography`	`Typography`	Object for customising typographies (see below)
`overrides`	`Overrides?`	Object allowing further styling (see below)
`inlineQuickReplies`	`boolean?`	Displaying quick replies inline (by default false)

`Palette`

Property name	Type	Description
`background`	`BackgroundPalette`	Object for customising background colors (see below)
`text`	`TextPalette?`	Object for customising text colors (see below)

`BackgroundPalette`

Property name	Type	Description
`user`	`string?`	CSS color used mainly for the user's chat speech balloons
`bot`	`string?`	CSS color used mainly for the bot's chat speech balloons
`card`	`string?`	CSS background color for cards
`input`	`string?`	CSS background color for the main user text input
`inputDisabled`	`string?`	CSS background color for the main user text input disabled

`TextPalette`

Property name	Type	Description
`user`	`string?`	CSS color used mainly for the user's chat speech balloons
`bot`	`string?`	CSS color used mainly for the bot's chat speech balloons
`card`	`string?`	CSS background color for cards
`input`	`string?`	CSS background color for the main user text input

`Sizing`

Property name	Type	Description
`loaderSize`	`string?`	Loader component size
`borderRadius`	`string?`	Border radius used in various chat components
`conversation`	`Shape`	Object for customising chat size (see below)

`Shape`

Property name	Type	Description
`width`	`string?`	CSS max-width of the chat interface

`Typography`

Property name	Type	Description
`fontFamily`	`string?`	CSS font-family used in the chat
`fontSize`	`string?`	CSS base font-size used in the chat

`Overrides`

Property name	Type	Description
`card`	`TockThemeCardStyle`	Object for adding CSS styles on card component (see below)
`chatInput`	`TockThemeInputStyle?`	Object for adding CSS styles on chat input component (see below)
`carouselContainer`	`string?`	Additional CSS styles for carousel cards container (overrides base styles)
`carouselItem`	`string?`	Additional CSS styles for carousel cards container (overrides base styles)
`carouselArrow`	`string?`	Additional CSS styles for carousel scrolling arrows (overrides base styles)
`messageBot`	`string?`	Additional CSS styles for the bot's speech balloons (overrides base styles)
`messageUser`	`string?`	Additional CSS styles for the user's speech balloons (overrides base styles)
`quickReply`	`string?`	Additional CSS styles for the quick reply buttons (overrides base styles)
`chat`	`string?`	Additional CSS styles for the chat container (overrides base styles)
`quickReplyArrow`	`string?`	Additional CSS styles for quick replies scrolling arrows (overrides base styles)

`TockThemeCardStyle`

Property name	Type	Description
`cardContainer`	`string?`	Additional CSS styles for carousel cards container (overrides base styles)
`cardTitle`	`string?`	Additional CSS styles for carousel cards title (overrides base styles)
`cardSubTitle`	`string?`	Additional CSS styles for carousel cards subtitle (overrides base styles)
`cardImage`	`string?`	Additional CSS styles for carousel cards image (overrides base styles)
`cardButton`	`string?`	Additional CSS styles for carousel cards button (overrides base styles)
`buttonList`	`string?`	Additional CSS styles for carousel cards button list (overrides base styles)
`buttonContainer`	`string?`	Additional CSS styles for carousel button list container (overrides base styles)

`TockThemeInputStyle`

Property name	Type	Description
`container`	`string?`	Additional CSS styles for input container (overrides base styles)
`input`	`string?`	Additional CSS styles for input (overrides base styles)
`icon`	`string?`	Additional CSS styles for input icon (overrides base styles)

`TockOptions`

Property name	Type	Description
`openingMessage`	`string?`	Initial message to send to the bot to trigger a welcome sequence
`extraHeadersProvider`	`() => Promise<Record<string, string>`	Provider of extra HTTP headers for outgoing requests
`timeoutBetweenMessage`	`number?`	Timeout between message
`widgets`	`any?`	Custom display component
`disableSse`	`boolean?`	Disable SSE (not even trying)
`accessibility`	`TockAccessibility`	Object for overriding role and label accessibility attributes
~~`localStorage`~~	~~`boolean?`~~	Enable history local storage (@deprecated)
`localStorageHistory`	`TockLocalStorage?`	Object for history local storage

`TockAccessibility`

Property name	Type	Description
`input`	`InputAccessibility?`	Object for adding accessibility labels on input component (see below)
`carousel`	`CarouselAccessibility?`	Object for adding accessibility labels on carousel component (see below)
`qrCarousel`	`QRCarouselAccessibility?`	Object for adding accessibility labels on QR inline carousel component component (see below)

`InputAccessibility`

Property name	Type	Description
`sendButtonLabel`	`string?`	Message of the send message button image aria-label attribute (overrides 'Send a message')
`clearButtonLabel`	`string?`	Message of the clear messages button image aria-label attribute (overrides 'Clear messages')

`TockLocalStorage`

Property name	Type	Description
`enable`	`boolean?`	Enable history local storage
`maxNumberMessages`	`number?`	Max number of messages in the history local storage (default 10)

`CarouselAccessibility`

Property name	Type	Description
`roleDescription`	`string?`	Message of the carousel aria-roledescription attribute (overrides 'Carousel')
`slideRoleDescription`	`string?`	Message of the slide carousel aria-roledescription attribute (overrides 'Slide')
`previousButtonLabel`	`string?`	Message of the carousel previous button image aria-label attribute (overrides 'Previous slides')
`nextButtonLabel`	`string?`	Message of the carousel next button image aria-label attribute (overrides 'Next slides')

`QRCarouselAccessibility`

Property name	Type	Description
`previousButtonLabel`	`string?`	Message of the quick replies carousel previous button image aria-label attribute (overrides 'Previous quick replies')
`nextButtonLabel`	`string?`	Message of the quick replies carousel next button image aria-label attribute (overrides 'Next quick replies')

Accessibility

The optional accessibility makes it possible to override default messages for some aria attributes.

Example :

renderChat(
    document.getElementById('chat'),
    '<TOCK_BOT_API_URL>',
    undefined,
    {},
    { accessibility: {
        carousel: {
          roleDescription: 'Carousel',
          slideRoleDescription: 'Result',
        },
      },
    },
);

Local storage history

The optional localStorageHistory makes it possible to provide a history session of messages. This history loads at the creation of the chat and is stored in the locale storage of the browser.

The localStorageHistory parameter is an object, by default not set (enable then to false).

Example:

renderChat(
    document.getElementById('chat'),
    '<TOCK_BOT_API_URL>',
    undefined,
    {},
    { localStorageHistory: {
        enable: true,
        maxNumberMessages: 15, // by default 10 messages max
      }
    },
);

If sensitive information appear in conversation, do not use this option.

If browser disable or cannot handle locale storage, the chat will not store messages.

Opening message

The optional openingMessage is a sentence, automatically sent to the bot when the conversation starts. This is typically used to provide a welcoming or onboarding message to the user:

configured in Tock Studio or managed like any other Tock story,
not requiring the user to make a sentence first.

The openingMessage parameter is a sentence from the user to the bot, actually not displayed in conversation. It is not the configured answer from the bot.

Example:

renderChat(
    document.getElementById('chat'), 
    '<TOCK_BOT_API_URL>', 
    undefined,
    {},
    { openingMessage: 'hello my bot' },
);

In this example, when the user opens/loads the page embedding the tock-react-kit, a message from the bot is automatically retrieved and displayed, starting the conversation: actually, the bot message configured for any user sending the sentence "hello my bot".

Extra headers

The optional extraHeadersProvider makes it possible to provide additional HTTP headers, to message requests from the Web page (tock-react-kit component) to the Bot (Tock Bot API).

Example:

renderChat(
    document.getElementById('chat'), 
    '<TOCK_BOT_API_URL>', 
    undefined,
    {},
    { extraHeadersProvider: (async () => ({'my-custom-header': 'some value'})) },
);

This is typically used to pass tokens or custom values to the Bot backend.

Note that extra headers should be allowed by the backend's CORS setup for the application to work as intended.

Custom widgets

Tock web connector can send custom messages :

{
  data: {
    departure: 'Paris',
    arrival: 'Nice'
  },
  type: 'TrainCardWidget',
}

You can define your own display components for this custom message :

import React from 'react';
import { renderChat, MessageContainer, Message } from 'tock-react-kit';

const TrainCardWidget = ({departure, arrival}) => {
    return (
        <MessageContainer>
            <Message>
                <p>Departure: {departure}</p>
                <p>Arrival: {arrival}</p>
            </Message>
        </MessageContainer>
    );
};

renderChat(
    document.getElementById('chat'),
    '<TOCK_BOT_API_URL>',
    undefined,
    {}, 
    {
        widgets: {
            TrainCardWidget
        }
    }
);

SSE

By default, the tock-react-kit tries to connect to the Bot through Server-sent events. If an error occurs, it probably means the Bot does not accept SSE, and the tock-react-kit switches to classic requests.

The optional disableSseparameter makes it possible to disable SSE before even trying, possibly preventing a 404 error from console (when the Bot does not accept SSE).

Example:

renderChat(
    document.getElementById('chat'), 
    '<TOCK_BOT_API_URL>', 
    undefined,
    {},
    { disableSse: true },
);

Name		Name	Last commit message	Last commit date
Latest commit History 149 Commits
.github/workflows		.github/workflows
.storybook		.storybook
src		src
.auto-changelog		.auto-changelog
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
.prettierrc.js		.prettierrc.js
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
changelog-template.hbs		changelog-template.hbs
package.json		package.json
rollup.config.js		rollup.config.js
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Tock React Kit

Prerequisites

Quick Start

Use as a module

Styling your chat

Customize interface

API Reference

`renderChat(element, tockBotApiUrl, referralParameter, theme, options)`

`useTock(tockBotApiUrl)`

`TockTheme`

`Palette`

`BackgroundPalette`

`TextPalette`

`Sizing`

`Shape`

`Typography`

`Overrides`

`TockThemeCardStyle`

`TockThemeInputStyle`

`TockOptions`

`TockAccessibility`

`InputAccessibility`

`TockLocalStorage`

`CarouselAccessibility`

`QRCarouselAccessibility`

Accessibility

Local storage history

Opening message

Extra headers

Custom widgets

SSE

About

Releases

Packages

Languages

License

cedricjimenezst/tock-react-kit

Folders and files

Latest commit

History

Repository files navigation

Tock React Kit

Prerequisites

Quick Start

Use as a module

Styling your chat

Customize interface

API Reference

renderChat(element, tockBotApiUrl, referralParameter, theme, options)

useTock(tockBotApiUrl)

TockTheme

Palette

BackgroundPalette

TextPalette

Sizing

Shape

Typography

Overrides

TockThemeCardStyle

TockThemeInputStyle

TockOptions

TockAccessibility

InputAccessibility

TockLocalStorage

CarouselAccessibility

QRCarouselAccessibility

Accessibility

Local storage history

Opening message

Extra headers

Custom widgets

SSE

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

`renderChat(element, tockBotApiUrl, referralParameter, theme, options)`

`useTock(tockBotApiUrl)`

`TockTheme`

`Palette`

`BackgroundPalette`

`TextPalette`

`Sizing`

`Shape`

`Typography`

`Overrides`

`TockThemeCardStyle`

`TockThemeInputStyle`

`TockOptions`

`TockAccessibility`

`InputAccessibility`

`TockLocalStorage`

`CarouselAccessibility`

`QRCarouselAccessibility`

Packages