React new Context API for preact
Clone or download
Latest commit 95616a5 Nov 18, 2018

README.md

React's createContext for preact

Build Status npm

Sauce Test Status

This is an implementation of react's new context api. You can read more about it on react's documentation page.

This package provides the createContext factory function that can be used in order to create a context:

import { h } from "preact";
import { createContext } from "preact-context";

const Theme = createContext("dark");

The returned object contains two components: a Provider and a Consumer.

The Consumer

It can be used in order to consume the provided object:

<Theme.Consumer>{theme => <p>Selected theme: {theme}</p>}</Theme.Consumer>

Alternatively, it can also be used with a render property:

<Theme.Consumer render={theme => <p>Selected theme: {theme}</p>} />

The Provider

can be used in order to update the value of a context:

<Theme.Provider value="sunny">

will change "dark" to "sunny" and notify all it's consumers of the change.

Development

This project has been written with typescript. The watch script will watch for changes, compile and run the tests.

$ npm i
$ npm run watch

License

Licensed under the Apache License, Version 2.0

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs