# @types/webcomponents.js

> TypeScript definitions for webcomponents.js

Latest version **0.6.39** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/webcomponents.js
pnpm add @types/webcomponents.js
yarn add @types/webcomponents.js
bun add @types/webcomponents.js
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.6.39 |
| Published | 2023-11-07 |
| First published | 2016-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51438 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/webcomponents.js
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/webcomponents.js
- npm.io page: https://npm.io/package/@types/webcomponents.js

## Recent versions

- 0.6.39 (latest) — 2023-11-07
- 0.6.37 (ts4.4) — 2021-07-02
- 0.6.35 (ts3.1) — 2019-12-10
- 0.6.34 (ts2.0) — 2019-02-14
- 0.6.38 — 2023-10-18
- 0.6.36 — 2021-06-28
- 0.6.33 — 2018-08-03
- 0.6.32 — 2017-04-19
- 0.6.31 — 2017-01-18
- 0.6.30 — 2016-09-19
- 0.6.29 — 2016-08-25
- 0.6.28 — 2016-08-19
- 0.6.27 — 2016-08-02
- 0.6.26 — 2016-07-14
- 0.6.25-alpha — 2016-07-08
- … 8 more at https://npm.io/package/@types/webcomponents.js/versions

## README

# Installation
> `npm install --save @types/webcomponents.js`

# Summary
This package contains type definitions for webcomponents.js (https://github.com/webcomponents/webcomponentsjs).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/webcomponents.js.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/webcomponents.js/index.d.ts)
````ts
export interface CustomElementInit {
    prototype: HTMLElement;
    extends?: string | undefined;
}

export interface CustomElementConstructor {
    new(): HTMLElement;
}

export interface CustomElementsPolyfill {
    hasNative: boolean;
    flags: any;
    ready: boolean;
    useNative: boolean;
}

export interface HTMLImportsPolyfill {
    IMPORT_LINK_TYPE: string;
    isIE: boolean;
    flags: any;
    ready: boolean;
    rootDocument: Document;
    useNative: boolean;
    whenReady(callback: () => void): void;
}

export interface Polyfill {
    flags: any;
}

declare global {
    // This contains duplicates of some types in lib.dom.d.ts in order to support typescript 2.0
    interface ElementDefinitionOptions {
        extends?: string | undefined;
    }

    interface ShadowRoot extends DocumentFragment {
        innerHTML: string;
        readonly host: Element;
    }

    interface CustomElementRegistry {
        define(name: string, constructor: Function, options?: ElementDefinitionOptions): void;
        get(name: string): any;
        whenDefined(name: string): PromiseLike<void>;
    }

    interface Element {
        createShadowRoot(): ShadowRoot;
        readonly shadowRoot: ShadowRoot | null;
    }

    interface Document {
        registerElement(name: string, prototype: CustomElementInit): CustomElementConstructor;
    }

    interface Window {
        CustomElements: CustomElementsPolyfill;
        HTMLImports: HTMLImportsPolyfill;
        WebComponents: Polyfill;

        readonly customElements: CustomElementRegistry;
    }
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: none

# Credits
These definitions were written by [Adi Dahiya](https://github.com/adidahiya).

---
_Source: https://npm.io/package/@types/webcomponents.js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
