@mbolli/datastar-attribute-on-keys

A Datastar plugin that provides keyboard event binding with support for key combinations and multiple keys.

About

Datastar is a hypermedia-focused framework that brings reactive signals and declarative DOM manipulation to your HTML. While it includes great event handling, this plugin extends keyboard event capabilities to support:

• Key combinations (e.g., Alt-Q, Ctrl-Shift-S)
• Multiple key bindings (e.g., Escape.Enter to trigger on either key)

Installation

npm install @mbolli/datastar-attribute-on-keys

Demo

View Interactive Demo →

Usage

This plugin requires an import map to resolve the datastar module. Set up your HTML like this:

<script type="importmap">
{
  "imports": {
    "datastar": "https://cdn.jsdelivr.net/gh/starfederation/[email protected]/bundles/datastar.js"
  }
}
</script>
<script type="module">
  // Import the plugin - it will auto-register with datastar
  import 'https://cdn.jsdelivr.net/npm/@mbolli/datastar-attribute-on-keys@1/dist/index.js';
</script>

Note: Using @1 will automatically use the latest v1.x.x version.

What it does

This plugin adds an on-keys attribute to Datastar that allows you to bind keyboard events to reactive actions.

Single Key Binding

<div data-on-keys:escape="$modal.close()">
  <!-- Triggers when Escape key is pressed -->
</div>

Key Combinations

<div data-on-keys:alt-q="$app.quit()">
  <!-- Triggers when Alt+Q is pressed -->
</div>

<div data-on-keys:ctrl-shift-s="$document.save()">
  <!-- Triggers when Ctrl+Shift+S is pressed -->
</div>

Multiple Keys

<div data-on-keys:escape.enter="$dialog.close()">
  <!-- Triggers when either Escape OR Enter is pressed -->
</div>

<div data-on-keys:space.enter.alt-q="$action.execute()">
  <!-- Triggers on Space, Enter, or Alt+Q -->
</div>

Global Events (Default)

By default, key events are listened for globally on the window:

<div data-on-keys:escape="$modal.close()">
  <!-- Listens for Escape key globally -->
</div>

Element-Specific Events

Use the el modifier to listen only when the element has focus:

<input data-on-keys:enter__el="$form.submit()">
  <!-- Only triggers when this input is focused -->
</input>

Event Modifiers

The plugin supports several modifiers:

• el - Listen on the element instead of window (requires focus)
• noprevent - Allow default browser behavior (default prevents)
• stop - Call stopPropagation() on the event
• up - Listen for keyup instead of keydown (default)
• capture - Use capture phase
• passive - Use passive event listener
• once - Only trigger once

<div data-on-keys:tab__noprevent="$counter++">
  <!-- Count tab presses but still allow tab navigation -->
</div>

Supported Key Names

Key Name Mapping

Common key aliases are automatically mapped to standard JavaScript key names:

Special Keys:

• space → Space character
• enter / return → Enter
• escape / esc → Escape
• tab → Tab
• backspace → Backspace
• delete / del → Delete

Navigation Keys:

• up → ArrowUp
• down → ArrowDown
• left → ArrowLeft
• right → ArrowRight
• pageup → PageUp
• pagedown → PageDown

Other Keys:

• Letters: a, b, c, etc.
• Numbers: 1, 2, 3, etc.
• Function keys: f1, f2, etc. → F1, F2, etc.
• Modifiers: ctrl/control, alt, shift, meta/cmd/command

Examples

Modal with Escape Key

<div class="modal" data-on-keys:escape="$modal.close()">
  <!-- Modal content -->
</div>

Counter with Space Bar

<div data-on-keys:space="$counter++">
  Count: <span data-text="$counter"></span>
</div>

Keyboard Shortcuts

<div data-on-keys:ctrl-s="$document.save()">
  <!-- Ctrl+S to save - global and prevents browser save dialog -->
</div>
<div data-on-keys:ctrl-z="$document.undo()">
  <!-- Ctrl+Z to undo - global and prevents browser undo -->
</div>

Testing

Run the automated tests:

pnpm test

Or open index.html locally in a browser to interactively test the plugin with Datastar.

Development & Releases

This project uses automated releases via GitHub Actions. When you push to main:

1. Tests run automatically - Build and tests must pass
2. Version bumping - Add to your commit message:
   • [major] for breaking changes (1.0.0 → 2.0.0)
   • [minor] for new features (1.0.0 → 1.1.0)
   • Default: patch for bug fixes (1.0.0 → 1.0.1)
3. Automatic publishing - Package is published to npm
4. GitHub Release created - With auto-generated release notes

License

MIT