Skip to content

fix: correct terms and restore the lost option in dispatch-events article.md en #3931

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
front42 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: correct terms and restore the lost option in dispatch-events article.md en #3931

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
8 changes: 5 additions & 3 deletions 2-ui/2-events/05-dispatch-events/article.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@ let event = new Event(type[, options]);
Arguments:

- *type* -- event type, a string like `"click"` or our own like `"my-event"`.
- *options* -- the object with two optional properties:
- *options* -- the object with three optional properties:
- `bubbles: true/false` -- if `true`, then the event bubbles.
- `cancelable: true/false` -- if `true`, then the "default action" may be prevented. Later we'll see what it means for custom events.
- `composed: true/false` -- if `true`, then the event will trigger listeners outside of a shadow root, exiting the Shadow DOM. Later we’ll cover this in [Web Components](https://javascript.info/shadow-dom-events#event-composed) section.

By default both are false: `{bubbles: false, cancelable: false}`.
By default all three are **false**: `{bubbles: false, cancelable: false, composed: false}`.

## dispatchEvent

Expand Down Expand Up @@ -274,9 +275,10 @@ The output order becomes: 1 -> 2 -> nested.

To generate an event from code, we first need to create an event object.

The generic `Event(name, options)` constructor accepts an arbitrary event name and the `options` object with two properties:
The generic `Event(type[, options])` constructor accepts a required `type` parameter -- a string that specifies the event name (type), and an optional `options` object with three properties (all false by default):
- `bubbles: true` if the event should bubble.
- `cancelable: true` if the `event.preventDefault()` should work.
- `composed: true` if the event should exit the Shadow DOM, becoming available to listeners outside of a shadow root.

Other constructors of native events like `MouseEvent`, `KeyboardEvent` and so on accept properties specific to that event type. For instance, `clientX` for mouse events.

Expand Down