# @stencil/state-tunnel

> Stencil State Tunnel

Latest version **1.0.1** (published 2019-06-08) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @stencil/state-tunnel
pnpm add @stencil/state-tunnel
yarn add @stencil/state-tunnel
bun add @stencil/state-tunnel
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-06-08 |
| First published | 2018-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 669.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 94 |
| Author | Ionic Team |
| Maintainers | adamdbradley, brandyscarney, camwiegert, dwieeb, ionicjs, jthoms1, kensodemann, manucorporat, maxlynch, mhartington, nhyatt |

## Links

- npm: https://www.npmjs.com/package/@stencil/state-tunnel
- Repository: https://github.com/ionic-team/stencil-state-tunnel
- Issues: https://github.com/ionic-team/stencil-state-tunnel
- npm.io page: https://npm.io/package/@stencil/state-tunnel

## Recent versions

- 1.0.1 (latest) — 2019-06-08
- 1.0.0 (one) — 2019-06-02
- 1.0.0-1 — 2019-05-16
- 1.0.0-0 — 2019-05-15
- 0.0.9-5 — 2019-04-11
- 0.0.9-4 — 2019-04-02
- 0.0.9-3 — 2019-04-02
- 0.0.9-2 — 2019-04-01
- 0.0.9-1 — 2018-09-17
- 0.0.9-0 — 2018-09-15
- 0.0.8 — 2018-08-30
- 0.0.7 — 2018-06-06
- 0.0.6 — 2018-05-30
- 0.0.5 — 2018-05-30
- 0.0.4 — 2018-05-18
- … 3 more at https://npm.io/package/@stencil/state-tunnel/versions

## README

[![npm][npm-badge]][npm-badge-url]

# Stencil State Tunnel

This project was built to provide additional functionality to developers working with stencil
components and sharing state across components and through slots. The API was inspired by React's Context.

There are many cases within component based application development where you will want to drill state down through props to children and children's children and so on. This project was created in order to alleviate the need for pass props deep through an application's component structure.

There are 2 primary use cases where this tool makes sense.
1. Building a stencil application and need to store application state in a centralized location.
2. Building a collection of components that need to share state but have no direct 'line of sight' between the component relationships (ie most likely from using `slot`).

More information on usage and API can be found in our [wiki].

[wiki]: https://github.com/ionic-team/stencil-state-tunnel/wiki
[npm-badge]: https://img.shields.io/npm/v/@stencil/state-tunnel.svg
[npm-badge-url]: https://www.npmjs.com/package/@stencil/state-tunnel

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