Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add getting started to readme #16

Merged
merged 4 commits into from
Jul 16, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
87 changes: 87 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,96 @@ build modular applications that are [composable], [functional reactive] and
[functional reactive]: https://en.wikipedia.org/wiki/functional_reactive_programming
[pure]: https://en.wikipedia.org/wiki/Functional_programming#Pure_functions

# Getting started

You can install flyps via npm:

`npm i flyps`

### Create a signal

`Signals` are the core principle of flyps and are used everywhere.

```
import { signal } from "flyps";

const counter = signal(1);
```

### Change the value of a signal

A signal can be updated via a function (`signal::update`) or replaced with a new value (`signal::reset`).

```
const counter = signal(0); // value = 0
counter.update(value => value + 1); // value = 1
counter.reset(0); // value = 0
```

### Render view

Views can be rendered with the `mount` function.

```
import { mount } from "flyps";

mount(document.querySelector("#my-view"),
() => "<h1>Hello World!</h1>",
(prev, next) => {
let el = htmlToElement(next);
prev.parentNode.replaceChild(el, prev);
return el;
},
prev => {
return prev.parentNode.removeChild(el);
}
);
```

### Snabbdom rendering

For more complex views we suggest to add the [flyps-dom-snabbdom] extension, which adds support for [snabbdom] rendering.

First install the extension: `npm i flyps-dom-snabbdom`

```
import { mount, h } from "flyps-dom-snabbdom";

mount(document.querySelector("#my-view"),
() => h("h1", "Hello World!")
);
```

### Render value from signal
```
import { signal } from "flyps";
import { mount, h } from "flyps-dom-snabbdom";

const data = signal("Hello World!");

mount(document.querySelector("#my-view"),
() => h("h1", data.value())
);
```

Whenever the `signal` changes the view will be re-rendered with the new data.

```
data.reset("Hello User!");
```

### More Examples

More examples can be found on our flyps [homepage].



[npm-badge]: https://img.shields.io/npm/v/flyps.svg
[npm-url]: https://www.npmjs.com/package/flyps
[build-badge]: https://travis-ci.org/Contargo/flyps.svg?branch=master
[build-url]: https://travis-ci.org/Contargo/flyps
[coverage-badge]: https://coveralls.io/repos/github/Contargo/flyps/badge.svg?branch=master
[coverage-url]: https://coveralls.io/github/Contargo/flyps?branch=master
[homepage]: https://contargo.github.io/flyps/
[flyps-dom-snabbdom]: https://github.com/Contargo/flyps-dom-snabbdom/
[snabbdom]: https://github.com/snabbdom/snabbdom