81 lines
3.2 KiB
TypeScript
81 lines
3.2 KiB
TypeScript
// Polymer legacy event helpers used courtesy of the Polymer project.
|
|
//
|
|
// Copyright (c) 2017 The Polymer Authors. All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are
|
|
// met:
|
|
//
|
|
// * Redistributions of source code must retain the above copyright
|
|
// notice, this list of conditions and the following disclaimer.
|
|
// * Redistributions in binary form must reproduce the above
|
|
// copyright notice, this list of conditions and the following disclaimer
|
|
// in the documentation and/or other materials provided with the
|
|
// distribution.
|
|
// * Neither the name of Google Inc. nor the names of its
|
|
// contributors may be used to endorse or promote products derived from
|
|
// this software without specific prior written permission.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
declare global {
|
|
// eslint-disable-next-line
|
|
interface HASSDomEvents {}
|
|
}
|
|
|
|
export type ValidHassDomEvent = keyof HASSDomEvents;
|
|
|
|
export interface HASSDomEvent<T> extends Event {
|
|
detail: T;
|
|
}
|
|
|
|
/**
|
|
* Dispatches a custom event with an optional detail value.
|
|
*
|
|
* @param {string} type Name of event type.
|
|
* @param {*=} detail Detail value containing event-specific
|
|
* payload.
|
|
* @param {{ bubbles: (boolean|undefined),
|
|
* cancelable: (boolean|undefined),
|
|
* composed: (boolean|undefined) }=}
|
|
* options Object specifying options. These may include:
|
|
* `bubbles` (boolean, defaults to `true`),
|
|
* `cancelable` (boolean, defaults to false), and
|
|
* `node` on which to fire the event (HTMLElement, defaults to `this`).
|
|
* @return {Event} The new event that was fired.
|
|
*/
|
|
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
|
|
export const fireEvent = <HassEvent extends ValidHassDomEvent>(
|
|
node: HTMLElement | Window,
|
|
type: HassEvent,
|
|
detail?: HASSDomEvents[HassEvent],
|
|
options?: {
|
|
bubbles?: boolean;
|
|
cancelable?: boolean;
|
|
composed?: boolean;
|
|
},
|
|
) => {
|
|
options = options || {};
|
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
// @ts-ignore
|
|
detail = detail === null || detail === undefined ? {} : detail;
|
|
const event = new Event(type, {
|
|
bubbles: options.bubbles === undefined ? true : options.bubbles,
|
|
cancelable: Boolean(options.cancelable),
|
|
composed: options.composed === undefined ? true : options.composed,
|
|
});
|
|
(event as any).detail = detail;
|
|
node.dispatchEvent(event);
|
|
return event;
|
|
};
|