https://github.com/apvarun/rewind-components

Ready to use components for your next project
https://github.com/apvarun/rewind-components

component-library components design-system react react-component-library

Last synced: 25 days ago
JSON representation

Ready to use components for your next project

• Host: GitHub
• URL: https://github.com/apvarun/rewind-components
• Owner: apvarun
• License: mit
• Created: 2019-06-15T10:02:57.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-23T01:44:22.000Z (7 months ago)
• Last Synced: 2024-09-26T22:07:13.648Z (about 1 month ago)
• Topics: component-library, components, design-system, react, react-component-library
• Language: JavaScript
• Homepage: https://rewind-components.uicomet.com/
• Size: 2.67 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Rewind Components

[![npm version](https://badge.fury.io/js/rewind-components.svg)](https://badge.fury.io/js/rewind-components)

![npm bundle size](https://img.shields.io/bundlephobia/minzip/rewind-components.svg)

![NPM](https://img.shields.io/npm/l/rewind-components.svg)

Ready to use components for your next project.

![Rewind Logo](public/rewind-logo.png)

* Optimized Build with small footprint (2-3k gzipped)

* Pure React Components

* Minimal Design

→ PREVIEW

## Get Started

Add the Rewind component library to your project to use the components.

### Install

```

yarn add rewind-components -S

```

or if you are using NPM:

```

npm install rewind-components --save

```

### Usage

All the components in Rewind are exported from the base component.

You can import only the ones you need and so not load unused components in your production bundle.

**Example:** `import { Alert } from "rewind-components";`

Include the CSS into your global CSS file for all the Rewind components.

And make sure to use purgeCSS or UnCSS to remove unused CSS frmo your bundle.

```

@import "~rewind-components/dist/index.css";

```

### Browser support

Rewind Components are supported in Chrome, Firefox, Safari, and Microsoft Edge.

### Built With

* **Tailwind CSS** [🔗](https://tailwindcss.com) - for CSS styles

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/apvarun/rewind-components/blob/master/LICENSE) file for details.