GroundFloor React UI

The official component library for GroundFloor application

Installation

The package can be installed via npm:

npm install groundfloor-react-ui --save

CSS files

1. To use DateSelect component add the below css file to your root
import 'react-datepicker/dist/react-datepicker.css';
2. To use Overlay component, Tooltip and ButtonPopup add the below css file to your root
import 'react-popper-tooltip/dist/styles.css';
3. To defaultThemeColor, defaultStyles,colors, getDefaultStyles function, hexToRGB function, use import {defaultThemeColor, defaultStyles, colors, getDefaultStyles, hexToRGB} from 'groundfloor-react-ui'
4. Add import 'react-phone-input-2/lib/style.css' if CountryCodedPhoneInput is needed

Documentation And Example

https://groundfloor-react-ui--63f723af2a11e9df1310e721.chromatic.com/

Pre-requisites

The following peer dependencies are required to run in a React Project

• React v16.3 or greater
• styled-components v5 or greater

How to Publish

1. Go to /src/package/package.json and update the version.

2. Open terminal and move to the /src/package directory.

3. Run the following commands one by one:

   npm ci
   npm run build-lib
   npm publish