Skip to content
An opinionated set of bindings to the React library, optimizing for the most basic use cases
PureScript JavaScript
Branch: master
Clone or download
Latest commit bb3cfcb Aug 3, 2019

README.md

purescript-react-basic

Build Status

This package implements an opinionated set of bindings over React, optimizing for correctness and simplifying basic use cases.

A note about React hooks: Hooks are arriving in stable React soon. The API presented here is the more traditional setState+lifecycles style React's had for a long time. If you'd like to experiment with the hooks API in react-basic, have a look at react-basic-hooks. It can be installed and used along side this library, but don't forget it's a preview release!

Features

  • All React DOM elements and attributes are supported (soon, events are a work in progress).
  • An intuitive API for specifying props - simple records, no arrays of key value pairs.
  • Attributes are optional, but type-checked. It is a type error to specify href as an integer, for example.
  • Both setState and an action/update pattern for local component state, inspired by ReasonReact.
  • React lifecycles are available, but not in your way when you don't need them.

Getting Started

You can install this package using Bower:

bower install --save purescript-react-basic

Or clone/fork the starter project.

See the documentation for an overview of the API or take a look at these examples:

Migrating from v7 to v8

v8 removes the required update function from the component spec and replaces send self Action with the self.setState API. Existing components using update can create a send function using the runUpdate function added in v8. See the actions example for an example of this. Alternatively, this comment shows a few other possible upgrade paths.

Migrating from v2/v3

React.Basic.Compat is a new (but deprecated) module. It matches most of the old API and types (except setStateThen and isFirstMount) to make upgrading easier and more gradual. You can find ^import\sReact\.Basic\b and replace with import React.Basic.Compat, upgrade the package version, and proceed from there one component at a time (or only new components). See the documentation link above for more info on the new API.

You can’t perform that action at this time.