misterbk/mix

Helper plugin for Laravel Mix in Craft CMS templates

Maintainers

Details

github.com/mister-bk/craft-plugin-mix

Source

Issues

Installs: 160 913

Dependents: 5

Suggesters: 0

Security: 0

Stars: 51

Watchers: 8

Forks: 9

Open Issues: 3

Type:craft-plugin

v1.7.2 2024-10-02 14:43 UTC

Requires

MIT ffdf4a39f8d89d42f28de4a9b8c9deed92f2e431

Craftmixcraftcmslaravel-mixcraft-plugincraft4

This package is auto-updated.

Last update: 2024-11-02 14:48:26 UTC

README

Craft Mix Logo

Helper plugin for Laravel Mix in Craft CMS templates.

Latest Stable Version Total Downloads License

Requirements

This plugin requires Craft CMS 4.0.0-alpha or later, or Craft CMS 5.0.0 or later.

Installation

To install the plugin, follow these instructions.

  1. Open your terminal and go to your Craft project:
cd /path/to/project
  1. Then tell Composer to load the plugin:
composer require misterbk/mix
  1. In the Craft Control Panel, go to Settings → Plugins and click the "Install" button for Mix.

Configuration

To configure Mix go to Settings → Plugins → 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

NOTE: Both Public Path and Asset Path get trimmed to allow all kind of path combinations.

  • /web/ + /assets/ → /web/assets/
  • web + assets → /web/assets/
  • / + assets → /assets/
  • /web + / → /web/

Usage

Find a versioned CSS file.

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

Find a versioned JavaScript file.

<script src="{{ mix('js/main.js') }}"></script>

Lazily find a versioned file and build the tag based on the file extension.

{{ craft.mix.withTag('js/main.js') | raw }}

Alternatively include the content of a versioned file inline.

{{ craft.mix.withTag('css/main.css', true) | raw }}

License

Craft Mix is open-sourced software licensed under the MIT license.