@capgeminiuk/dcx-react-library
TypeScript icon, indicating that this package has built-in type declarations

1.0.0-rc5 • Public • Published

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 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.

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

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

Styling

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';

Contributing

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

Blog posts

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.

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
marius-mirca
Marius Mirca
isaac-babalola
Isaac Babalola
alex-webber
Alex Webber
nikki-algar
Nikki Algar
niku-sharma
Niku Sharma
claudio-ricci
Claudio Ricci
sandra-ro-diaz
Sandra Ro Diaz
ellie-tahmasebi
Ellie Tahmasebi
sri-viswanathan"/
Sri Viswanathan
julian-taylor"/
Julian Taylor
sergio-bandera-garcia"/
Sergio Bandera Garcia
szilvi-horvath
Szilvi Horvath
jaya-rathore
Jaya Rathore
arpana-kumari
Arpana Kumari
caner-shefik
Caner Shefik
jadhav-jeet
Jadhav Jeet
soundar-arumugam
Soundar Arumugam
j-gonzales
Javier Gonzalez Moya
kavitha-kurella
Kavitha Kurella
yunus-firat
Yunus Firat
yohannes-berhane
Yohannes Berhane
ahmet-kucukibrahimoglu
Ahmet Kucukibrahimoglu
ismael-akhtaab
Ismael Akhtaab

/@capgeminiuk/dcx-react-library/

    Package Sidebar

    Install

    npm i @capgeminiuk/dcx-react-library

    Weekly Downloads

    257

    Version

    1.0.0-rc5

    License

    MIT

    Unpacked Size

    1.78 MB

    Total Files

    241

    Last publish

    Collaborators

    • tdashworth
    • ewingjm
    • mikerolls
    • daniele.zurico
    • iobabalola_cap