Skip to content

turtlemint/mint-ui

Repository files navigation

UI components for web - A React implementation

npm version NPM size W3C Validation Netlify Status NPM

✨ 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)
IE / Edge
IE / Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
Opera
Opera
IE9, IE10, IE11, Edge last 2 versions last 2 versions last 2 versions last 2 versions

📦 Install

npm i @turtlemint/mint-ui --save
yarn add @turtlemint/mint-ui

🔨 Usage

import { Button } from '@turtlemint/mint-ui';
ReactDOM.render(<Button title="Sample Button" btnStyle="primary" />, mountNode);

⌨️ Development

Use Gitpod, a free online dev environment for GitHub.

Open in Gitpod

Or clone locally:

$ git clone git@github.com: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

We welcome all contributions. Please read our CONTRIBUTING.md first. You can submit any ideas as pull requests or as GitHub issues.