Package

purescript-react

Repository
purescript-contrib/purescript-react
License
MIT
Uploaded by
thomashoneyman
Published on
2021-02-26

CI Release Pursuit Maintainer: ethul

Low-level React bindings for PureScript. For a higher-level library for working with React, please see react-basic repository (which includes a package for working with React Hooks).

You may also be interested in the low-level React DOM bindings.

Installation

Install react with Spago:

spago install react

This library requires the react module. This dependency may be satisfied by installing the NPM react package.

npm install react

Quick start

The quick start hasn't been written yet (contributions are welcome!). The quick start covers a common, minimal use case for the library, whereas longer examples and tutorials are kept in the docs directory.

Documentation

react documentation is stored in a few places:

  1. Module documentation is published on Pursuit.
  2. Written documentation is kept in the docs directory.
  3. The react-example repository demonstrates these bindings in action.

If you get stuck, there are several ways to get help:

Contributing

You can contribute to react in several ways:

  1. If you encounter a problem or have a question, please open an issue. We'll do our best to work with you to resolve or answer it.

  2. If you would like to contribute code, tests, or documentation, please read the contributor guide. It's a short, helpful introduction to contributing to this library, including development instructions.

  3. If you have written a library, tutorial, guide, or other resource based on this package, please share it on the PureScript Discourse! Writing libraries and learning resources are a great way to help this library succeed.