GithubHelp home page GithubHelp logo

preact-context's Introduction

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. Please have in mind that preact X ships with a context implementation

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.