UI Toolkit

Summary

Description

The UI Toolkit is a library of react components that helps you build complex frontend extension applications quickly. The library contains layout guides, forms, input fields, complex financial charts, and is already compatible with Symphony's UI theme.

Prerequisites

  • Node

  • Yarn

  • Git

Installation

  1. To gain access to the UI Toolkit, navigate to the dedicated Github repository: https://github.com/SymphonyPlatformSolutions/symphony-bdk-ui-toolkit

  2. Clone the repository locally:

$ git clone https://github.com/SymphonyPlatformSolutions/symphony-bdk-ui-toolkit.git
  1. To access a live version of this library, run the following from inside your project:

$ yarn storybook

This will launch a live version of the UI Toolkit library reference in your default browser. In the left hand side of the storybook view, navigate to the 'Components' section for a detailed reference of the components themselves.

Usage

To use the library in your extension application:

$ npm install symphony-bdk-ui-toolkit

Note: This is automatically installed when generating applications using the BDK CLI tool.

Import the components you want to use:

$ import { Box , Text, Button } from 'symphony-bdk-ui-toolkit';

Peer Dependencies

There's a few components that require a peer dependency installation, that means that although these components uses such dependency, it expects that it will be installed on your project, rather than packaged and shipped with this toolkit. Here's the complete list of peer dependencies:

{
"peerDependencies": {
"axios": "^0.19.0",
"d3-scale": "^3.2.1",
"d3-shape": "^1.3.7",
"d3-time": "^1.1.0",
"d3-time-format": "^2.2.2",
"prop-types": "^15.7.2",
"react": "^16.12.0",
"react-dom": "^16.12.0",
"react-stockcharts": "^0.7.8",
"styled-components": "^4.4.1"
}
}

Next Steps

For an step by step tutorial on how to leverage the UI Toolkit to create complex frontend applications, continue here: