Skip to content

prabhuignoto/react-creme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation




npm bundle size (version) codecov Snyk Quality Gate Status CodeFactor CodeQL dev status GitHub license npm


Modern UI Toolkit for React

Explore the Components

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

Install the package using npm or yarn

yarn add react-creme

or

npm install react-creme

☕ Usage

  import { Button } from "react-creme";

  const App = () => {
    return (
      <div>
        <Button>Welcome to react-creme</Button>
      </div>
    );
  };

  export default App;

🌍 Browser Support

Chrome Firefox IE Opera Safari
Chrome Firefox Microsoft Edge Opera Safari

🍫 Examples & Documentation

For more thorough examples and the API details visit the main site

🔨 Build

To build everything

pnpm build

To build the library

pnpm build:lib

To build and run the documentation

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

To run the Unit tests

pnpm test

🤝Contributing

Contributions, ideas and PR's are welcome!. Please read the guidelines for more details.

  1. Fork it
  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