https://github.com/juliendargelos/web-component

Minimal class and decorators for typescript web components.
https://github.com/juliendargelos/web-component

Last synced: 4 days ago
JSON representation

Minimal class and decorators for typescript web components.

• Host: GitHub
• URL: https://github.com/juliendargelos/web-component
• Owner: juliendargelos
• License: mit
• Created: 2019-10-28T10:07:40.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-10-28T14:48:35.000Z (about 5 years ago)
• Last Synced: 2024-12-11T08:51:22.399Z (about 1 month ago)
• Language: TypeScript
• Size: 15.6 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Web Component

[![ci](https://github.com/juliendargelos/web-component/workflows/ci/badge.svg?branch=master)](https://github.com/juliendargelos/web-component/actions?workflow=ci)

[![Maintainability](https://img.shields.io/codeclimate/maintainability-percentage/juliendargelos/web-component)](https://codeclimate.com/github/juliendargelos/web-component/maintainability)

[![Coverage](https://img.shields.io/endpoint?url=https%3A%2F%2Frunkit.io%2Fjuliendargelos%2Ftest-coverage-badge%2Fbranches%2Fmaster%3Frepository%3Djuliendargelos%2Fweb-component%26branch%3Dcoverage%26path%3Dcoverage-summary.json)](https://github.com/juliendargelos/web-component/tree/coverage)

[![npm bundle size](https://img.shields.io/bundlephobia/minzip/@juliendargelos/web-component)](https://npmjs.com/@juliendargelos/web-component)

[![GitHub](https://img.shields.io/github/license/juliendargelos/web-component?color=informational)](LICENSE)

This package provides a minimal abstract class that can be extended to build web components. It comes with some useful decorators and is TypeScript friendly.

### Install

```bash

yarn add @juliendargelos/web-component

```

### Usage

*Documentation coming soon*

### Development

Clone the repository:

```shell

git clone [email protected]:juliendargelos/web-component

```

Install dependencies:

```shell

yarn

```

Build:

```shell

yarn build

```

Test:

```shell

yarn test

```