Next Generation Material UI for Vue.js
TL;DR: Vue 3 is now the new default version as of Monday, February 7, 2022!
(old) material.balmjs.com -> v8.material.balmjs.com
BalmUI is a modular and customizable Material Design UI library for Vue.js.
:tada: NOW,
balm-ui(v9+) supports for Vue 3.0
balm init vue#legacy my-project
cd my-project
balm-uiyarn add balm-ui@8
# OR
npm install --save balm-ui@8
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/_vendor.scss
/* import BalmUI styles */
@use 'balm-ui/dist/balm-ui';
Recommend to use Sass in
/path/to/project-name/styles/_vendor.scss, and you can use more advanced style usage of the BalmUI.
edit my-project/app/scripts/main.js
import Vue from 'vue';
import BalmUI from 'balm-ui'; // Official Google Material Components
import BalmUIPlus from 'balm-ui/dist/balm-ui-plus'; // BalmJS Team Material Components
Vue.use(BalmUI); // Mandatory
Vue.use(BalmUIPlus); // Optional
edit my-project/app/styles/global/_vendor.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 Vue from 'vue';
import UiButton from 'balm-ui/components/button';
import $alert from 'balm-ui/plugins/alert';
Vue.use(UiButton);
Vue.use($alert);
npm run dev
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>
npm run prod
vue create my-project
cd my-project
balm-uiyarn add balm-ui@8
# OR
npm install --save balm-ui@8
edit my-project/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');
// }
};
edit my-project/src/main.js
import Vue 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';
Vue.config.productionTip = false;
Vue.use(BalmUI); // Mandatory
Vue.use(BalmUIPlus); // Optional
new Vue({
render: (h) => h(App)
}).$mount('#app');
<script><!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://cdn.jsdelivr.net/npm/balm-ui/dist/balm-ui.css"
/>
</head>
<body>
<div id="app">
<ui-button @click="$alert(message)" icon="add">SayHi</ui-button>
</div>
<script src="https://cdn.jsdelivr.net/npm/vue@2"></script>
<script src="https://cdn.jsdelivr.net/npm/balm-ui"></script>
<script src="https://cdn.jsdelivr.net/npm/balm-ui/dist/balm-ui-plus.js"></script>
<script>
new Vue({
el: '#app',
data: {
message: 'Hello BalmUI'
}
});
</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:
FAQs
A modular and customizable UI library based on Material Design and Vue 3
The npm package balm-ui receives a total of 354 weekly downloads. As such, balm-ui popularity was classified as not popular.
We found that balm-ui demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.