Key modifiers for keyboard events in Vue

Introduction

Key modifiers help you easily handle specific keyboard keys in Vue events without extra code.

You want to run code only when the Enter key is pressed in an input box.

You want to detect when the Escape key is pressed to close a popup.

You want to listen for arrow keys to move a selection up or down.

You want to prevent default browser actions on certain keys like Tab.

You want to combine keys like Ctrl + S to save data.

Syntax

Vue

<element @keydown.keyModifier="handlerFunction"></element>

Replace keyModifier with the key name like enter, esc, tab, etc.

You can chain modifiers like @keydown.ctrl.enter for Ctrl + Enter.

Examples

Calls submitForm only when Enter is pressed.

Vue

<input @keydown.enter="submitForm" />

Calls closePopup when Escape key is pressed.

Vue

<div @keydown.esc="closePopup"></div>

Calls saveData when Ctrl + S is pressed and prevents default browser save dialog.

Vue

<input @keydown.ctrl.s.prevent="saveData" />

Sample Program

This Vue component listens for Enter and Escape keys on the input. It updates the message below based on which key is pressed.

Vue

<template>
  <div>
    <input
      type="text"
      placeholder="Type and press Enter"
      @keydown.enter="onEnter"
      @keydown.esc="onEscape"
    />
    <p>{{ message }}</p>
  </div>
</template>

<script setup>
import { ref } from 'vue'

const message = ref('')

function onEnter() {
  message.value = 'You pressed Enter!'
}

function onEscape() {
  message.value = 'You pressed Escape!'
}
</script>

Important Notes

Key names are case-insensitive and use lowercase in Vue.

Use .prevent modifier to stop default browser actions.

You can combine multiple key modifiers for complex shortcuts.

Summary

Key modifiers let you handle specific keys easily in Vue events.

Use them to run code only on keys like Enter, Escape, or combinations.

They keep your code clean and simple for keyboard interactions.

Practice

1. What does the Vue key modifier @keyup.enter do in a template?

easy

A. It triggers the event handler only when the Enter key is released.

B. It triggers the event handler on any key press.

C. It triggers the event handler only when the Escape key is pressed.

D. It triggers the event handler when the mouse is clicked.

Solution

1. Step 1: Understand the key modifier syntax

   The @keyup.enter listens for the keyup event but only activates if the Enter key was released.

2. Step 2: Compare with other keys and events

   Other keys like Escape or mouse clicks are not triggered by this modifier.

3. Final Answer:

   It triggers the event handler only when the Enter key is released. -> Option A

4. Quick Check:

   Key modifier .enter = Enter key only [OK]

Hint: Key modifiers match specific keys like .enter for Enter key [OK]

Common Mistakes:

• Confusing keyup with keydown events
• Thinking it triggers on any key press
• Mixing Enter with Escape key

2. Which of the following is the correct Vue syntax to listen for the Escape key on a keydown event?

easy

A. @keydown.escKey

B. @keydown.escape

C. @keydown.Escape

D. @keydown.esc

Solution

1. Step 1: Recall Vue key modifier names

   Vue uses .esc as the official key modifier for the Escape key.

2. Step 2: Check syntax correctness

   The correct syntax is lowercase @keydown.esc. Other variants like .escape or capitalized forms are invalid.

3. Final Answer:

   @keydown.esc -> Option D

4. Quick Check:

   Escape key modifier = .esc [OK]

Hint: Use official Vue key names like .esc, not full words [OK]

Common Mistakes:

• Using .escape instead of .esc
• Capitalizing key modifiers
• Adding extra words like .escKey

3. Given this Vue template code:

<input @keydown.ctrl.enter="submit" />

What happens when the user presses Ctrl + Enter?

medium

A. The submit method is called on any Ctrl key press.

B. The submit method is called on any Enter key press.

C. The submit method is called only if Ctrl and Enter are pressed together.

D. The submit method is never called because the syntax is invalid.

Solution

1. Step 1: Understand combined key modifiers

   The @keydown.ctrl.enter listens for the Enter key pressed while Ctrl is held down.

2. Step 2: Confirm event triggering condition

   The method triggers only when both Ctrl and Enter keys are pressed simultaneously, not separately.

3. Final Answer:

   The submit method is called only if Ctrl and Enter are pressed together. -> Option C

4. Quick Check:

   Combined keys like .ctrl.enter require both keys pressed [OK]

Hint: Multiple key modifiers mean all keys must be pressed together [OK]

Common Mistakes:

• Thinking it triggers on Enter alone
• Assuming Ctrl alone triggers it
• Believing syntax is invalid

4. Identify the error in this Vue event listener:

<input @keyup.shift.enter="submit" />

medium

A. The event should be @keydown, not @keyup for Shift + Enter.

B. There is no error; this syntax is valid.

C. The correct modifier is .enter.shift, order matters.

D. The key modifier .shift.enter is invalid; modifiers must be separated by dots.

Solution

1. Step 1: Check Vue key modifier chaining rules

   Vue allows chaining multiple key modifiers separated by dots in any order, so .shift.enter is valid.

2. Step 2: Confirm event type and usage

   Using @keyup with .shift.enter is valid and triggers when Shift and Enter are released together.

3. Final Answer:

   There is no error; this syntax is valid. -> Option B

4. Quick Check:

   Multiple key modifiers chained with dots are valid [OK]

Hint: Order of key modifiers does not matter; chaining with dots is correct [OK]

Common Mistakes:

• Thinking modifier order matters
• Confusing keyup and keydown necessity
• Assuming .shift.enter is invalid

5. You want to trigger a method only when the user presses Ctrl + Shift + S to save a form. Which Vue event listener is correct?

hard

A. @keydown.ctrl.shift.s="saveForm"

B. @keydown.shift.ctrl.s="saveForm"

C. @keydown.s.ctrl.shift="saveForm"

D. @keydown.save.ctrl.shift="saveForm"

Solution

1. Step 1: Understand key modifier chaining

   Vue allows chaining key modifiers in any order, but the key itself must be last, so .ctrl.shift.s is correct.

2. Step 2: Validate each option

   @keydown.ctrl.shift.s="saveForm" correctly places the key s last. @keydown.s.ctrl.shift="saveForm" places the key in the middle, which is invalid. @keydown.save.ctrl.shift="saveForm" uses a non-existent modifier .save.

3. Step 3: Choose the best standard syntax

   @keydown.ctrl.shift.s="saveForm" is the most standard and clear syntax.

4. Final Answer:

   @keydown.ctrl.shift.s="saveForm" -> Option A

5. Quick Check:

   Key modifiers chain with keys last; .ctrl.shift.s is correct [OK]

Hint: Put the key last, modifiers before it chained by dots [OK]

Common Mistakes:

• Placing the key before modifiers
• Using non-existent modifiers like .save
• Assuming modifier order matters strictly