Vue bem plugin

utility functions to generate BEM class names for Vue components

Version: 1.0.2 Updated: 04/07/2019

By: tmikeschu License: ISC

Downloads Last 30 Days: 25

Install

npm i vue-bem-plugin
yarn add vue-bem-plugin

Repository: https://github.com/tmikeschu/vue-bem

CDNs

bundle.run: https://bundle.run/vue-bem-plugin

jsDelivr: https://cdn.jsdelivr.net/npm/vue-bem-plugin

unpkg: https://unpkg.com/vue-bem-plugin

Build Status

Vue BEM Plugin

BEM is a great way to namespace DOM elements. If you're like me, however, you can't stand manually writing __ and -- over and over again.

"Todo__list__item Todo__list__item--completed"

No thanks!

Following Vue's many pleasant declarative template patterns, use this mixin to name your blocks, elements, and modifiers in a more declarative style. Let the mixin take care of implementing dashes and low-dashes alike.

API

The public interface for the mixin is a function called bem.

The block of the component is defined by the name property on the Vue component.

Given a component:

<script>
export default {
  name: "Calculator",
  data() {
    return {
      atZero: true,
      ...
    };
  },
};
</script>

Blocks

Vue

<div :class="bem.block">...</div>

HTML

<div class="Calculator">...</div>

Elements : String | [String]

  • element

Vue

<div :class="bem({ element: 'screen' })">...</div>

HTML

<div class="Calculator__screen">...</div>
  • elements

Vue

<div :class="bem({ elements: ['screen', 'number'] })">...</div>

HTML

<div class="Calculator__screen__number">...</div>

Modifiers : { String: Bool }

Vue

<div :class="bem({ modifiers: { atZero } })">...</div>

HTML

<div class="Calculator Calculator--atZero">...</div>

All together

Vue

<div :class="bem.block">
  <div :class="
      bem({
        elements: ['screen', 'number'],
        modifiers: { atZero, disabled: false, success: true }
      })
    "
  >
    ...
  </div>
</div>

HTML

<div class="Calculator">
  <div
    class="Calculator__screen__number Calculator__screen__number--atZero Calculator__screen__number--success"
  >
    ...
  </div>
</div>

Configuration

To make the bem function globally available to all Vue components:

  • Plugin (recommended):
import Vue from "vue"
import App from "./App.vue"
import { bemPlugin } from "vue-bem-plugin"

Vue.use(bemPlugin)

new Vue({
  render: h => h(App),
}).$mount("#app")
import Vue from "vue"
import App from "./App.vue"
import { bemMixin } from "vue-bem-plugin"

Vue.mixin(bemMixin)

new Vue({
  render: h => h(App),
}).$mount("#app")

Alternatively, import the mixin on a per-component basis:

<script>
import { bemMixin } from "vue-bem-plugin"

export default {
  name: "Calculator",
  mixins: [bemMixin],
}
</script>

Local Development

  • Clone the directory
  • npm install && npm test

Ramda Golf

If you check out the source code, you'll see a lot of utility functions imported from the Ramda library. I wanted to have some fun and stitch together as much library code as possible. If some of the code seems gratuitously abstract or needlessly clever, you are not wrong 😇.

Tools

Contributing

Interested in expanding or improving the API?

  1. Reach out to me and say hello! I'd love to hear about what you're interested in.

  2. Once we've confirmed what you can work on, fork this repo and work on your masterpiece.

  3. Once your work is done, squash your work to a single commit, and open a PR from your feature branch to this repo's master branch.

Categories: Vue js