# react-footnotes

> 👣 dead simple footnotes, in React

Latest version **0.1.2** (published 2018-08-24) · WTFPL license · 0 weekly downloads

## Install

```sh
npm install react-footnotes
pnpm add react-footnotes
yarn add react-footnotes
bun add react-footnotes
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2018-08-24 |
| First published | 2018-08-24 |
| Weekly downloads | 0 |
| License | WTFPL |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 32.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Michael Scott Hertzberg |
| Maintainers | moimikey |
| Keywords | footnotes, react, component, footnote |

## Links

- npm: https://www.npmjs.com/package/react-footnotes
- Repository: https://github.com/moimikey/react-footnotes
- Homepage: https://github.com/moimikey/react-footnotes#readme
- Issues: https://github.com/moimikey/react-footnotes/issues
- npm.io page: https://npm.io/package/react-footnotes

## Dependencies (1)

- [react-tree-walker](https://npm.io/package/react-tree-walker.md) ^4.3.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2018-08-24
- 0.1.1 — 2018-08-24

## README

# 👣 react-footnotes

dead simple footnotes, in React

## Installation

```sh
npm install --save react-footnotes
yarn add react-footnotes
```

```js
// esmodules
import { Footnotes } from 'react-footnotes'

// commonjs
var Footnotes = require('react-footnotes').Footnotes
```

## Usage

```js
import * as React from 'react'
import * as Footnotes from 'react-footnotes'

class App extends React.Component {
  render() {
    return (
      <Footnotes>
        {({ Footnote, getFootnotes }) => (
          <React.Fragment >
            <Footnote i={1} source={`https://google.com`} desc={`this is a description.`}>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</Footnote>
            <Footnote i={2} source={`https://google.com`} desc={`this is a description.`}>Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</Footnote>
            <Footnote i={3} source={`https://google.com`} desc={`this is a description.`}>Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.</Footnote>
            <Footnote i={4} source={`https://google.com`} desc={`this is a description.`}>Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</Footnote>
            {JSON.stringify(getFootnotes())}
          </React.Fragment>
        )}
      </Footnotes>
    )
  }
}
```

## Development

```sh
npm run dev

# go to http://localhost:1234
```

### Distribution

```sh
npm run build
```

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