# xeonic

> A simple, fast, and tiny Library for spa-style routing and hydration between pages.

Latest version **1.0.1** (published 2022-08-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install xeonic
pnpm add xeonic
yarn add xeonic
bun add xeonic
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-08-17 |
| First published | 2022-08-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | TheCommieAxolotl |
| Maintainers | thecommieaxolotl |

## Links

- npm: https://www.npmjs.com/package/xeonic
- Repository: https://github.com/TheCommieAxolotl/xeonic
- Homepage: https://github.com/TheCommieAxolotl/xeonic#readme
- Issues: https://github.com/TheCommieAxolotl/xeonic/issues
- npm.io page: https://npm.io/package/xeonic

## Recent versions

- 1.0.1 (latest) — 2022-08-17
- 1.0.0 — 2022-08-17

## README

# ⚡ Xeonic
A simple, fast, and tiny Library for spa-style routing and hydration between pages.

## Usage
```bash
npm i xeonic
```

```js
import { initialiseRouter } from 'xeonic';
initialiseRouter();
```

```html
<script type="module">
    import { initialiseRouter } from 'xeonic';
    initialiseRouter();
</script>
```

...and that's it!

## Configuration
```js
import { initialiseRouter } from 'xeonic';
initialiseRouter({
    ignoreExternal: true, // ignore external links, WARNING: you may encounter errors with CORS if this is disabled
    prefetch: true, // prefetch links for faster navigation
    logs: true, // logs all navigation events to the console
});
```

## TODO
- [ ] Add listenable navigation events
- [ ] Add ability to navigate back and forward
- [ ] Add a `mergeHead` option to merge the heads of documents and not replace them

## Inspiration
This Project is heavily inspired by [flamethrower](https://github.com/fireship-io/flamethrower)

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