Skip to content

Docs: Document Missing Key Modifiers (.esc, .space, .tab, .delete) in Event Handling Guide #682

Description

@nathanschmid08

Category

Documentation

Description

The Actions & Event Handling concept guide (events.md) describes event modifiers and details .enter and .escape for key filtering. However, the framework's event binder (lib/core/events/bindEvents.js) also supports several other key modifiers: .esc, .space, .tab, and .delete. These are currently undocumented.

Proposed Solution

Update docs/src/content/docs/core-concepts/events.md:

  • Add the undocumented key modifiers to the event modifiers table and descriptions:
    • .esc: Alias for .escape.
    • .space: Filters for Space (' ').
    • .tab: Filters for the Tab key.
    • .delete: Filters for the Delete key.
  • Provide examples showing usage of these new filters (e.g., @keydown.space="togglePlay", @keydown.tab.prevent="focusNext").

Acceptance Criteria

  • The modifiers table in events.md includes .esc, .space, .tab, and .delete.
  • Clear descriptions specify the event keys they filter.
  • Code examples demonstrate chaining or combining these modifiers.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomers

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions