Next Generation Material UI for Vue.js
BalmUI is a modular and customizable Material Design UI library for Vue 3.
balm-ui@8
supports for Vue 2
balm init vue my-project cd my-project
yarn add balm-ui # OR npm install --save balm-ui
update balm.config.js
get Material Icons without downloading (or, download and extract to my-project/app/fonts
)
const api = (mix) => { if (mix.env.isDev) { mix.copy('node_modules/balm-ui/fonts/*', 'app/fonts'); } };
edit my-project/config/balmrc.js
for using Dart Sass
module.exports = { styles: { extname: 'scss' } // Other Options... };
edit my-project/app/styles/global/_vendors.scss
/* import BalmUI styles */ @use 'balm-ui/dist/balm-ui';
Recommend to use Sass in
/path/to/project-name/styles/_vendors.scss
, and you can use more advanced style usage of the BalmUI.
edit my-project/app/scripts/main.js
import { createApp } from 'vue'; import App from '@/views/layouts/app'; import BalmUI from 'balm-ui'; // Official Google Material Components import BalmUIPlus from 'balm-ui/dist/balm-ui-plus'; // BalmJS Team Material Components const app = createApp(App); app.use(BalmUI); // Mandatory app.use(BalmUIPlus); // Optional app.mount('#app');
edit my-project/app/styles/global/_vendors.scss
@use 'balm-ui/components/core'; @use 'balm-ui/components/button/button'; @use 'balm-ui/components/icon/icon'; @use 'balm-ui/components/dialog/dialog'; @use 'balm-ui/plugins/alert/alert';
edit my-project/app/scripts/main.js
import { createApp } from 'vue'; import App from '@/views/layouts/app'; import UiButton from 'balm-ui/components/button'; import $alert from 'balm-ui/plugins/alert'; const app = createApp(App); app.use(UiButton); app.use($alert); app.mount('#app');
edit a vue component: my-project/app/scripts/views/components/hello.vue
<template> <div class="hello"> ... <!-- Add a test button --> <ui-button @click="$alert('Hello BalmUI')">Click Me</ui-button> </div> </template>
vue-cli
vue create my-project cd my-project
vite
# npm 6.x npm init @vitejs/app my-project --template vue # npm 7+, extra double-dash is needed: npm init @vitejs/app my-project -- --template vue # yarn yarn create @vitejs/app my-project --template vue cd my-project
yarn add balm-ui # OR npm install --save balm-ui
vue-cli
// vue.config.js module.exports = { runtimeCompiler: true, // NOTE: set alias via `configureWebpack` or `chainWebpack` configureWebpack: { resolve: { alias: { 'balm-ui-plus': 'balm-ui/dist/balm-ui-plus.js', 'balm-ui-css': 'balm-ui/dist/balm-ui.css' } } } // chainWebpack: (config) => { // config.resolve.alias // .set('balm-ui-plus', 'balm-ui/dist/balm-ui-plus.js') // .set('balm-ui-css', 'balm-ui/dist/balm-ui.css'); // } };
vite
// vite.config.js import { defineConfig } from 'vite'; import vue from '@vitejs/plugin-vue'; export default defineConfig({ plugins: [vue()], resolve: { alias: { vue: 'vue/dist/vue.esm-bundler.js', 'balm-ui-plus': 'balm-ui/dist/balm-ui-plus.esm.js', 'balm-ui-css': 'balm-ui/dist/balm-ui.css' } } });
edit my-project/src/main.js
import { createApp } from 'vue'; import App from './App.vue'; import BalmUI from 'balm-ui'; // Official Google Material Components import BalmUIPlus from 'balm-ui-plus'; // BalmJS Team Material Components import 'balm-ui-css'; const app = createApp(App); app.use(BalmUI); app.use(BalmUIPlus); app.mount('#app');
<!doctype html> <html lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Hello BalmUI</title> <link rel="stylesheet" href="https://unpkg.com/balm-ui/dist/balm-ui.css" /> </head> <body> <div id="app"> <ui-button icon="add" @click="$alert(message)">SayHi</ui-button> </div> <script src="https://unpkg.com/vue"></script> <script src="https://unpkg.com/balm-ui"></script> <script src="https://unpkg.com/balm-ui/dist/balm-ui-plus.js"></script> <script> const app = Vue.createApp({ setup() { var message = 'Hello BalmUI'; return { message }; } }); app.use(BalmUI); app.use(BalmUIPlus); app.mount('#app'); </script> </body> </html>
Enjoy 👻
We'd love for you to contribute and make BalmUI even better than it is today! Please make sure to read the Contributing Guide before making a pull request. You can submit any ideas as pull requests or as GitHub issues.
We officially support the last two versions of every major browser. Specifically, we test on the following browsers:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4