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

Low-level React DOM bindings for PureScript
https://github.com/purescript-contrib/purescript-react-dom

Last synced: 7 months ago
JSON representation

Low-level React DOM bindings for PureScript

• Host: GitHub
• URL: https://github.com/purescript-contrib/purescript-react-dom
• Owner: purescript-contrib
• License: mit
• Created: 2015-11-28T21:18:06.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2022-06-01T22:27:47.000Z (almost 4 years ago)
• Last Synced: 2025-08-21T11:56:49.708Z (7 months ago)
• Language: PureScript
• Homepage:
• Size: 36.1 KB
• Stars: 16
• Watchers: 6
• Forks: 16
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# React DOM

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

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

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

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

Low-level React DOM bindings for PureScript. You may also be interested in the higher-level [`react-basic-dom`](https://github.com/lumihq/purescript-react-basic-dom) library.

## Installation

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

```sh

spago install react-dom

```

You will also need to install the `react-dom` package from NPM:

```sh

npm install --save react-dom

```

## 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-dom` documentation is stored in a few places:

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

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

3. You can use the [react-example](https://github.com/ethul/purescript-react-example) to see 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-dom/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-dom` in several ways:

1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-react-dom/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.