@polymer/polymer/types/lib/legacy/polymer.dom.d.ts

The Polymer library makes it easy to create your own web components. Give your element some markup and properties, and then use it on a site. Polymer provides features like dynamic templates and data binding to reduce the amount of boilerplate you need to

/**
 * DO NOT EDIT
 *
 * This file was automatically generated by
 *   https://github.com/Polymer/tools/tree/master/packages/gen-typescript-declarations
 *
 * To modify these typings, edit the source file(s):
 *   lib/legacy/polymer.dom.html
 */


// tslint:disable:variable-name Describing an API that's defined elsewhere.
// tslint:disable:no-any describes the API as best we are able today

/// <reference path="../utils/boot.d.ts" />
/// <reference path="../utils/settings.d.ts" />
/// <reference path="../utils/flattened-nodes-observer.d.ts" />
/// <reference path="../utils/flush.d.ts" />

declare namespace Polymer {

  /**
   * Legacy DOM and Event manipulation API wrapper factory used to abstract
   * differences between native Shadow DOM and "Shady DOM" when polyfilling on
   * older browsers.
   *
   * Note that in Polymer 2.x use of `Polymer.dom` is no longer required and
   * in the majority of cases simply facades directly to the standard native
   * API.
   */
  namespace dom {


    /**
     * Cross-platform `element.matches` shim.
     *
     * @returns True if node matched selector
     */
    function matchesSelector(node: Node, selector: string): boolean;
  }

  /**
   * Node API wrapper class returned from `Polymer.dom.(target)` when
   * `target` is a `Node`.
   */
  class DomApi {

    /**
     * For shadow roots, returns the currently focused element within this
     * shadow root.
     */
    readonly activeElement: Node|null|undefined;

    /**
     * @param node Node for which to create a Polymer.dom helper object.
     */
    constructor(node: Node|null);

    /**
     * Returns an instance of `Polymer.FlattenedNodesObserver` that
     * listens for node changes on this element.
     *
     * @param callback Called when direct or distributed children
     *   of this element changes
     * @returns Observer instance
     */
    observeNodes(callback: (p0: _Element, p1: {target: _Element, addedNodes: _Element[], removedNodes: _Element[]}) => void): Polymer.FlattenedNodesObserver;

    /**
     * Disconnects an observer previously created via `observeNodes`
     *
     * @param observerHandle Observer instance
     *   to disconnect.
     */
    unobserveNodes(observerHandle: Polymer.FlattenedNodesObserver): void;

    /**
     * Provided as a backwards-compatible API only.  This method does nothing.
     */
    notifyObserver(): void;

    /**
     * Returns true if the provided node is contained with this element's
     * light-DOM children or shadow root, including any nested shadow roots
     * of children therein.
     *
     * @param node Node to test
     * @returns Returns true if the given `node` is contained within
     *   this element's light or shadow DOM.
     */
    deepContains(node: Node|null): boolean;

    /**
     * Returns the root node of this node.  Equivalent to `getRoodNode()`.
     *
     * @returns Top most element in the dom tree in which the node
     * exists. If the node is connected to a document this is either a
     * shadowRoot or the document; otherwise, it may be the node
     * itself or a node or document fragment containing it.
     */
    getOwnerRoot(): Node|null;

    /**
     * For slot elements, returns the nodes assigned to the slot; otherwise
     * an empty array. It is equivalent to `<slot>.addignedNodes({flatten:true})`.
     *
     * @returns Array of assigned nodes
     */
    getDistributedNodes(): Node[];

    /**
     * Returns an array of all slots this element was distributed to.
     *
     * @returns Description
     */
    getDestinationInsertionPoints(): HTMLSlotElement[];

    /**
     * Calls `importNode` on the `ownerDocument` for this node.
     *
     * @param node Node to import
     * @param deep True if the node should be cloned deeply during
     *   import
     * @returns Clone of given node imported to this owner document
     */
    importNode(node: Node, deep: boolean): Node|null;

    /**
     * @returns Returns a flattened list of all child nodes and
     * nodes assigned to child slots.
     */
    getEffectiveChildNodes(): Node[];

    /**
     * Returns a filtered list of flattened child elements for this element based
     * on the given selector.
     *
     * @param selector Selector to filter nodes against
     * @returns List of flattened child elements
     */
    queryDistributedElements(selector: string): HTMLElement[];
    cloneNode(deep?: boolean): Node;
    appendChild(node: Node): Node;
    insertBefore(newChild: Node, refChild: Node|null): Node;
    removeChild(node: Node): Node;
    replaceChild(oldChild: Node, newChild: Node): Node;
    setAttribute(name: string, value: string): void;
    removeAttribute(name: string): void;
    querySelector(selector: string): _Element|null;
    querySelectorAll(selector: string): NodeListOf<_Element>;
  }


  /**
   * Legacy DOM and Event manipulation API wrapper factory used to abstract
   * differences between native Shadow DOM and "Shady DOM" when polyfilling on
   * older browsers.
   *
   * Note that in Polymer 2.x use of `Polymer.dom` is no longer required and
   * in the majority of cases simply facades directly to the standard native
   * API.
   *
   * @returns Wrapper providing either node API or event API
   */
  function dom(obj?: Node|Event|null): DomApi|EventApi;
}

/**
 * Event API wrapper class returned from `Polymer.dom.(target)` when
 * `target` is an `Event`.
 */
declare class EventApi {

  /**
   * Returns the first node on the `composedPath` of this event.
   */
  readonly rootTarget: EventTarget;

  /**
   * Returns the local (re-targeted) target for this event.
   */
  readonly localTarget: EventTarget;

  /**
   * Returns the `composedPath` for this event.
   */
  readonly path: EventTarget[];
  constructor(event: any);
}