Zephyrus Components

Zephyrus Components is a React component library designed for easy integration into your applications. It provides a set of reusable UI components with support for customization and styling.

Installation

To install the Zephyrus Components library, use npm or yarn:

npm install zephyrus-components

or

yarn add zephyrus-components

Usage

To use a component from the library, simply import it into your React project and include it in your JSX. Below are some examples of how to use the components provided by Zephyrus Components.

See README.md files inside each component for more infos.

Custom Styles

To customize the styles of a component, you can use the customStyles prop. This prop accepts an object where keys correspond to class names, and values are custom CSS class names.

Example of Using Custom Styles

import React from "react";
import { InputText } from "zephyrus-components";
import './my-custom-styles.css';

const MyForm: React.FC = () => {
    return (
        <form>
            <InputText
                name="example-input"
                id="example-input"
                value=""
                onChange={() => {}}
                placeholder="Enter text"
                isMandatory={true}
                error="This field is required"
                customStyles={{ inputError: 'my-custom-error-class' }}
            />
        </form>
    );
};

export default MyForm;

In this example, the inputError class from defaultStyles will be overridden by the my-custom-error-class class from my-custom-styles.css.

Contributing

Contributions to Zephyrus Components are welcome! If you have suggestions or find issues, please open an issue or submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.