README

Helper plugin for Laravel Mix in Craft CMS templates.

Requirements

Craft CMS 3.7+
PHP
Node.js 6+

Installation

To install the plugin, follow these instructions.

Open your terminal and go to your Craft project:

cd /path/to/project

Then tell Composer to load the plugin:

composer require delaneymethod/craft-mix

In the Craft Control Panel, go to Settings → Plugins and click the "Install" button for Craft Mix.
Create a package.json file with the following contents to install Laravel Mix dependencies and configure asset build tasks.

{
	"private": true,
	"scripts": {
		"dev": "npm run development",
		"development": "cross-env NODE_ENV=development node_modules/webpack/bin/webpack.js --progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js",
		"watch": "cross-env NODE_ENV=development node_modules/webpack/bin/webpack.js --watch --progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js",
		"watch-poll": "npm run watch -- --watch-poll",
		"hot": "cross-env NODE_ENV=development node_modules/webpack-dev-server/bin/webpack-dev-server.js --inline --hot --config=node_modules/laravel-mix/setup/webpack.config.js",
		"prod": "npm run production",
		"production": "cross-env NODE_ENV=production node_modules/webpack/bin/webpack.js --progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js"
	},
	"devDependencies": {
		"cross-env": "^7.0.3",
		"laravel-mix": "^6.0.41"
	}
}

Install the Node.js dependencies using npm or yarn.

npm install # OR yarn install

Configuration

To configure Craft Mix go to Settings → Plugins → Craft Mix in the Craft Control Panel.

The available settings are:

Public Path - The path of the public directory containing the index.php
Asset Path - The path of the asset directory where Laravel Mix stores the compiled files

To demonstrate usage of the plugin, let's imagine a project with the following directory structure.

...
assets/
  js/
    global.js
  scss/
    global.scss
web/
  assets/
    js/
    css/
...

Create a webpack.mix.js file at the root of your project to configure Laravel Mix for building your assets. See the Laravel Mix documentation for configuration details and more options. Be sure to configure the publicPath option to point at the directory from which you will serve static assets (images, fonts, javascript and CSS). Here's an example configuration as a starting point that would work with the previously described project structure:

const del = require('del');
const { mix } = require('laravel-mix');

del(['web/assets/**', '!web/assets']);

mix.setPublicPath('web/assets');

if (mix.inProduction) {
    mix.disableNotifications();
}

if (!mix.inProduction) {
	mix.sourceMaps();
}

mix.options({
	processCssUrls: false
});

mix.sass('assets/sass/global.scss', 'web/assets/css/global.css');

mix.js('assets/js/global.js', 'web/assets/js/global.js');

mix.copy('assets/fonts', 'web/assets/fonts');

mix.copy('assets/img', 'web/assets/img');

mix.version();

Usage

The primary purpose of this plugin is to provide template helpers that translate between a known path to your build assets and the real path to the assets after they have been built (which varies depending on the build mode). There are three main ways you can use Mix from Twig templates in CraftCMS:

{# Twig Filter #}
<script type="text/javascript" src="{{ 'js/global.js' | mix }}"></script>

<link rel="stylesheet" href="{{ 'css/global.css' | mix }}">

{# Twig Function #}
<script type="text/javascript" src="{{ mix('js/global.js') }}"></script>

<link rel="stylesheet" href="{{ mix('css/global.cs') }}">

{# CraftCMS Variable #}
<script type="text/javascript" src="{{ craft.mix.withTag('js/global.js') }}"></script>

{{ craft.mix.withTag(\'css/global.css\') | raw }}

// include the content of a versioned file inline.
{{ craft.mix.withTag(\'css/global.css\', true) | raw }}

There are a handful of different modes in which you can run Mix and the plugin will work differently in each mode, as described in the following sections.

Dev Mode

Dev mode will build your assets to target a development environment. Depending on how you've configured Mix, this may bypass certain build instructions intended only for the production environment. In the example webpack.mix.js file, we are only versioning assets in production mode for cache busting or similar use cases. You can build the assets for developer mode by using the npm script we added in our package.json file:

npm run dev

Watch Mode

Functions just like Dev Mode except Mix will continue running as a foreground process through NodeJS and building assets as changes to the source files are detected.

npm run watch

Hot Module Replacement Mode

Builds your assets and runs the Webpack dev server to allow Hot Module Replacement. It works very similarly to what is described in the Laravel Mix documentation. To run in HMR mode, run the following command:

npm run hot

Production Mode

or bundle your assets for production

npm run production

Credits

Sean Delaney

About DelaneyMethod

DelaneyMethod are a Full-Stack Web Development Agency with a no-nonsense, get it done attitude with a proven track record for delivering their part of a project. Learn more about us on our website.

License

The MIT License (MIT). Please see License File for more information.

delaneymethod / craft-mix

Maintainers

Details