@ddsys/react
v1.0.2
Published
<p> <a href="https://bhp-dev.gitlab.io/bhp-digital-design-system/">Read the docs</a> · <a href="mailto:[email protected]">Request feature</a> </p>
Downloads
4
Readme
DDS Bootstrap React
Digital Design System framework for customised Bootstrap deployment with extra custom components. A companion to DDS Boostrap Theme
for developers using React. Also available as Angular and Material UI in React
Getting started: With NPM
Ensure you've got DDS Boostrap Theme installed first.
npm install @ddsys/ui
Then install the framework companion.
npm install @ddsys/react
Getting started: With Yarn
Ensure you've got DDS Boostrap Theme installed first.
yarn add @ddsys/ui
Then install the framework companion.
yarn add @ddsys/react
Dependencies
This package contains few dependencies. The required peer dependencies for the package will be listed as warnings, run yarn add
or npm install
to resolve dependencies issues. Once resolved, you may now reference the library through import statement. E.g.:
import { BHPLogo } from '@ddsys/react';
// ...
export default () => (
<BHPLogo />
);
Using CSS
If your project is using CSS rather than SASS/SCSS, you will find precompiled CSS files in css/index-light.css
and css/index-dark.css
, which you can use directly in your React project as such:
import 'node_modules/@ddsys/ui/css/index-light.css';
Using SCSS
The SCSS is designed so that it can be included and extended within the context of an active project. Three major entry points in scss/index-dark.scss
, scss/index-light.scss
and scss/index-warm.scss
which may be sufficient for your needs, and which are also provided as simple examples of how to use the SCSS.
Any custom style or style override are to be added after the standard set presribed in the entry point scss. E.g.:
@import 'node_modules/@ddsys/ui/scss/index-dark';
@import 'override';