GithubHelp home page GithubHelp logo

Comments (2)

justinfagnani avatar justinfagnani commented on May 30, 2024 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.

matthewp avatar matthewp commented on May 30, 2024

Prefer Event subclasses over CustomElement

First I've heard of this, what's the reason?

from community-protocols.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.