npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

laravel-mix-vue-css-modules

v3.0.0

Published

A Laravel Mix extension for css modules support.

Downloads

474

Readme

Add support for css module laravel mix. CSS, SCSS, LESS & STYLUS

Installation

npm i laravel-mix-vue-css-modules

Usage

First, VueCssModules must be enabled. Your webpack.mix.js could look like this:

const mix = require("laravel-mix");
require("laravel-mix-vue-css-modules");

mix.vueCssModules();

Then, add the module attribute to your <style>

<style module>
.red {
  color: red;
}
.bold {
  font-weight: bold;
}
</style>

You can then use it in your templates with a dynamic class binding:

<template>
    <p :class="$style.red">This should be red</p>
</template>

And that's it. you ready to go.

Opt-in Usage

If you only want to use CSS Modules in some of your Vue components, you can set oneOf to true

mix.vueCssModules({ oneOf: true });

Custom Injectname

<style module="$cssA">
  /* identifiers injected as $cssA */
</style>

<style module="$cssB">
  /* identifiers injected as $cssB */
</style>

Pre-Processors

By default all pre-processors are disabled.

For Scss

mix.vueCssModules({ preProcessor: { scss: true } });

For Less

npm i less less-loader --save-dev

then set less to true

mix.vueCssModules({ preProcessor: { less: true } });

For Stylus

npm i stylus stylus-loader --save-dev

then set stylus to true

mix.vueCssModules({ preProcessor: { stylus: true } });

Custom localIdentName

Default:

  • [path][name]__[local] for development
  • [hash:base64] for production
mix.vueCssModules({
    cssLoaderOptions: { localIdentName: "[path][name]__[local]" }
});

or you can use react or discord localIdentName

mix.vueCssModules({ localIdentNameType: "react" });

Enable sourceMap

Default: false

mix.vueCssModules({ cssLoaderOptions: { sourceMap: true } });

Set importLoaders

Default: 1

mix.vueCssModules({ cssLoaderOptions: { importLoaders: 2 } });

Exclude

mix.vueCssModules({ exclude: [path.resolve(__dirname, "node-modules")] });

Exclude css

you may want some of your css exluded from generated class by css module.

const getLocalIdent = require("css-loader/lib/getLocalIdent");

mix.vueCssModules({
    cssLoaderOptions: {
        getLocalIdent: (context, localIdentName, localName, options) => {
            return context.resourcePath.includes("x.scss")
                ? localName
                : getLocalIdent(context, localIdentName, localName, options);
        }
    }
});

Example

<script>
export default {};
</script>

<template>
    <div>
        <span class="blue">css scoped</span>

        <span :class="$css.blue">css module</span>

        <span class="red">scss scoped</span>

        <span :class="$scss.red">scss module</span>

        <span class="green">less scoped</span>

        <span :class="$less.green">less module</span>

        <span class="indigo">stylus scoped</span>

        <span :class="$stylus.indigo">stylus module</span>
    </div>
</template>

<style scoped>
.blue {
    color: blue;
}
</style>

<style module="$css">
.blue {
    color: blue;
}
</style>

<style lang="scss" scoped>
@mixin my-color($color) {
    color: $color;
}

.red {
    @include my-color(red);
}
</style>

<style lang="scss" module="$scss">
@mixin my-color($color) {
    color: $color;
}

.red {
    @include my-color(red);
}
</style>

<style lang="less" scoped>
@color: green;

.green {
    color: @color;
}
</style>

<style lang="less" module="$less">
@color: green;

.green {
    color: @color;
}
</style>

<style lang="stylus" scoped>
my-color()
    color: arguments

.indigo
    my-color: indigo
</style>

<style lang="stylus" module="$stylus">
my-color()
    color: arguments

.indigo
    my-color: indigo
</style>