Skip to content

0.5.5-beta.12.1

Pre-release
Pre-release
Compare
Choose a tag to compare
@ojvribeiro ojvribeiro released this 24 Oct 05:43
· 597 commits to main since this release
511e3b9

Warning
This update brings breaking changes for previous versions. Follow the migration instruction bellow.

Migrating to this version

This version introduces some design decisions that may break your app, but I got you covered. Here's what changed:

  • Tailwind is not a core dependency anymore. It still comes along with the create-vulmix-app starter template, but if you upgrade from previous versions (<0.5.5-beta.11), you must install it again.
  • Now Vulmix has Hot Module Replacement (HMR), what makes the development process smoother.

Down bellow are the changes you need to make to use this version.

1. Update the Vulmix package

npm install [email protected]

2. Install Tailwind, if needed

Previously, Tailwind was installed by default in Vulmix. In order to make Vulmix more flexible, it was removed from the dependencies, so the developer can decide which CSS framework to use.

If your project uses Tailwind, you must install it following this guide and include the Tailwind Directives to the <style> section of the app.vue file (or import it from a separate CSS/Sass file):

@tailwind base;
@tailwind components;
@tailwind utilities;

3. Remove node_modules paths from tailwind.config.js

/** @type {import('tailwindcss').Config} */
module.exports = {
  content: [
-    // Built-in templates
-    './node_modules/vulmix/src/**/pages/**/*.{vue,js}',
-    './node_modules/vulmix/src/**/components/**/*.{vue,js}',
-    './node_modules/vulmix/src/**/layouts/**/*.{vue,js}',

    // User templates
    './app.vue',
    './pages/**/*.{vue,js}',
    './components/**/*.{vue,js}',
    './layouts/**/*.{vue,js}',
  ],
  theme: {
    extend: {},
  },
  plugins: [],
}

4. Add the --hot flag to the dev script

In your package.json, in the "scripts" section, add a --hot flag to the dev command to enable HMR:

"scripts": {
  "dev": "mix watch --hot",
},

Changelog

✨ New features

  • feat(core): Hot Module Replacement #80
  • feat(starter-template): better welcome page with VulmixWelcome #71
  • <Icon> component (docs)

🐞 Fixes

  • fix(core): premature end of jpeg file #74
  • fix(core): server crashes in low-end devices #77
  • More stability on dev launch

⚠️ Refactors

  • refactor(core): pure CSS instead of Tailwind #75

📄 Documentation

  • Created home page
  • Improved Get Started page
  • Created some new more pages