Comments (2)
CustomEvent would have been completely unnecessary if Event had been subclassable earlier. At this point it's just a quirk of web development's history.
But the big problem with CustomEvents is that the event dispatcher creates the event, its data and options, which leaves a lot of room for divergence and incompatibilities. You can overcome some of this with a factory function to ensure the events are created consistently, but then you're very close to an Event subclass anyway.
These are the things you want to specify in a protocol and make hard to deviate from in an implementation:
- Event name
- Options: bubble, cancelable, composed
- Properties
In an event subclass you can do this all in the constructor. You can also specify the whole API of the Event, not just the details object, and the ergonomics of creating and using events are better without having to use or think about the detail object. You also have a class that you can hang documentation on.
Defining an event is more verbose than not defining an event, but it's straightforward and declares the intention of the event. We'd have to specify this information for CustomEvents used in a protocol anyway, it'd just be a lot more ad-hoc:
/**
* The `my-event` event represents something that happened.
* We can document it here.
*/
export class MyEvent extends Event {
static eventName = 'my-event';
/** We can easily document properties */
foo;
/**
* You can add properties over time without breaking.
* If we used CustomEvent we'd have to advise that detail is always an object
*/
bar;
constructor(foo, bar) {
// Since these are hard-coded, dispatchers can't get them wrong
super(MyEvent.eventName, {bubbles: true, cancelable: true, composed: true});
// users are forced to provide parameters. You can do validation here you can't do with
// detail objects
this.foo = foo;
this.bar = bar;
}
}
Dispatching events is easier and safer. You don't have to know the event name or options, just the constructor signature. It mirrors built-in event usage too.
this.dispatchEvent(new MyEvent(foo, bar));
from community-protocols.
Prefer Event subclasses over CustomElement
First I've heard of this, what's the reason?
from community-protocols.
Related Issues (20)
- [pending-task] Should PendingTaskEvent have a `type` field? HOT 2
- [defer-hydration] Controlling hydration with the "defer-hydration" attribute
- Runtime agnostic web components HOT 5
- Proposal: Well-known symbol for DOM shim HOT 1
- [context] are context objects needed? HOT 36
- [context] do providers retain references to consuming components? HOT 11
- [context] improve naming of dispose and multiple arguments HOT 1
- [context] supporting cases where provider is defined after consumer HOT 11
- Proposal: Reactive controllers protocol HOT 4
- Support versioning of Web Components HOT 4
- [progressive-hydration] conditions for first level hydration timing HOT 12
- [pending-task] Cancellation mechanism HOT 1
- [progressive hydration] self hydrating custom elements HOT 4
- Compatibility and Interop Specification (Versioning WCs) HOT 4
- [context] Do we *need* `multiple` and `dispose()`? HOT 5
- [defer-hydration] Requesting hydration of a disconnected component HOT 7
- [context] Fully event driven context protocol HOT 7
- [context] Event namespace HOT 8
- IndexedDB Observer / Event protocol HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from community-protocols.