https://github.com/turtlemint/mint-ui

Design System | React UI components for web
https://github.com/turtlemint/mint-ui

design-system gitpod modern react react-components react-hooks reactjs turtlemint turtlemint-ui typescript-library ui ui-components ui-design ui-library

Last synced: 3 months ago
JSON representation

Design System | React UI components for web

• Host: GitHub
• URL: https://github.com/turtlemint/mint-ui
• Owner: turtlemint
• License: mit
• Created: 2019-11-12T12:21:24.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-07-07T18:54:18.000Z (over 2 years ago)
• Last Synced: 2024-10-28T07:16:08.501Z (3 months ago)
• Topics: design-system, gitpod, modern, react, react-components, react-hooks, reactjs, turtlemint, turtlemint-ui, typescript-library, ui, ui-components, ui-design, ui-library
• Language: TypeScript
• Homepage: https://mint-ui.netlify.com
• Size: 6.78 MB
• Stars: 18
• Watchers: 3
• Forks: 8
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  





UI components for web - A React implementation

![npm version](https://img.shields.io/npm/v/@turtlemint/mint-ui)

![NPM size](https://badgen.net/bundlephobia/minzip/@turtlemint/mint-ui)

![W3C Validation](https://img.shields.io/w3c-validation/html?targetUrl=https%3A%2F%2Fmint-ui.netlify.com)

![Netlify Status](https://img.shields.io/netlify/f808dfbe-b589-4cca-8149-3a169f9f44bb)

![NPM](https://img.shields.io/npm/l/@turtlemint/mint-ui)



## ✨ Features 

- A modern and fitting UI design system for scalable web applications.

- SaaS driven component APIs

- Boasts of **Composite UI** - A rendering engine that lays out any Nth level deep nested hierarchical structure.

- A set of high-quality React components out of the box.

- Written in TypeScript with predictable static types. 

- The whole package of development and design resources and tools.

## 🖥 Environment Support

- Modern browsers and Internet Explorer 9+ (with polyfills)

| [](http://godban.github.io/browsers-support-badges/)IE / Edge | [](http://godban.github.io/browsers-support-badges/)Firefox | [](http://godban.github.io/browsers-support-badges/)Chrome | [](http://godban.github.io/browsers-support-badges/)Safari | [](http://godban.github.io/browsers-support-badges/)Opera |

| --- | --- | --- | --- | --- |

| IE9, IE10, IE11, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |

## 📦 Install

```bash

npm i @turtlemint/mint-ui --save

```

```bash

yarn add @turtlemint/mint-ui

```

## 🔨 Usage

```jsx

import { Button } from '@turtlemint/mint-ui';

ReactDOM.render(, mountNode);

```

## ⌨️ Development

Use Gitpod, a free online dev environment for GitHub.

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/turtlemint/mint-ui/)

Or clone locally:

```bash

$ git clone [email protected]:turtlemint/mint-ui.git

$ cd mint-ui

$ yarn install

$ yarn workspace @turtlemint/mint-ui run dev

```

It should spin up a browser automatically. If not, open your browser and visit http://127.0.0.1:5555

## 🤝 Contributing [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

We welcome all contributions. Please read our [CONTRIBUTING.md](https://github.com/turtlemint/mint-ui/blob/master/CONTRIBUTING.md) first. You can submit any ideas as [pull requests](https://github.com/turtlemint/mint-ui/pulls) or as [GitHub issues](https://github.com/turtlemint/mint-ui/issues).