Skip to content

fix: Prevent premature keydown interruptions during actions tutorial #1168

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

Closed
wants to merge 2 commits into from
Closed

fix: Prevent premature keydown interruptions during actions tutorial #1168

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0af7878
Update 01-actions instructions to hook up 'use:trapFocus' at the end
spacepumpkin Feb 24, 2025
ab317ea
Merge branch 'main' into spacepumpkin/issue-700-fix-actions-tutorial
spacepumpkin Mar 26, 2025
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
46 changes: 24 additions & 22 deletions apps/svelte.dev/content/tutorial/01-svelte/08-actions/01-actions/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,7 @@ Actions are essentially element-level lifecycle functions. They're useful for th

In this app, you can scribble on the `<canvas>`, and change colours and brush size via the menu. But if you open the menu and cycle through the options with the Tab key, you'll soon find that the focus isn't _trapped_ inside the modal.

We can fix that with an action. Import `trapFocus` from `actions.svelte.js`...

```svelte
/// file: App.svelte
<script>
import Canvas from './Canvas.svelte';
+++import { trapFocus } from './actions.svelte.js';+++

const colors = ['red', 'orange', 'yellow', 'green', 'blue', 'indigo', 'violet', 'white', 'black'];

let selected = $state(colors[0]);
let size = $state(10);
let showMenu = $state(true);
</script>
```

...then add it to the menu with the `use:` directive:

```svelte
/// file: App.svelte
<div class="menu" +++use:trapFocus+++>
```
We can fix that with an action.

Let's take a look at the `trapFocus` function in `actions.svelte.js`. An action function is called with a `node` — the `<div class="menu">` in our case — when the node is mounted to the DOM. Inside the action, we have an [effect](effects).

Expand Down Expand Up @@ -61,4 +40,27 @@ $effect(() => {
});
```

Back in `App.svelte`, import `trapFocus` from `actions.svelte.js`...

```svelte
/// file: App.svelte
<script>
import Canvas from './Canvas.svelte';
+++import { trapFocus } from './actions.svelte.js';+++

const colors = ['red', 'orange', 'yellow', 'green', 'blue', 'indigo', 'violet', 'white', 'black'];

let selected = $state(colors[0]);
let size = $state(10);
let showMenu = $state(true);
</script>
```

...then add it to the menu with the `use:` directive:

```svelte
/// file: App.svelte
<div class="menu" +++use:trapFocus+++>
```

Now, when you open the menu, you can cycle through the options with the Tab key.