Skip to content

Add an example for custom key mappings #850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pdx91 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add an example for custom key mappings #850

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion docs/reference/actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,25 @@ import { Application, defaultSchema } from "@hotwired/stimulus"

const customSchema = {
...defaultSchema,
keyMappings: { ...defaultSchema.keyMappings, at: "@" },
keyMappings: {
...defaultSchema.keyMappings,
at: "@",
slash: "/",
question: "?"
},
Comment on lines +109 to +114
Copy link
Copy Markdown

@MatheusRich MatheusRich Jul 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO this doesn't add much. The example below could use the existing at mapping.

}

const app = Application.start(document.documentElement, customSchema)
```

Then use them in your action descriptors:

```html
<div data-controller="search"
data-action="keydown.slash->search#focus keydown.question->search#showHelp">
</div>
Comment on lines +123 to +125
Copy link
Copy Markdown

@MatheusRich MatheusRich Jul 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<div data-controller="search"
data-action="keydown.slash->search#focus keydown.question->search#showHelp">
</div>
<div data-controller="mentions"
data-action="keydown.at->mentions#displaySuggestions"></div>

html

If you want to subscribe to a compound filter using a modifier key, you can write it like `ctrl+a`.

```html
Expand Down