@mainframe/bot-ui

Mainframe JavaScript UI framework for bots

This documentation only covers the JavaScript UI framework, see the Mainframe bots documentation for more information about creating Mainframe bots, and the bots SDK repository to get started implementing a bot in JavaScript.

Installation

npm install @mainframe/bot-ui # npm
yarn add @mainframe/bot-ui # Yarn

Example

const React = require('react')
const { render, Text } = require('@mainframe/bot-ui')

const ui = render(<Text>Hello bot!</Text>)

Usage

This UI framework is meant as a complement to the JavaScript bot SDK, exposing the components supported by the client UI and a render() function converting a JSX tree to an UIComponent tree expected by the Mainframe server.

The render() function expects a React.Element, the provided JSX must therefore be transpiled, for example using Babel's React JSX transform plugin.

API

React

Alias to React library. It needs to be imported in scope when using Babel's React JSX transform plugin so that JSX can be converted to React.createElement() calls.

render

Alias to React JSON renderer convertToObject function. Converts the JSX tree into a JS Object supported by the Mainframe platform.

Components

All the documented components are exposed by this UI framework so they can be used to create the JSX tree.

License

MIT
See LICENSE file