Hooks are coming to Vue.js version 3.0

Written by Nwose Lotanna✏️

This article introduces an experimental Vue feature called Hooks.

Before you start

This post is suited for developers of all stages including beginners. Here are a few things you should already have before going through this article.

You will need the following in your pc:

• Node.js version 10.x and above installed. You can verify if you do by running the command below in your terminal/command prompt:

node -v

• A code editor: Visual Studio Code is highly recommended
• Vue’s latest version, installed globally on your machine
• Vue CLI 3.0 installed on your machine. To do this, uninstall the old CLI version first:

npm uninstall -g vue-cli

then install the new one:

npm install -g @vue/cli

• Download a Vue starter project here
• Unzip the downloaded project
• Navigate into the unzipped file and run the command to keep all the dependencies up-to-date:

npm install

Introduction: Hooks

Initially, React components that contain state logic must be a class component. Even though there were already stateless functional components in React there was a need to create components that accommodate state logic without being classes. That was when Hooks was born. Hooks are a way to use state logic inside functional components, thereby eliminating the need for writing classes.

What is wrong with classes?

There is nothing wrong with classes, to begin with, but the React team found out that understanding how classes work has been a drawback to React adoption. It can be difficult to understand and can become ambiguous as your project increases in size and complexity.

But I don’t normally use classes in Vue JS..

If you are a Vue developer, you might wonder why classes are being discussed as you do not use classes by default in your Vue projects. While this is true, Vue JS lets you use functional components that are stateless with mixins. With Vue mixins you can define logic or a functionality in a particular file and use and even re-use it in a functional component.

The problem with mixins

In a blog post, some months back, Sarah Drasner a very popular Vue core team member wrote about her conversation with Evan You the creator of Vue JS. Sarah revealed that a mixin cannot consume or use state from another mixin, which makes chaining of encapsulated logic difficult to achieve. This is the mixin limitation that the Vue Hooks solves for.

Introducing Vue Hooks

Vue Hooks are basically an enhanced version of mixins, if you do not know what mixins are, they are a platform in Vue used to re-use logic between components (you will see a quick demo of mixins in this post). Vue Hooks lets you pass logic from one Hook to another and you can also use state in a Hook from another Hook. So just like in React, Hooks in Vue are defined in functions which can be a cleaner and more flexible way to define and share logic and can return state.

Demo A: Vue mixins

If you have followed this post from the start, you must have downloaded the starter project file and opened it up in your VS Code application. We are going to create a mixin that contains a counter logic and then import it into any component of choice. First, create a folder called mixins in the root directory and create a new file, call it clickMixin.js and copy the code block below inside it:

export default { 
    data (){
      return{
        count: 1,
        double: 2
      }
    },
    methods: {
      clicked(){
       this.count++; 
       this.double = this.count*2;
      }
    }
  }

This mixin contains counter logic and also contains a variable that returns double the count, you see the export statement because it has to be imported into your component of choice. Open your Test.vue component and copy the code block below inside it:

<template>
  <div> 
    <button v-on:click="clicked()">Button 1</button>
    <h2>{{this.count}}</h2>
    <h2>{{this.double}}</h2>
  </div>
</template>
<script>
import clickMixin from '../Mixins/clickMixin'
export default {
  name: 'Test',
  mixins: [clickMixin]
}
</script>

Here you see how mixins are imported and registered under the name, it is a Vue instance property just like data or methods or computed properties. You also see that inside the template that you have access to this in JavaScript as it relates to the mixins (almost like the mixin was defined right inside the component). If you run the application in your dev server it should look like this:

When you click button 1, the counter is increased by 1 and the lower figure is double the counter figure just as the template in your code suggests.

Demo B: Vue Hooks

You can recreate this logic with Vue Hooks easily, the point of the Hooks is to potentially replace mixins in the future. First of all, you have to install the vue-Hooks package with the node package manager. Open a new terminal in VS Code and run:

npm install vue-Hooks

Then open up your main.js file and initialize Hooks with a line of command before the new Vue statement:

Vue.use(Hooks);

Open the components folder and create a new file inside it, call it Modal.vue then navigate back to the root directory and create a new folder called Hooks. Inside the Hooks folder create a new file called Hooks.js and copy this code block below into it:

import { useData, useMounted, useEffect, useComputed, useUpdated} from 'vue-Hooks'
export default function clickedHook(){
const data = useData({ count:1 })
const double = useComputed(() => data.count * 2)
useMounted(()=> {console.log('mounted')});
useUpdated(()=> {console.log('updated')});
useEffect(()=> {
     console.log('DOM re-renders....')
 });
return {
     data, double
   }
}

Just like in React, Vue Hooks borrows the use-prefix syntax and uses it in the Vue way. You also notice that the lifecycle Hooks available for every Vue instance is accessible inside Vue Hooks, some of them are:

• useData: handles initialization of data inside your Hook, so the count is initialized inside it
• useComputed: this is more like computed properties inside your Hook, so the double computation is done inside it
• useMounted: acts exactly like the mounted lifecycle Hook in your Vue instance but for Hooks
• useUpdated: acts exactly like the updated lifecycle Hook in your Vue instance but for Hooks
• useEffect: this handles logic on DOM re-render

There are other properties you can import, the whole list can be found here on GitHub. You will notice it is exported as a function, open the modal.vue file you created earlier and copy this code block below inside it:

<template>
  <div> 
    <button v-on:click="data.count++">Button 2</button>
    <h2>{{data.count}}</h2>
    <h2>{{double}}</h2>
  </div>
</template>
<script>
import clickedHook from '../Hooks/Hooks'
export default {
  name: 'Modal',
  Hooks(){
    return clickedHook();
  }
}
</script>

Notice that after importing the Hooks file, you can access the data and the double constants earlier defined in the Hook inside this component. We also see that Hooks registration has the same syntax with data registration, with the function set up and the return object inside it.

It is important to note that…

• You can go ahead and use Vue Hooks right away (your Vue version must be 2.x)
• There is speculation that Vue version 3.0 will ship with Vue Hooks officially
• It is experimental and so should not be used in production yet
• Read the Sarah Drasner blog post here which contains even more examples too

You can use npm or just go to GitHub with this link to get the project repository.

Conclusion

This has been a quick overview of Hooks in Vue JS and how they might differ from the React Hooks that inspired it. We also highlighted mixins for readers who have not been introduced to the concept and we looked at an illustration using Hooks. Are you excited about Vue Hooks?

---

Editor's note: Seeing something wrong with this post? You can find the correct version here.

Plug: LogRocket, a DVR for web apps

 

 
LogRocket is a frontend logging tool that lets you replay problems as if they happened in your own browser. Instead of guessing why errors happen, or asking users for screenshots and log dumps, LogRocket lets you replay the session to quickly understand what went wrong. It works perfectly with any app, regardless of framework, and has plugins to log additional context from Redux, Vuex, and @ngrx/store.
 
In addition to logging Redux actions and state, LogRocket records console logs, JavaScript errors, stacktraces, network requests/responses with headers + bodies, browser metadata, and custom logs. It also instruments the DOM to record the HTML and CSS on the page, recreating pixel-perfect videos of even the most complex single-page apps.
 
Try it for free.

---

The post Hooks are coming to Vue.js version 3.0 appeared first on LogRocket Blog.

Comments

[Joe Strouth]

Things have progressed since vue-hooks was initially released. It's been inactive for most of this year.

To see how things are shaping up for Vue 3, check out the Composition API. Compared to react hooks: link

This new API is currently in an RFC stage, so feel free to chime in on the relevant Github issue or the #vue3-discussions channel on the official Vue Land discord server.

[pierresaid]

Will this not be redundant with the new composition Api : logic-extraction-and-reuse ?

example : mouse position tracking

import { ref, onMounted, onUnmounted } from 'vue'

export function useMousePosition() {
  const x = ref(0)
  const y = ref(0)

  function update(e) {
    x.value = e.pageX
    y.value = e.pageY
  }

  onMounted(() => {
    window.addEventListener('mousemove', update)
  })

  onUnmounted(() => {
    window.removeEventListener('mousemove', update)
  })

  return { x, y }
}

and then use it in a component

import { useMousePosition } from './mouse'

export default {
  setup() {
    const { x, y } = useMousePosition()
    // other logic...
    return { x, y }
  }
}

[Anton T]

What would you return from the Hooks method if you were planning on using multiple hooks? An array of hooks? Like
return [clickedHook(), otherHook()]

[pierresaid]

Something like that ?
return {...clickedHook(), ...otherHook()}