Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/luwes/sinuous

🧬 Light, fast, reactive UI library
https://github.com/luwes/sinuous

dom functional hyperscript javascript reactive sinuous ui

Last synced: 26 days ago
JSON representation

🧬 Light, fast, reactive UI library

Host: GitHub
URL: https://github.com/luwes/sinuous
Owner: luwes
Created: 2019-04-06T14:52:50.000Z (about 5 years ago)
Default Branch: main
Last Pushed: 2024-01-10T11:48:25.000Z (6 months ago)
Last Synced: 2024-02-17T22:03:24.015Z (4 months ago)
Topics: dom, functional, hyperscript, javascript, reactive, sinuous, ui
Language: JavaScript
Homepage: https://sinuous.netlify.app
Size: 9.63 MB
Stars: 1,017
Watchers: 18
Forks: 36
Open Issues: 13
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Lists

awesome-ccamel - luwes/sinuous - 🧬 Light, fast, reactive UI library (JavaScript)
awesome-stars - sinuous
awesome-github-star - sinuous
awesome-stars - luwes/sinuous - 🧬 Light, fast, reactive UI library (JavaScript)
awesome-reactivity - Sinous reactivity
awesome-stars - sinuous
awesome-stars - luwes/sinuous - 🧬 Light, fast, reactive UI library (JavaScript)
awesome-stars - luwes/sinuous - 🧬 Light, fast, reactive UI library (JavaScript)

README

        # 

[![Version](https://img.shields.io/npm/v/sinuous.svg?color=success&style=flat-square)](https://www.npmjs.com/package/sinuous)

![Badge size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/sinuous/+esm?compression=gzip&label=gzip&style=flat-square)

[![codecov](https://img.shields.io/codecov/c/github/luwes/sinuous.svg?style=flat-square&color=success)](https://codecov.io/gh/luwes/sinuous)

**npm**: `npm i sinuous`  

**cdn**: https://cdn.jsdelivr.net/npm/sinuous/+esm

---

- **Small.** hello world at `~1.4kB` gzip.

- **Fast.** [top ranked](https://rawgit.com/krausest/js-framework-benchmark/master/webdriver-ts-results/table.html) of 80+ UI libs.

- **Truly reactive.** automatically derived from the app state.

- **DevEx.** no compile step needed, choose your [view syntax](#view-syntax).

---

### Add-ons

| Size                                                                                                                                   | Name                                     | Description                             |

| -------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | --------------------------------------- |

| ![Badge size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/sinuous/src/observable.js?compression=gzip&label=gzip&style=flat-square) | [`sinuous/observable`](./src/observable.md) | Tiny observable _(included by default)_ |

| ![Badge size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/sinuous/src/map.js?compression=gzip&label=gzip&style=flat-square)        | [`sinuous/map`](./src/map.js)               | Fast list renderer                      |

| ![Badge size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/sinuous/src/hydrate.js?compression=gzip&label=gzip&style=flat-square)    | [`sinuous/hydrate`](./src/hydrate.md)       | Hydrate static HTML                     |

| ![Badge size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/sinuous/src/template.js?compression=gzip&label=gzip&style=flat-square)   | [`sinuous/template`](./src/template.md)     | Pre-rendered Template                   |

### Community

- [**sinuous-context**](https://github.com/theSherwood/sinuous-context) ([@theSherwood](https://github.com/theSherwood)): A light-weight, fast, and easy to use context api for Sinuous.

- [**memo**](https://github.com/luwes/memo) ([@luwes](https://github.com/luwes)): Memoize components and functions.

- [**disco**](https://github.com/luwes/disco) ([@luwes](https://github.com/luwes)): Universal `connected` and `disconnected` lifecycle events.

- [**sinuous-style**](https://github.com/theSherwood/sinuous-style) ([@theSherwood](https://github.com/theSherwood)): Scoped styles for Sinuous à la styled-jsx.

- [**sinuous-lifecycle**](https://www.npmjs.com/package/sinuous-lifecycle) ([@heyheyhello](https://github.com/heyheyhello)): onAttach/onDetach DOM lifecycles.

- [**sinuous-trace**](https://www.npmjs.com/package/sinuous-trace) ([@heyheyhello](https://github.com/heyheyhello)): Traces the internal API to record component creation, adoption, and removal.

### Examples

- [**Counter**](https://codesandbox.io/s/sinuous-counter-z6k71) (@ CodeSandbox)

- [**Analog SVG Clock**](https://sinuous.netlify.app/examples/clock/) ⏰

- [**Classic TodoMVC**](https://luwes.github.io/sinuous-todomvc/) _([GitHub Project](https://github.com/luwes/sinuous-todomvc))_

- [**JS Framework Benchmark**](https://github.com/krausest/js-framework-benchmark/blob/master/frameworks/keyed/sinuous/src/main.js) (@ GitHub)

- [**Sierpinski Triangle**](https://replit.com/@luwes/sinuous-sierpinski-triangle-demo)

- [**Three.js Boxes**](https://replit.com/@luwes/sinuous-three-boxes) 📦

- [**JSX**](https://github.com/heyheyhello/sinuous-tsx-example/tree/jsx/) _([GitHub Project @heyheyhello](https://github.com/heyheyhello/sinuous-tsx-example/tree/jsx/))_

- [**TSX**](https://github.com/heyheyhello/sinuous-tsx-example/tree/tsx/) _([GitHub Project @heyheyhello](https://github.com/heyheyhello/sinuous-tsx-example/tree/tsx/))_

- [**Simple routing**](https://codesandbox.io/s/sinuous-router-g2eud) ([@mindplay-dk](https://github.com/mindplay-dk)) 🌏

- [**Datepicker**](https://codesandbox.io/s/sinuous-date-picker-thxdt) ([@mindplay-dk](https://github.com/mindplay-dk))

- [**Hacker News**](https://codesandbox.io/s/sinuous-hacker-news-dqtf7) ([@mindplay-dk](https://github.com/mindplay-dk))

- [**7 GUIs**](https://codesandbox.io/s/github/theSherwood/7_GUIs/tree/master/sinuous) ([@theSherwood](https://github.com/theSherwood))

- [**Plain SPA**](https://github.com/johannschopplich/plain-spa) ([@johannschopplich](https://github.com/johannschopplich))

---

_See [complete docs](https://sinuous.netlify.app/docs/getting-started/), or in a nutshell..._

## View syntax

A goal Sinuous strives for is to have good interoperability. Sinuous creates DOM elements via **hyperscript** `h` calls. This allows the developer more freedom in the choice of the view syntax.

**Hyperscript** directly call `h(type: string, props: object, ...children)`.

**Tagged templates** transform the HTML to `h` calls at runtime w/ the ` html`` ` tag or,

at build time with [`sinuous/babel-plugin-htm`](./src/babel-plugin-htm).

**JSX** needs to be transformed at build time first with [`babel-plugin-transform-jsx-to-htm`](https://github.com/developit/htm/tree/master/packages/babel-plugin-transform-jsx-to-htm) and after with [`sinuous/babel-plugin-htm`](./packages/sinuous/babel-plugin-htm).

---

**Counter Example (_1.4kB gzip_) ([Codesandbox](https://codesandbox.io/s/sinuous-counter-z6k71))**

#### Tagged template (recommended)

```js

import { observable, html } from 'sinuous';

const counter = observable(0);

const view = () => html` 
Counter ${counter}
 `;

document.body.append(view());

setInterval(() => counter(counter() + 1), 1000);

```

#### JSX

```jsx

import { h, observable } from 'sinuous';

const counter = observable(0);

const view = () => 
Counter {counter}
;

document.body.append(view());

setInterval(() => counter(counter() + 1), 1000);

```

#### Hyperscript

```js

import { h, observable } from 'sinuous';

const counter = observable(0);

const view = () => h('div', 'Counter ', counter);

document.body.append(view());

setInterval(() => counter(counter() + 1), 1000);

```

## Reactivity

The Sinuous [`observable`](./src/observable) module provides a mechanism to store and update the application state in a reactive way. If you're familiar with [S.js](https://github.com/adamhaile/S) or [Mobx](https://mobx.js.org) some functions will look very familiar, in under `1kB` Sinuous observable is not as extensive but offers a distilled version of the same functionality. It works under this philosophy:

_Anything that can be derived from the application state, should be derived. Automatically._

```js

import { observable, computed, subscribe } from 'sinuous/observable';

const length = observable(0);

const squared = computed(() => Math.pow(length(), 2));

subscribe(() => console.log(squared()));

length(4); // => logs 16

```

#### Use a custom reactive library

Sinuous can work with different observable libraries; S.js, MobX, hyperactiv.

See the [wiki for more info](https://github.com/luwes/sinuous/wiki/Choose-your-own-reactive-library).

## Hydration

Sinuous [`hydrate`](./src/hydrate) is a small add-on that provides fast hydration of static HTML. It's used for adding event listeners, adding dynamic attributes or content to existing DOM elements.

In terms of performance nothing beats statically generated HTML, both in serving and rendering on the client.

You could say using hydrate is a bit like using [jQuery](https://jquery.com/), you'll definitely write less JavaScript and do more. Additional benefits with Sinuous is that the syntax will be more _declarative_ and _reactivity_ is built-in.

```js

import { observable } from 'sinuous';

import { hydrate, dhtml } from 'sinuous/hydrate';

const isActive = observable('');

hydrate(

  dhtml` isActive(isActive() ? '' : ' is-active')} />`

);


hydrate(dhtml``);

```

## Internal API

Sinuous exposes an internal API which can be overridden for fun and profit.

For example [sinuous-context](https://github.com/theSherwood/sinuous-context) uses it to implement a React like context API.

As of `0.27.4` the internal API should be used to make Sinuous work with a 3rd party reactive library like [Mobx](https://mobx.js.org). This can be done by overriding `subscribe`, `root`, `sample` and `cleanup`.

### Example

```js

import { api } from 'sinuous';

const oldH = api.h;

api.h = (...args) => {

  console.log(args);

  return oldH(...args);

};

```

### Methods

These are defined in [sinuous/src](./src/index.js) and [sinuous/h](./src/h.js).

- `h(type: string, props: object, ...children)`

- `hs(type: string, props: object, ...children)`

- `insert(el: Node, value: T, endMark?: Node, current?: T | Frag, startNode?: Node): T | Frag;`

- `property(el: Node, value: unknown, name: string, isAttr?: boolean, isCss?: boolean): void;`

- `add(parent: Node, value: Value | Value[], endMark?: Node): Node | Frag;`

- `rm(parent: Node, startNode: Node, endMark: Node): void;`

- `subscribe(observer: () => T): () => void;`

- `root(fn: () => T): T;`

- `sample(fn: () => T): T;`

- `cleanup unknown>(fn: T): T;`

Note that _some_ observable methods are imported into the internal API from `sinuous-observable` because they're used in Sinuous' core. To access all observable methods, import from `sinuous/observable` directly.

## Concept

Sinuous started as a little experiment to get similar behavior as [Surplus](https://github.com/adamhaile/surplus) but with template literals instead of JSX.

[HTM](https://github.com/developit/htm) compiles to an `h` tag. Adapted code from [Ryan Solid](https://github.com/ryansolid/babel-plugin-jsx-dom-expressions)'s dom expressions + a Reactive library provides the reactivity.

Sinuous returns a [hyperscript](https://github.com/hyperhype/hyperscript) function which is armed to handle the callback functions from the reactive library and updates the DOM accordingly.

## Contributors

### Code Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].



### Financial Contributors

Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/sinuous/contribute)]

#### Individuals



#### Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/sinuous/contribute)]