Skip to content

Latest commit

 

History

History
85 lines (68 loc) · 2.23 KB

README.md

File metadata and controls

85 lines (68 loc) · 2.23 KB

mdui logo

mdui

A Material Design 3 (Material You) library of Web Components.
https://www.mdui.org

npm version CSS gzip size JS gzip size downloads license


  • 🧩 Works with all frameworks
  • 🚛 Works with CDNs
  • 🏙️ Material 3 design system
  • 🌛 Includes dark theme and dynamic color
  • 🆚 Optimized for WebStorm and VSCode
  • 😸 Open source

Docs

Installation

npm install mdui --save

Usage

Import CSS and JS:

import 'mdui/mdui.css';
import 'mdui';

Use the component:

<mdui-button>Button</mdui-button>

Using CDN

<!doctype html>
<html>
  <head>
    <meta charset="UTF-8">
    <link rel="stylesheet" href="https://unpkg.com/mdui@2/mdui.css">
    <script src="https://unpkg.com/mdui@2/mdui.global.js"></script>
  </head>
  <body>
    <mdui-button>Hello, world!</mdui-button>
  </body>
</html>

License

MIT