# jiggy

> A testing jig for web components.

Latest version **0.0.1** (published 2023-06-04) · ISC license · 0 weekly downloads

## Install

```sh
npm install jiggy
pnpm add jiggy
yarn add jiggy
bun add jiggy
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2023-06-04 |
| First published | 2023-06-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 449.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Austin Martin |
| Maintainers | auzmartist |
| Keywords | web, component, test, demo, storybook |

## Links

- npm: https://www.npmjs.com/package/jiggy
- Repository: https://github.com/au-z/jiggy
- Homepage: https://github.com/au-z/jiggy#readme
- Issues: https://github.com/au-z/jiggy/issues
- npm.io page: https://npm.io/package/jiggy

## Dependencies (4)

- [immer](https://npm.io/package/immer.md) ^10.0.2
- [hybrids](https://npm.io/package/hybrids.md) ^8.2.0
- [@auzmartist/cam-el](https://npm.io/package/@auzmartist/cam-el.md) 3.0.0-alpha.4
- [@auzmartist/hybrids-helpers](https://npm.io/package/@auzmartist/hybrids-helpers.md) 0.3.6

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads
- [aws-elasticsearch-connector](https://npm.io/package/aws-elasticsearch-connector.md) — 37.4K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2023-06-04

## README

# Jiggy

> A featherweight jig library developing and testing web components.

## Getting Started

```bash
npm i -D jiggy
pnpm add -D jiggy
```

```html
<!-- jiggy uses Material Icons -->
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet" />

<!-- Import your component -->
<script type="module" src="./path/to/your-component"></script>

<!-- Gettin' jiggy wit it -->
<script type="module" src="/node_modules/jiggy/dist/jiggy.js"></script>

<!-- na-na, na, na-na-na -->
<jig-block>
  <your-component></your-component>
</jig-block>
```

## API
Jiggy is purposefully small and simple.

### &lt;jig-block&gt;

Jig Block wraps your component in a jig.

```html
<jig-block>
  <your-component></your-component>
</jig-block>
```

It creates a form for your props.

```html
<jig-block props="foo, bar">
  <your-component
    foo="initial foo"
    bar="initial bar"
  ></your-component>
</jig-block>
```

It can also listen for component events.

```html
<jig-block events="load, change">
  <your-component></your-component>
  <jig-log slot="log"></jig-log>
</jig-block>
```

It can also document CSS Custom Properties

```html
<jig-block vars="background, color">
  <your-component></your-component>
  <jig-var slot="var"></jig-var>
</jig-block>
```

### &lt;jig-log&gt;
Prints out the jig event log.

```html
<jig-block events="load, change">
  <your-component></your-component>
  <jig-log slot="log"></jig-log>
</jig-block>
```

### &lt;jig-var&gt;
Edit CSS Custom Properties

```html
<jig-block vars="background, color">
  <your-component></your-component>
  <jig-var slot="var"></jig-var>
</jig-block>
```

## Contributing
Contributions are welcome. Let's make web components better together 🤝

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