dcx-react-library
is a React library with a set of components ready to use in your project.
There are plenty of libraries available in React that can help to increase your productivity however most of them contain lots of css and are hard to style based on your project's requirements.
dcx-react-library is UI/UX agnostic so you need to provide styling to match the look and feel of your application. This allows the dcx-react-library to be easily integrated into any project.
To see the full list of components built in dcx-react-library, and how to use it, have a look on our storybook-showcase In Storybook, each component is presented with 4 main sections:
- documentation: describes the list of properties available, optional and mandatory;
- live: you can play directly with all the properties and see the component's behaviour;
- unstyled: the bare component without any styling applied;
- styled: an example (mainly based on GDS) of how to style the component and the final result.
Using dcx-react-library should not require any particular setup. You only need to import the component and use it 😃
Steps:
yarn add @capgeminiuk/dcx-react-library
- Import the component you need and use it. For example:
import { Button } from '@capgeminiuk/dcx-react-library';
const App = () => {
return <Button label="start" onClick={() => {}} />;
};
We don't ship dcx-react-library
with any included CSS. However, some stylesheet is required to use some components (for example, toggle
and tooltip
).
/* The following line can be included in your src/index.js or App.js file */
import '@capgeminiuk/dcx-react-library/dist/dcx-react-library.css';
If you'd like to contribute, please follow our CONTRIBUTING section.
For an introduction to the DCX React Library please read our Introducing the DCX React Library blog post. For tips on how you can contribute to the DCX React Library please read our Contributing to the DCX React Library blog post.
If you find a bug or you would like to recommend an improvement, please raise an issue and use the appropriate template. We will be more than happy to improve the library, smashing all the bugs found and improve the functionality.
Thanks goes to these wonderful people