An open API service indexing awesome lists of open source software.

https://github.com/prabhuignoto/react-creme

Comprehensive UI Tool Kit for React
https://github.com/prabhuignoto/react-creme

components design-system lightweight lightweight-javascript-library react react-component-library typescript ui-components ui-kit

Last synced: about 1 year ago
JSON representation

Comprehensive UI Tool Kit for React

Awesome Lists containing this project

README

          








![npm bundle size (version)](https://img.shields.io/bundlephobia/minzip/react-creme)
[![codecov](https://codecov.io/gh/prabhuignoto/react-creme/branch/master/graph/badge.svg?token=JEL70TGE8Q)](https://codecov.io/gh/prabhuignoto/react-creme)
[![Snyk](https://snyk.io/test/github/prabhuignoto/react-creme/badge.svg)](https://snyk.io/test/github/prabhuignoto/react-creme)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=react-creme&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=react-creme)
[![CodeFactor](https://www.codefactor.io/repository/github/prabhuignoto/react-creme/badge)](https://www.codefactor.io/repository/github/prabhuignoto/react-creme)
[![CodeQL](https://github.com/prabhuignoto/react-creme/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/prabhuignoto/react-creme/actions/workflows/codeql-analysis.yml)
[![dev status](https://img.shields.io/badge/status-beta-green)](https://img.shields.io/badge/status-beta-green)
[![GitHub license](https://img.shields.io/github/license/prabhuignoto/react-creme)](https://github.com/prabhuignoto/react-creme/blob/master/LICENSE)
![npm](https://img.shields.io/npm/v/react-creme)

Modern UI Toolkit for React

[Explore the Components](https://react-creme.vercel.app/)

Features

- ๐Ÿ’Ž High Quality React components.

- ๐Ÿ’ช Robust components written in Typescript.

- โ™ฟ Accessible UI Components.

- ๐ŸŒˆ 45+ UI Components.

- ๐Ÿ› ๏ธ Customizable components.

- ๐ŸŽจ Themeable components.

- โš™๏ธ Minimal Third party dependencies.

- ๐Ÿชถ At ~55kb minified and gzipped, `react-creme` is a lightweight component library.

Table of Contents

- [๐Ÿš€ Getting Started](#-getting-started)
- [โ˜• Usage](#-usage)
- [๐ŸŒ Browser Support](#-browser-support)
- [๐Ÿซ Examples & Documentation](#-examples--documentation)
- [๐Ÿ”จ Build](#-build)
- [๐ŸคContributing](#contributing)

## ๐Ÿš€ Getting Started

Install the package using npm or yarn

```sh
yarn add react-creme

or

npm install react-creme

```

## โ˜• Usage

```sh
import { Button } from "react-creme";

const App = () => {
return (


Welcome to react-creme

);
};

export default App;
```

## ๐ŸŒ Browser Support

| ![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) | ![Firefox](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) | ![IE](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | ![Opera](https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png) | ![Safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png) |
| --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------- |
| Chrome | Firefox | Microsoft Edge | Opera | Safari |

## ๐Ÿซ Examples & Documentation

For more thorough examples and the API details visit the [main site](https://react-creme.vercel.app)

## ๐Ÿ”จ Build

To build everything

```sh
pnpm build
```

To build the library

```sh
pnpm build:lib
```

To build and run the documentation

```sh
pnpm build:doc
cd ./packages/documentation/expo_dist && npx serve .
```

To run the Unit tests

```sh
pnpm test
```

## ๐ŸคContributing

Contributions, ideas and PR's are welcome!. Please read the [guidelines](/CONTRIBUTING.md) for more details.

1. [Fork it](https://github.com/prabhuignoto/react-creme/fork)
2. Create your feature branch (`git checkout -b new-feature`)
3. Commit your changes (`git commit -am 'Add feature'`)
4. Push to the branch (`git push origin new-feature`)
5. Create a new Pull Request

[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-orange.svg)](https://sonarcloud.io/summary/new_code?id=react-creme)