https://github.com/purescript-contrib/purescript-react

React Bindings for PureScript
https://github.com/purescript-contrib/purescript-react

Last synced: 2 months ago
JSON representation

React Bindings for PureScript

• Host: GitHub
• URL: https://github.com/purescript-contrib/purescript-react
• Owner: purescript-contrib
• License: mit
• Created: 2014-05-05T16:49:38.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2023-01-05T21:25:10.000Z (about 2 years ago)
• Last Synced: 2024-10-20T01:25:09.855Z (3 months ago)
• Language: PureScript
• Size: 293 KB
• Stars: 399
• Watchers: 16
• Forks: 65
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ccamel - purescript-contrib/purescript-react - React Bindings for PureScript (PureScript)
• awesome-purescript - purescript-react - React bindings for PureScript (UI Libraries)

README

        
# React

[![CI](https://github.com/purescript-contrib/purescript-react/workflows/CI/badge.svg?branch=main)](https://github.com/purescript-contrib/purescript-react/actions?query=workflow%3ACI+branch%3Amain)

[![Release](https://img.shields.io/github/release/purescript-contrib/purescript-react.svg)](https://github.com/purescript-contrib/purescript-react/releases)

[![Pursuit](https://pursuit.purescript.org/packages/purescript-react/badge)](https://pursuit.purescript.org/packages/purescript-react)

[![Maintainer: ethul](https://img.shields.io/badge/maintainer-ethul-teal.svg)](https://github.com/ethul)

Low-level React bindings for PureScript. For a higher-level library for working with React, please see [`react-basic`](https://github.com/lumihq/purescript-react-basic) repository (which includes a package for working with React Hooks).

You may also be interested in the low-level [React DOM bindings](https://github.com/purescript-contrib/purescript-react-dom).

## Installation

Install `react` with [Spago](https://github.com/purescript/spago):

```sh

spago install react

```

This library requires the `react` module. This dependency may be satisfied by installing the NPM [react package](https://www.npmjs.com/package/react).

```

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](./docs).

## Documentation

`react` documentation is stored in a few places:

1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-react).

2. Written documentation is kept in the [docs directory](./docs).

3. The [react-example](https://github.com/ethul/purescript-react-example) repository demonstrates these bindings in action.

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

- [Open an issue](https://github.com/purescript-contrib/purescript-react/issues) if you have encountered a bug or problem.

- Ask general questions on the [PureScript Discourse](https://discourse.purescript.org) forum or the [PureScript Discord](https://purescript.org/chat) chat.

## Contributing

You can contribute to `react` in several ways:

1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-react/issues). 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](./CONTRIBUTING.md). 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](https://discourse.purescript.org)! Writing libraries and learning resources are a great way to help this library succeed.