zerocarbonweb

ZeroCarbonWeb React Components

This is a collection of reusable React components maintained by ZeroCarbonOne for use across the company's projects. The library is designed to promote consistency, improve developer productivity, and ensure adherence to ZeroCarbonOne's design standards.

Installation

To install the ZeroCarbonWeb React Components library, run the following command:

npm install zerocarbonweb

or

yarn add zerocarbonweb

Usage

To use a component from the library, import it into your React application:

import { Button } from 'zerocarbonweb';

function App() {
  return (
    <div>
      <Button>Click me</Button>
    </div>
  );
}

Components

The library currently includes the following components:

• Button: A customizable button component with various styles and variants.
• Input: A versatile input field component for text input.
• DropDown: A dropdown component for selecting options from a list.
• Label: A component for displaying labels or captions for form inputs or other elements.
• Radio: A radio button component for selecting a single option from a list.
• UploadInput: A component for uploading files or images.

For detailed information on each component's props and usage, please refer to the component documentation.

Contributing

Contributions to the ZeroCarbonWeb React Components library are welcome! If you find a bug or have a feature request, please open an issue on the GitHub repository. If you'd like to contribute code, please follow these steps:

1. Fork the repository
2. Create a new branch (git checkout -b feature/your-feature-name)
3. Make your changes and commit them (git commit -am 'Add some feature')
4. Push to the branch (git push origin feature/your-feature-name)
5. Create a new Pull Request

Please ensure that your code adheres to the project's coding standards and that you have added or updated any relevant documentation.

Acknowledgments

The ZeroCarbonWeb React Components library was inspired by and built upon the work of various open-source projects and resources. We would like to extend our gratitude to the developers and communities behind these projects.