Skip to content

Commit

Permalink
feat: mention that the user can change the placement of the dev toolb…
Browse files Browse the repository at this point in the history
…ar (#7720)

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
  • Loading branch information
mingjunlu and sarah11918 authored Apr 10, 2024
1 parent 0910fd8 commit 2c4ae4a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
2 changes: 1 addition & 1 deletion src/content/docs/en/guides/dev-toolbar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The dev toolbar aims to provide a quick and easy way to catch common issues duri

### Settings

The Settings app allows you to toggle different settings for the development toolbar, such as verbose logging, and the ability to disable notifications.
The Settings app allows you to configure options for the development toolbar, such as verbose logging, disabling notifications, and adjusting its placement on your screen.

## Extending the dev toolbar

Expand Down
15 changes: 15 additions & 0 deletions src/content/docs/en/reference/dev-toolbar-app-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,21 @@ This event is fired when the user clicks on the app icon in the Dev Toolbar.
}
```

### `placement-updated`

This event is fired when the user changes the placement of the Dev Toolbar.

```ts title="src/my-app.js" {4-6}
export default {
// ...
init(canvas, eventTarget) {
eventTarget.addEventListener('placement-updated', (event) => {
console.log(`Placement set to ${event.detail.placement}`);
})
}
}
```

#### `state: boolean`

Indicates whether or not the app is enabled after the user's click.
Expand Down

0 comments on commit 2c4ae4a

Please sign in to comment.