# react-chrome-extension-router

> A dead simple routing solution for browser extensions using React

Latest version **1.4.0** (published 2022-08-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-chrome-extension-router
pnpm add react-chrome-extension-router
yarn add react-chrome-extension-router
bun add react-chrome-extension-router
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2022-08-18 |
| First published | 2019-07-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 41.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 58 |
| Author | Kelson Warner |
| Maintainers | kelsonpw35 |
| Keywords | react, react-router, router, react router, chrome, browser, extension, chrome-extension, micro router, micro react router |

## Links

- npm: https://www.npmjs.com/package/react-chrome-extension-router
- Repository: https://github.com/kelsonpw/react-chrome-extension-router
- npm.io page: https://npm.io/package/react-chrome-extension-router

## 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

- 1.4.0 (latest) — 2022-08-18
- 1.3.1 — 2021-11-10
- 1.3.0 — 2021-11-10
- 1.2.0 — 2020-12-09
- 1.1.0 — 2020-01-23
- 1.0.3 — 2020-01-14
- 1.0.2 — 2020-01-13
- 1.0.1 — 2020-01-13
- 0.0.15 — 2019-07-29
- 0.0.14 — 2019-07-15
- 0.0.13 — 2019-07-15
- 0.0.12 — 2019-07-15
- 0.0.11 — 2019-07-15
- 0.0.3 — 2019-07-15
- 0.0.2 — 2019-07-15
- … 2 more at https://npm.io/package/react-chrome-extension-router/versions

## README

# react-chrome-extension-router

> A dead simple routing solution for browser extensions

[![NPM](https://img.shields.io/npm/v/react-chrome-extension-router.svg)](https://www.npmjs.com/package/react-chrome-extension-router) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Install

```bash
npm install --save react-chrome-extension-router
```

## Usage

```jsx
import * as React from 'react';
import * as ReactDOM from 'react-dom';
import {
  goBack,
  goTo,
  popToTop,
  Link,
  Router,
  getCurrent,
  getComponentStack,
} from 'react-chrome-extension-router';

const Three = ({ message }: any) => (
  <div onClick={() => popToTop()}>
    <h1>{message}</h1>
    <p>Click me to pop to the top</p>
  </div>
);

const Two = ({ message }: any) => (
  <div>
    This is component Two. I was passed a message:
    <p>{message}</p>
    <button onClick={() => goBack()}>
      Click me to go back to component One
    </button>
    <button onClick={() => goTo(Three, { message })}>
      Click me to go to component Three!
    </button>
  </div>
);

const One = () => {
  return (
    <Link component={Two} props={{ message: 'I came from component one!' }}>
      This is component One. Click me to route to component Two
    </Link>
  );
};

const App = () => {
  useEffect(() => {
      const { component, props } = getCurrent();
      console.log(
        component
          ? `There is a component on the stack! ${component} with ${props}`
          : `The current stack is empty so Router's direct children will be rendered`
      );
      const components = getComponentStack();
      console.log(`The stack has ${components.length} components on the stack`);
  });
  return (
    <Router>
      <One />
    </Router>
  );
};

ReactDOM.render(<App />, document.getElementById('root'));
```

[![Edit agitated-satoshi-sccqr](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/agitated-satoshi-sccqr?fontsize=14)

## License

MIT © [kelsonpw](https://github.com/kelsonpw)

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