# @nteract/mathjax

> React components for MathJax

Latest version **4.0.16** (published 2021-04-08) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @nteract/mathjax
pnpm add @nteract/mathjax
yarn add @nteract/mathjax
bun add @nteract/mathjax
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.16 |
| Published | 2021-04-08 |
| First published | 2018-02-06 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 38.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 17 |
| Author | Kyle Kelley |
| Maintainers | benabel, alexandercbooth, benrussert, mpacer, theengineear, yuvipanda, rgbkrk, lgeiger, ivanov, captainsafia, peggyrayzis, jdetle, hasch, willingc, stormpython, crystalline-cat, emeeks |
| Keywords | mathjax |

## Links

- npm: https://www.npmjs.com/package/@nteract/mathjax
- Repository: https://github.com/nteract/mathjax
- Homepage: https://github.com/nteract/mathjax#readme
- Issues: https://github.com/nteract/mathjax/issues
- npm.io page: https://npm.io/package/@nteract/mathjax

## Dependencies (1)

- [load-script](https://npm.io/package/load-script.md) ^1.0.0

## Alternatives

- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads

## Recent versions

- 4.0.16 (latest) — 2021-04-08
- 4.0.8-alpha.0 (prerelease) — 2020-03-17
- 4.0.15 — 2021-02-03
- 4.0.14 — 2020-11-30
- 4.0.13 — 2020-10-30
- 4.0.12 — 2020-10-30
- 4.0.11 — 2020-09-01
- 4.0.10 — 2020-08-09
- 4.0.9 — 2020-06-07
- 4.0.8 — 2020-05-28
- 4.0.7 — 2020-03-13
- 4.0.7-alpha.0 — 2020-03-10
- 4.0.6-alpha.0 — 2020-03-03
- 4.0.5 — 2020-02-24
- 4.0.5-alpha.0 — 2020-02-18
- … 20 more at https://npm.io/package/@nteract/mathjax/versions

## README

# @nteract/mathjax

This package contains two main components, `<MathJax.Context>` and `<MathJax.Node>`. The `<MathJax.Context>` component loads MathJax and makes it available to children elements via the React Context API. `<MathJax.Node>` takes raw text for rendering and uses MathJax to render formatted math.

## Installation

```
$ yarn add @nteract/mathjax
```

```
$ npm install --save @nteract/mathjax
```

## Usage

The Redux reducer below shows how we can leverage the actions and action types in this package to create a reducer for managing the status of a save event.

```javascript
import MathJax from "@nteract/mathjax";

export default text => {
  return (
    <MathJax.Context>
      <MathJax.Node>{`x^2 + y^2 = z^2`}</MathJax.Node>
      <MathJax.Node>{text}</MathJax.Node>
    </MathJax.Context>
  );
};
```

## Documentation

You can view the reference documentation for `@nteract/mathjax` in the the [examples documentation](./examples.md).

## Support

If you experience an issue while using this package or have a feature request, please file an issue on the [issue board](https://github.com/nteract/mathjax/issues/new/choose).

## License

[BSD-3-Clause](https://choosealicense.com/licenses/bsd-3-clause/)

---
_Source: https://npm.io/package/@nteract/mathjax · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._