# @groupby/elements-base

> ## Functionality

Latest version **0.1.0** (published 2019-11-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install @groupby/elements-base
pnpm add @groupby/elements-base
yarn add @groupby/elements-base
bun add @groupby/elements-base
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2019-11-29 |
| First published | 2019-11-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 18.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Groupby Inc |
| Maintainers | colinc-gbi, stphflwrs, lukecorrigallgb, hesamemadigbi, groupbyops, edwardsogbi, davidleegbi, welkie, satheesb, groupby-ops, groupby-ci, cradich.gb |

## Links

- npm: https://www.npmjs.com/package/@groupby/elements-base
- Repository: https://github.com/groupby/elements-view
- Homepage: https://github.com/groupby/elements-view#readme
- Issues: https://github.com/groupby/elements-view/issues
- npm.io page: https://npm.io/package/@groupby/elements-base

## Dependencies (1)

- [lit-element](https://npm.io/package/lit-element.md) ^2.2.0

## Recent versions

- 0.1.0 (latest) — 2019-11-29

## README

# GroupBy Elements Base

## Functionality

This class extends [LitElement](https://lit-element.polymer-project.org/) and is the class that all components will extend.
Any shared functionality should be contained within this class.

### Dispatching events

This class contains a generic event dispatch function, `dispatchElementsEvent`. The `dispatchElementsEvent` function constructs a CustomEvent with payload properties that are common across the GB Elements components. This function can be used across all components that extend Base to dispatch events.

### Rendering the light DOM

All components that extend `Base` will render in the Light DOM.

## Testing

The test suite for this component is contained in the `test` directory.
To run the tests, navigate to this folder and use one of the following commands based on the desired testing flow:

- To run the tests once:

```sh
yarn test
```

- To run the tests and watch the `src` and `test` directories for changes:

```sh
yarn tdd
```

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