Home

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 libraries 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 a users code in an application's component structure.

There is 1 primary use cases where this tool makes sense.

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).

If you are building application then you are better off using stencil-redux

• Getting started

  1. Create a Tunnel.
  2. Pass state to the Tunnel's Provider Component.
  3. Place your state consumption points.

• API Documentation

  • createProviderConsumer
  • Provider Component
  • Consumer Component