@fmrib/widgets
v0.1.0
Published
A library of React material widgets common across FSL GUIs
Downloads
1
Readme
widgets
This is the widgets
FSL React component library. Most widgets build on the React MUI library. These components are intended to be used in the FSL React web-based GUIs.
Development
Prerequisites
It is assumed that your development machine is either a Mac or Linux machine.
Setup
Clone and cd into this repo
git clone https://git.fmrib.ox.ac.uk/fsl/gui/widgets.git
cd widgets
Install dependencies via npm
npm install
Building
To build the library, run the following command:
npm run build
Important: when building, some packages are externalised. This means that they are not bundled with the library. Instead, they are expected to be provided by the consuming application (but they are also listed as dependencies of this library, so should get installed via npm install
). The following packages are externalised: react, @mui/material, @mui/icons-material, @emotion/react
Publishing
Publishing is a manual process until the proper CI/CD pipeline is in place. To publish, run the following command:
npm run pub