Emit events with unique, typed names from common input elements

Published on webcomponents.org

<xtal-in>

<xtal-in> is a vanilla-ish custom element that generates events with semantically meaningful, and even unique, discoverable event names.

The -in- in xtal-in- refers to an "input channel" -- which can be a clickable dom element, for example, or more abstract things like attributes changing.

In the groundbreaking blog post "Custom Elements That Work Anywhere", Rob Dodson blegs:

In general, don't bubble events unless they are semantically meaningful. For example, changed is not a very semantically meaningful event, whereas document-opened would be. Non-semantic events can leak up and another element may accidentally handle them.

Adding an event listener to an element, whose sole purpose is to bubble the event up with a different name, is a rather insulting task for the powerful and sophisticated JavaScript language to handle. JavaScript should only be bothered with important stuff, like reinventing the browser in an immutable abstraction layer that can time travel recursively.

<xtal-in></xtal-in>

<div>
...
<button data-dispatch-on="click: type:wtf bubbles composed noblock">How did I get here?</button>
...
</div>
<script>
document.body.addEventListener('wtf', e =>{
    alert('Same as it ever was');
})
</script>

By default, xtal-in blocks the original event from propagating is optional, and prevents the event from propagating. Adding "noblock" allows the original event to propagate normally. Note that we specify whether this new semantically meaningful event should bubble and/or escape the shadow DOM cocoon ("composed")

You can also specify a test on the element spawning the event, using the if-matches attribute, which uses matches() under the hood:

<div data-dispatch-on="
    click: if(#talkingButton) type:¯\_(ツ)_/¯ bubbles composed
    input: if(#large_automobile) type:behind-the-wheel
">

...

<button id="talkingButton">My God! What have I done?</button>
<input type="text" id="large_automobile">
...
</div>

Monitoring Attribute Changes

In addition to listening for click or input events, one can listen for attribute change events:

<david-byrne beautiful-wife="Adelle Lutz" data-dispatch-on-attr-change="beautiful-wife: type:once-in-a-lifetime"></david-byrne>

Install the Polymer-CLI

First, make sure you have the Polymer CLI installed. Then run polymer serve to serve your element locally.

Viewing Your Element

$ polymer serve

Running Tests

WIP

Install

Link to this version
ImportedReleased 27 November 2017MIT License
Framework Support
Browser Independent
Install with
npm install xtal-in"@0.0.8"
Run the above npm command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 0.0.8

Dependencies

  • @bower_components/accessibility-developer-tools#GoogleChrome/accessibility-developer-tools#^2.10.0
  • @bower_components/async#caolan/async#^1.5.0
  • @bower_components/chai#chaijs/chai#^3.2.0
  • @bower_components/font-roboto#PolymerElements/font-roboto#^1
  • @bower_components/iron-demo-helpers#PolymerElements/iron-demo-helpers#^2.0.0
  • @bower_components/iron-flex-layout#polymerelements/iron-flex-layout#1 - 2
  • @bower_components/iron-location#PolymerElements/iron-location#1 - 2
  • @bower_components/lodash#lodash/lodash#^3.7.0
  • @bower_components/marked#chjj/marked#~0.3.6
  • @bower_components/marked-element#polymerelements/marked-element#1 - 2
  • @bower_components/mocha#mochajs/mocha#^3.1.2
  • @bower_components/poly-prep#bahrus/poly-prep#^0.0.9
  • @bower_components/polymer#Polymer/polymer#^2.0.0
  • @bower_components/prism#LeaVerou/prism#*
  • @bower_components/prism-element#PolymerElements/prism-element#1 - 2
  • @bower_components/shadycss#webcomponents/shadycss#^v1.0.0
  • @bower_components/sinon-chai#domenic/sinon-chai#^2.7.0
  • @bower_components/sinonjs#blittle/sinon.js#^1.14.1
  • @bower_components/stacky#PolymerLabs/stacky#^1.3.0
  • @bower_components/test-fixture#polymerelements/test-fixture#^3.0.0-rc.1
  • @bower_components/web-component-tester#Polymer/web-component-tester#^6.0.0
  • @bower_components/webcomponentsjs#webcomponents/webcomponentsjs#^1.0.0
  • fs-extra#^4.0.2