Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 2.15 KB

README.md

File metadata and controls

64 lines (45 loc) · 2.15 KB
Raw

Mint UI

CI Gitter chat Discord

A beautiful, fully featured, reliable UI component library for Mint.

  • 60+ ready to use, hand crafted components.
  • Themable with CSS variables.
  • Fully responsive.
  • Data driven.

Get started

To use Mint UI you need to install Mint first.

Create a new Mint application with:

mint init my-app

add mint-ui to the mint.json file as a dependency:

"dependencies": {
  "mint-ui": {
    "repository": "https://github.com/mint-lang/mint-ui",
    "constraint": "8.0.0 <= v < 9.0.0"
  }
}

then install dependencies:

$ mint install
Mint - Installing dependencies
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
⚙ Constructing dependency tree...
  ✔ Cloned mint-ui (https://github.com/mint-lang/mint-ui)
  ✔ Cloned mint-color (https://github.com/mint-lang/mint-color)

⚙ Resolving dependency tree...
  ◈ mint-ui ➔ 8.0.0
  ◈ mint-color ➔ 0.9.0

⚙ Copying packages...
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
All done in 2.387s!"

Documentation

Head to ui.mint-lang.com to learn the in and outs of Mint UI!

License

Be aware of that Mint UI has a special license and requires obtaining a company license in some cases. Read the LICENSE documentation for more information.

Contributing

Please read CONTRIBUTING.md to learn about contributing to this project.