# react-pathing-builder

> A React component for building pathing graphs on maps.

Latest version **0.1.3** (published 2021-01-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-pathing-builder
pnpm add react-pathing-builder
yarn add react-pathing-builder
bun add react-pathing-builder
```

## Health

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

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

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2021-01-24 |
| First published | 2019-01-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 124.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Samuel K. Grush |
| Maintainers | skgrush |

## Links

- npm: https://www.npmjs.com/package/react-pathing-builder
- Repository: https://github.com/skgrush/react-pathing-builder
- Homepage: https://skgrush.github.io/react-pathing-builder
- Issues: https://github.com/skgrush/react-pathing-builder/issues
- npm.io page: https://npm.io/package/react-pathing-builder

## Recent versions

- 0.1.3 (latest) — 2021-01-24
- 0.1.2 — 2021-01-23
- 0.1.0 — 2019-02-01
- 0.0.1 — 2019-01-18
- 0.0.1-beta — 2019-01-18

## README

# react-pathing-builder

> A map builder for pathing applications

![](https://img.shields.io/github/license/skgrush/react-pathing-builder.svg?style=flat-square)
![](https://img.shields.io/npm/v/react-pathing-builder.svg?style=flat-square)
![](https://img.shields.io/bundlephobia/min/react-pathing-builder.svg?style=flat-square)

## Install as a Dependency

In your existing npm-like repository, run one of the following:

```shell
yarn add react-pathing-builder
# or
npm install react-pathing-builder
```

once added, import as needed:

```javascript
import * as React from 'react'
import {render} from 'react-dom'
import {PathingBuilder} from 'react-pathing-builder'

// example
render(<PathingBuilder mapSrc="https://placehold.it/300" />)
```

## Test / Develop

```shell
git clone git@github.com:skgrush/react-pathing-builder.git
cd react-pathing-builder
yarn install
yarn start
```

Starts up a webpack dev server pointing at [`examples/src`](examples/src),
which imports from the full TypeScript [`src`](src), available at
[localhost:3001](http://localhost:3001).

### Build

```shell
yarn build
```

Transpiles and packs [src](src) into `lib/index.js`, builds
TypeScript declaration files at `lib/*.d.ts`,
and copies the css file.

### scripts

- `yarn` - install dependencies and build
- `yarn start` - start webpack dev server
- `yarn build` - build the module, including types

#### npm equivalent scripts

`npm start` works, and other scripts that don't call `yarn` work
just fine with `npm`.

Build:

```shell
npm run clean:build && \
  npm run build:types && \
  npm run build:js && \
  npm run build:css
```

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