Directive with arguments and modifiers in Vue - Mini Project: Build & Apply

Using Vue Directive with Arguments and Modifiers

📖 Scenario: You are building a simple Vue 3 app that changes the background color of a box when you click it. You want to use a custom directive that accepts an argument for the event type and a modifier to control if the event should be captured during the capture phase.

🎯 Goal: Create a Vue 3 component that uses a custom directive with an argument and a modifier to change the background color of a box when clicked. The directive should listen to the event type passed as an argument and respect the capture modifier.

📋 What You'll Learn

Create a Vue 3 component with a <div> box

Define a custom directive called color-change

Use an argument click for the event type in the directive

Use a modifier capture to enable event capturing

Change the box background color to lightblue when the event triggers

💡 Why This Matters

🌍 Real World

Custom directives with arguments and modifiers help you create reusable, flexible behaviors in Vue apps, like handling different events with options.

💼 Career

Understanding Vue directives is important for frontend developers working with Vue to build interactive and maintainable user interfaces.

1

Set up the Vue component with a box

Create a Vue 3 component with a <template> containing a <div> with id="colorBox" and text "Click me".

Vue

  



// Your code here

Hint

Use a <div> with id="colorBox" inside the <template>.

2

Add a config variable for the color

Inside the <script setup>, create a constant called color and set it to the string 'lightblue'.

Vue

  Click me



// Create a constant called color with value 'lightblue'
// Your code here

Hint

Use const color = 'lightblue' inside <script setup>.

3

Create the custom directive with argument and modifier

Inside <script setup>, define a custom directive called colorChange that listens to the event type passed as binding.arg and uses the capture modifier from binding.modifiers. When the event triggers, change the element's background color to the color constant.

Vue

  Click me



const color = 'lightblue'
// Define the colorChange directive here
// Your code here

Hint

Use binding.arg for the event type and binding.modifiers.capture for the capture option in addEventListener.

4

Use the directive with argument and modifier on the box

In the <template>, add the directive v-color-change:click.capture to the div with id="colorBox". Also, register the directive in the component by adding directives={{ 'color-change': colorChange }} to the <script setup> export.

Vue

  Click me



const color = 'lightblue'

const colorChange = {
  mounted(el, binding) {
    const eventType = binding.arg
    const useCapture = !!binding.modifiers.capture
    el.addEventListener(eventType, () => {
      el.style.backgroundColor = color
    }, useCapture)
  }
}

// Register the directive here
// Your code here

Hint

Add v-color-change:click.capture to the div and register the directive using defineExpose with directives.

Practice

1. In Vue, what does a directive argument specify?
v-bind:title uses title as an argument. What does it do?

easy

A. It adds a CSS class to the element.

B. It changes the directive into a different directive.

C. It tells the directive which attribute or property to target.

D. It defines a new event listener.

Solution

1. Step 1: Understand directive arguments

   Directive arguments specify what part of the element the directive should affect, like an attribute or property.

2. Step 2: Analyze v-bind:title

   Here, title is the argument telling v-bind to bind the value to the element's title attribute.

3. Final Answer:

   It tells the directive which attribute or property to target. -> Option C

4. Quick Check:

   Directive argument = target attribute/property [OK]

Hint: Arguments specify target attribute/property in directives [OK]

Common Mistakes:

• Thinking arguments change directive type
• Confusing arguments with modifiers
• Assuming arguments add CSS classes

2. Which of the following is the correct syntax to use a modifier with a directive argument in Vue?
v-on:click.prevent is an example. Which is correct?

easy

A. v-on:click.prevent

B. v-on.prevent:click

C. v-on:prevent.click

D. v-on:click.prevent()

Solution

1. Step 1: Recall Vue directive syntax

   In Vue, modifiers come after the argument, separated by dots, e.g., v-on:click.prevent.

2. Step 2: Check each option

   v-on:click.prevent matches the correct pattern: directive, colon, argument, dot, modifier. Others mix order or add parentheses incorrectly.

3. Final Answer:

   v-on:click.prevent -> Option A

4. Quick Check:

   Modifiers follow arguments with dots [OK]

Hint: Modifiers come after arguments, separated by dots [OK]

Common Mistakes:

• Placing modifiers before arguments
• Using parentheses with modifiers
• Switching order of argument and modifier

3. What will be the effect of this Vue directive?

<button v-on:click.once.prevent="submit">Submit</button>

medium

A. The submit method runs every click and does not prevent default event.

B. The submit method runs every click and prevents default event.

C. The submit method runs once but does not prevent default event.

D. The submit method runs once on click and prevents default event.

Solution

1. Step 1: Understand modifiers .once and .prevent

   .once makes the event handler run only once. .prevent calls event.preventDefault() to stop default browser behavior.

2. Step 2: Analyze the directive behavior

   The button's click triggers submit only once and prevents default action each time.

3. Final Answer:

   The submit method runs once on click and prevents default event. -> Option D

4. Quick Check:

   .once + .prevent = run once + prevent default [OK]

Hint: Modifiers chain to combine behaviors like once and prevent [OK]

Common Mistakes:

• Ignoring the effect of .once modifier
• Confusing .prevent with .stop
• Assuming method runs multiple times

4. Identify the error in this Vue directive usage:

<input v-model.trim.lazy="username">

medium

A. The directive should be v-model:trim.lazy with an argument.

B. The syntax is correct; no error present.

C. Modifiers .trim and .lazy cannot be used together on v-model.

D. Modifiers must be separated by commas, like .trim,.lazy.

Solution

1. Step 1: Check Vue documentation for v-model modifiers

   Vue allows chaining modifiers like .trim and .lazy on v-model to trim input and update on change.

2. Step 2: Validate syntax correctness

   The syntax v-model.trim.lazy is valid and commonly used. No argument is needed here.

3. Final Answer:

   The syntax is correct; no error present. -> Option B

4. Quick Check:

   Multiple modifiers can chain on v-model [OK]

Hint: Modifiers chain with dots, no commas needed [OK]

Common Mistakes:

• Thinking modifiers need commas
• Assuming arguments are required for modifiers
• Believing some modifiers can't combine

5. You want to create a custom directive v-focus that focuses an input only once when inserted, and you want to pass an argument to specify the delay in milliseconds. Which is the correct way to use arguments and modifiers to achieve this?

<input v-focus:delay.once="500">

hard

A. Use argument delay for delay and modifier .once to focus once.

B. Use modifier .delay for delay and argument once to focus once.

C. Arguments and modifiers cannot be combined in custom directives.

D. Use v-focus.once:delay="500" to apply once and delay.

Solution

1. Step 1: Understand argument and modifier roles

   Arguments specify extra data like 'delay' to the directive. Modifiers like .once change behavior, here to run focus only once.

2. Step 2: Analyze the directive usage

   v-focus:delay.once="500" correctly uses 'delay' as argument and '.once' as modifier. The value '500' is passed as delay time.

3. Final Answer:

   Use argument delay for delay and modifier .once to focus once. -> Option A

4. Quick Check:

   Argument = data, modifier = behavior change [OK]

Hint: Arguments pass data, modifiers change behavior [OK]

Common Mistakes:

• Swapping argument and modifier positions
• Thinking they can't be combined
• Using modifiers as arguments