prefer-keyboard-event-key.md

prefer-keyboard-event-key

📝 Prefer KeyboardEvent#key over KeyboardEvent#keyCode.

💼 This rule is enabled in the following configs: ✅ recommended, ☑️ unopinionated.

🔧 This rule is automatically fixable by the --fix CLI option.

Enforces the use of KeyboardEvent#key over KeyboardEvent#keyCode which is deprecated. The .key property is also more semantic and readable.

This rule is partly fixable. It can only fix direct property access.

Examples

// ❌
window.addEventListener('keydown', event => {
	if (event.keyCode === 8) {
		console.log('Backspace was pressed');
	}
});

// ✅
window.addEventListener('keydown', event => {
	if (event.key === 'Backspace') {
		console.log('Backspace was pressed');
	}
});

// ❌
window.addEventListener('keydown', event => {
	console.log(event.keyCode);
});

// ✅
window.addEventListener('click', event => {
	console.log(event.key);
});