# surplus-toys

> Write super-simple Surplus.js apps with in-browser compilation

Latest version **0.5.0** (published 2018-03-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install surplus-toys
pnpm add surplus-toys
yarn add surplus-toys
bun add surplus-toys
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.0 |
| Published | 2018-03-07 |
| First published | 2018-03-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 44 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Adam Haile |
| Maintainers | adamhaile |
| Keywords | surplus, s-js, javascript, jsx, framework, reactive |

## Links

- npm: https://www.npmjs.com/package/surplus-toys
- npm.io page: https://npm.io/package/surplus-toys

## Alternatives

- [@sveltejs/kit](https://npm.io/package/@sveltejs/kit.md) — 2.2M weekly downloads
- [@atlaskit/theme](https://npm.io/package/@atlaskit/theme.md) — 402.0K weekly downloads
- [@tangle-network/brand](https://npm.io/package/@tangle-network/brand.md) — 10.0K weekly downloads
- [seneca](https://npm.io/package/seneca.md) — 7.4K weekly downloads
- [@bsb/base](https://npm.io/package/@bsb/base.md) — 7.2K weekly downloads

## Recent versions

- 0.5.0 (latest) — 2018-03-07

## README

## Surplus-toys
Surplus-toys makes it super simple to write single-file 'toy' [Surplus.js](https://github.com/adamhaile/surplus) apps: demos, games, experiments, etc.  

It's old school webdev: no build tools, just a single HTML file.  Hit reload to see changes.

### How to use it

1. Make a single .html file
2. Put your javascript, including Surplus JSX, in a `<script type="text/jsx"></script>` tag in the file.  NOTE THE "text/jsx" PART.
3. At the end of the file, include the surplus-toys script: `<script src="http://unpkg.com/surplus-toys"/>`

Surplus-toys will compile your `"text/jsx"` code into regular javascript and execute it.

### Example

```html
<h1>Hello World with Surplus-toys</h1>
<script type="text/jsx">
var name = S.data("World");
document.body.appendChild(
    <div>
        Your name: <input type="text" value={name()} onChange={e => name(e.target.value)} />
        <br/>
        Hello {name()}!
    </div>
)
</script>
<script src="http://unpkg.com/surplus-toys" />
```
For more examples, see [surplus-demos](https://github.com/adamhaile/surplus-demos).

### FAQ

#### Can I use surplus-toys with multi-file apps?

No.  This is for demos.  If you need multiple files, look into a real build system.  Surplus has plugins for all the major ones.

#### How big apps can I make?

Surplus apps tend to be pretty expressive, i.e. a few lines of code does a lot.  For longer examples, see games like [the Asteroids demo](https://github.com/surplus-demos/asteroids.html), which runs to a few hundred lines.

#### How does it work

Surplus-toys bundles both the surplus runtime and compiler into a single script.  Since you tagged your code with "text/jsx" not "text/javascript", the browser didn't run it on initial load.  Surplus-toys then finds all such script tags, compiles their contents, and inserts new script tags with the generated javascript.

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