Skip to content

Capgemini/dcx-react-library

Repository files navigation

CircleCI

DCX React library

Motivation

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.

Components

To see the full list of components built in dcx-react-library, and how to use it, have a look on our storybook-showcase (Click on View Storybook to see the list of components) 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.

Image of dcx-react-library showcase

How to use it

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 'dcx-react-library';

const App = () => {
  return <Button label="start" onClick={() => {}} />;
};

Contributing

If you'd like to contribute, please follow our CONTRIBUTING section.

Raise a bug or enhancement

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.

Contributors ✨

Thanks goes to these wonderful people

daniele-zurico
Daniele Zurico
isaac-babalola
Isaac Babalola
alex-webber
Alex Webber
nikki-algar
Nikki Algar
niku-sharma
Niku Sharma
caner-shefik
Caner Shefik
claudio-ricci
Claudio Ricci