skruv

v0.7.3

Published

a year ago

No-dependency, no-build, small JS framework

Downloads

0High
0Medium
0Low

svanterichter

skruv

No-dependency, no-build, small JS view-library/framework-ish-thing.

Features • Examples • Docs

Github • NPM

Features

No dependencies
Small:
- Smallest framework in krausest benchmarks
- ~200 LOC
- ~1kb minified and compressed (1142b with brotli, 1314b with gzip, 2819b uncompressed)
Usable without bundling/compilation/transpilation
Supports HTML, SVG, MathML, Atom feeds and sitemaps.
- Types to validate attributes and children
Plenty fast enough: faster than react and angular, comparable to svelte or preact
Works with web components
Optional helper utilities for
- State management (state.js)
- Async generators or promises as components (syncify.js)
- SSR/SSG without jsdom/puppeteer (minidom.js)
- CSS scoping (css.js)
- Optionally supports JSX (via @skurv/jsx or @skruv/jsx-react)
  - or HTM as in htm example
- Bundling/minification (bundle.js, requires esbuild)

Examples

Basic todo-list (with state, css scoping and jsx)

{% include_relative examples/todo/index.md %}

import { render } from 'skruv'
import { css, cssTextGenerator } from 'skruv/utils/css.js'
import { createState } from 'skruv/utils/state.js'
import { syncify } from 'skruv/utils/syncify.js'

const state = createState({ todos: ['Write todos'] })

const styles = css`
  :scope {
    color: #f1f1f1;
    background: #0f0f0f;
  }

  body {
    max-width: 40ch;
    margin: 0 auto;
  }

  form { display: flex; }
  input { flex: 1; }
  a { color: #9b9b9b; }
`

render(
  syncify(
    <html lang="en-US" class={styles}>
      <head>
        <title>{state.todos.getGenerator(0)}</title>
        <meta name="viewport" content="width=device-width, initial-scale=1" />
        <style>{cssTextGenerator}</style>
      </head>
      <body>
        <main>
          <h1>{state.todos.getGenerator(0)}</h1>
          <form
            onsubmit={
              e => {
                e.preventDefault()
                const todo = new FormData(e.currentTarget).get('todo')
                  ?.toString()
                if (todo !== undefined) { state.todos.unshift(todo) }
                e.currentTarget.reset()
              }
            }
          >
            <input name="todo"></input>
            <button>New!</button>
          </form>
          <ol>
            {async function * () {
              for await (const todos of state.todos) {
                yield todos.map((todo, i) => (
                  <li>{todo} <a
                    href="#"
                    onclick={e => {
                      e.preventDefault()
                      todos.splice(i, 1)
                    }}
                  >x</a>
                  </li>
                ))
              }
            }}
          </ol>
        </main>
      </body>
    </html>
  )
)

Same example using just the core library, without bundling. It does mostly the same thing, with the differences being:

Not using JSX, instead destructing elementFactory to get element constructors
Manually calling doRender after each state change
Directly setting the css in a style element instead of getting a scoped class {% include_relative examples/todo-core/index.md %}

import { elementFactory, render } from '../../skruv.js'

const { html, head, title, meta, body, main, h1, form, input, button, ol, li, a, style } = elementFactory

const state = {
  todos: ['Write todos']
}

const styles = /* css */`
  :scope {
    color: #f1f1f1;
    background: #0f0f0f;
  }

  body {
    max-width: 40ch;
    margin: 0 auto;
  }

  form { display: flex; }
  input { flex: 1; }
  a { color: #9b9b9b; }
`

const doRender = () => render(
  html({ lang: 'en-US' },
    head(
      title(state.todos[0]),
      meta({ name: 'viewport', content: 'width=device-width, initial-scale=1' }),
      style(styles)
    ),
    body(
      main(
        h1(state.todos[0]),
        form({
          onsubmit: e => {
            e.preventDefault()
            const todo = new FormData(e.currentTarget).get('todo')
              ?.toString()
            if (todo) { state.todos.unshift(todo) }
            e.currentTarget.reset()
            doRender()
          }
        },
        input({
          name: 'todo'
        }),
        button('New!')
        ),
        ol(
          state.todos.map((todo, i) => li(
            `${todo} `,
            a({
              href: '#',
              onclick: e => {
                e.preventDefault()
                state.todos.splice(i, 1)
                doRender()
              }
            }, 'x')
          ))
        )
      )
    )
  )
)
doRender()

Docs

The core of skruv is the render function. It takes a structure created by elementFactory and optionally which DOM node to write to. It has built in support and typings for HTML, SVG, MathML, Atom feeds (why not RSS?) and sitemaps. Since some elements exist in multiple namespaces these elements are prefixed with their type: svgA svgScript svgStyle svgTitle atomTitle atomLink atomSummary atomSource. For usage in SSR you can also create comments using the element name skruvComment and raw output with skruvText (useful if you want to output stuff like a robots.txt or JSON at the root node or as a root node when the root node is unknown). All elements starting with skruv will be skipped in client side rendering. Headers can be set using the skruvHeader element using the attributes name and value with the special header status being used to set http status.

Besides the normal attributes there are the following for skruv-specific use:

skruvWaitForNotEmpty: If you swap one generator for another or similar async work you might want to keep the old children until new ones are ready to prevent flicker. Tag the parent element with skruvWaitForNotEmpty: true and skruv will not clear the dom children until there are new children to render. Use only when you know an element should never be without children.
skruvKey: Any object/array, will be used to allow the element to move (instead of being recreated) and will be shallow-diffed on updates to allow for skipping re-rendering this node if not changed. If you want to keep children injected by other libraries make sure to not change the key.
skruvFinished: If you want to mark the result of a async task as incomplete (like for example a loader icon) you can give it the attribute skruvFinished: false and it will not be considered complete until we get a new element without that attribute.
skruvAfterCreate: A function called with the element after it is created, with the element as its argument. Useful for attaching other libraries to the dom node. If you want the same thing but for removal you can set a timer in the callback and check document.documentElement.contains().

Utilities:

css.js: If you want to use scoped css you can import the css tagged template function and it's corresponding cssTextGenerator. The result of the css`` call is a classname and cssTextGenerator will resolve with the full css for the application, prefixed with the classname for each scope. The styles are deduplicated so you can use it in components that you might use in multiple places.
- implementation is adapted from https://github.com/samthor/scoped
syncify.js: If you want to use async components you pull in the syncify function that takes care of scheduling render updates. It will only schedule a render on the specific part of the DOM that was affected by the async component, making it quite efficient.
state.js: If you want an easy to use state management you pull in the createState function which takes in an object and gives you a recursive generator that will listen to any changes to the state object.
- createState takes in a object and returns a proxy which is also an async generator.
- You modify the state by using normal methods (including things like delete, splice, etc.).
- Where you want to subscribe to state changes you use for-await-of.
- You can subscribe to sub-objects with for await (const bar of state.foo.bar).
- As a shortcut you can call state.getGenerator(key) to subscribe to and output a single value.
  - This is useful to output primitive values (like strings/numbers etc.) in for example text or attributes without requiring a whole generator function
minidom.js: SSR/SSG examples are bundled in this repo, they use the minidom utility to polyfill what is needed to use skruv in node/deno and serialize the DOM to HTML.
- uses cssom.js (ported from https://github.com/NV/CSSOM) to polyfill the CSS object model to work with css.js

Other packages:

@skruv/jsx: The default jsx runtime
@skruv/jsx-react: The default jsx runtime, but with compatability for react-style attributes like className, onClick, etc.

Scoped CSS

{% include_relative examples/scopedcss/index.md %}

import { elementFactory, render } from '../../skruv.js'
import { css, cssTextGenerator } from '../../utils/css.js'
import { syncify } from '../../utils/syncify.js'

const { title, html, head, meta, body, div, p, style } = elementFactory

const rootStyles = css`
  :scope {
    color: #f1f1f1;
    background: #0f0f0f;
  }
`

const scopedStyles = css`
  :scope { border: 1px solid #aaa; }
  p { color: #aaa; }
`

render(
  syncify(
    html({ lang: 'en-US', class: rootStyles },
      head(
        title('scopedcss'),
        meta({ name: 'viewport', content: 'width=device-width, initial-scale=1' }),
        style(cssTextGenerator)
      ),
      body(
        div({ class: scopedStyles },
          p('Hello')
        ),
        div(
          p('World!')
        )
      )
    )
  )
)

JSX

{% include_relative examples/jsx/index.md %} Compiled with esbuild: esbuild --sourcemap --bundle --minify --format=esm --jsx-import-source=@skruv/jsx --jsx=automatic index.jsx --outfile=index.js or with the included bundler script to allow for http imports and css template minification.

By default skruv JSX mimics normal HTML. If you want to use react-style attribute names (like onClick, className, etc.) you can install skruv-react and set the --jsx-import-source to it.

import { render } from 'skruv'

const styles = /* css */`
  :root {
    color: white;
    background: #0f0f0f;
  }
`
// @ts-ignore
const Component = props => (<div label={props.a}>{props.children}</div>)

render(
  <html lang="en-US">
    {/* Fragments work too, but are usually not needed. */}
    <>
      <head>
        <title>jsx</title>
        <meta name="viewport" content="width=device-width, initial-scale=1" />
        <style>{styles}</style>
      </head>
    </>
    <body>
      <Component a="A component attribute">
        <p>A component child</p>
      </Component>
      <div>
        <p>Hello world</p>
      </div>
    </body>
  </html>
)

SSG/SSR

The example folder ssr contains SSR examples for both node and deno. They both use the minidom util to polyfill a "browser-ish" environment. Primarily it mimics the DOM, the CSS object model, the Location interface, EventSource. It also has utils to stringify the html and reset the DOM.

Since most resulting apps will be very small (this one is under 4kb after compression) we inline it into the html here, but there would be no problem to link the script normally. Weigh the pros and cons for your use-case.

This is the node ssr server is started with skruv-ssr ./index.min.js, look in utils/ssr.js to see how it works. It should be easily adaptable to any nodejs server. skruv-ssr-dev is a dev server that behaves similarly to skruv-ssr, but with automatic rebuilding of the source files and live reload run it with skruv-ssr-dev ./index.ts index.min.js.

Or to just render it to a file with skruv-ssg 'https://skruv.io/' index.min.js index.html where the arguments are the location to render, the app file and the output path.

The index.js used here looks like this:

import { elementFactory, render } from '../../skruv.js'
import { css, cssTextGenerator } from '../../utils/css.js'
import { createState } from '../../utils/state.js'
import { hydrationPromise, syncify } from '../../utils/syncify.js'

// eslint-disable-next-line max-len
const { html, head, title, meta, link, body, main, h1, form, label, input, button, ol, li, a, style, script, skruvText: text, skruvComment: comment, skruvHeader: header } = elementFactory

const state = createState({
  todos: ['Write todos']
})

const styles = css`
  :scope {
    color: #f1f1f1;
    background: #0f0f0f;
  }

  body {
    max-width: 40ch;
    margin: 0 auto;
  }

  form {
    display: flex;
    align-items: end;
  }
  label { flex: 1; }
  input { width: 100%; }
  a { color: #9b9b9b; }
`

const dom = syncify(
  html({ lang: 'en-US', class: styles },
    head(
      // @ts-expect-error: SKRUV_1
      title(state.todos.getGenerator(0)),
      meta({ name: 'viewport', content: 'width=device-width, initial-scale=1' }),
      style(cssTextGenerator),
      link({ rel: 'icon', href: '/icon.svg', type: 'image/svg+xml', sizes: 'any' }),
      meta({ name: 'description', content: 'Skruv todo-list' })
    ),
    body(
      main(
        // @ts-expect-error: SKRUV_1
        h1(state.todos.getGenerator(0)),
        form({
          onsubmit: e => {
            e.preventDefault()
            const todo = new FormData(e.currentTarget).get('todo')
              ?.toString()
            if (todo) { state.todos.unshift(todo) }
            e.currentTarget.reset()
          }
        },
        label(
          'What do you need to do?',
          input({
            type: 'text',
            name: 'todo'
          })
        ),
        button('New!')
        ),
        async function * () {
          for await (const currentState of state) {
            yield ol(
              currentState.todos.map((todo, i) => li(
                `${todo} `,
                a({
                  href: '#',
                  onclick: e => {
                    e.preventDefault()
                    currentState.todos.splice(i, 1)
                  }
                }, 'x')
              ))
            )
          }
        }
      ),
      text('test'),
      comment('test'),
      header({
        name: 'x-test',
        value: 'test'
      }),
      // @ts-expect-error
      !!globalThis.skruvSSRScript && script({ type: 'module' }, globalThis.skruvSSRScript)
    )
  )
)

const doRender = async () => {
  await hydrationPromise
  render(dom)
}

doRender()

export default doRender

The important parts are

the doRender function which waits for the hydrationPromise from syncify. This makes sure that all async work has finished before rendering, so that we both get a complete document on the server, but also that we don't overwrite any existing parts of the document with incomplete parts on the client.
the script which contains globalThis.skruvSSRScript, which injects the js for the application

The result can be seen here and a non-built version is here for comparison. In mobile lighthouse testing the SSR:ed version gets a 100 and the nobuild version gets a 90.

Open issues

[ ] SKRUV_1: Handle state typing better after https://github.com/microsoft/TypeScript/issues/43826 is resolved

TODO:

[ ] Add template repo
- [ ] One basic
- [ ] One with postgrest backend, nginx frontend and SSR
[ ] SSR/SSG fetcher cache example
[ ] Automated tests with all MDN examples
[ ] Docs:
- [ ] Loader
- [ ] generator utils
- [ ] Using alternate DOM implementations (jsDOM, etc.)
[ ] Testing:
- [ ] Proper HTTP testing of the SSR stuff, including performance
[ ] Generalize and finish:
- [ ] Channel (SSE helper)
- [ ] Router
  - Local (via regex) (see example repo)
  - Remote (via postgrest)
- [ ] Fetcher
[ ] Loader example:

  .loader {
    width: 100%;
    object-fit: contain;
  }

  canvas({
    class: 'loader',
    width: "1080",
    height: "1080",
    oncreate: (c) => {
      const x = c?.getContext?.("2d")
      if (!x) return
      const S = Math.sin
      const C = Math.cos
      const T = Math.tan
      const R = (r,g,b,a = 1) => `rgba(${r}, ${g}, ${b}, ${a})`
      const start = Date.now()
      let t = 0
      const color = getComputedStyle(c).getPropertyValue("color");
      const loopFunc = () => {
        t = (Date.now() - start) / 1000
        let f;
        // Other options:
        // https://www.dwitter.net/d/2108
        // https://www.dwitter.net/d/17835
        // https://www.dwitter.net/d/26739

        // code from dwitter https://www.dwitter.net/d/17835
        // @ts-expect-error
        c.width|=f=(X,Y,w)=>X*X+Y*Y<=2e6*S(t/9)**2?w>9&&f(X,Y,w/=2)|f(X+w,Y,w)|f(X,Y+w,w)|f(X+w,Y+w,w):(()=>{x.strokeStyle=color;x.strokeRect(X,Y,w,w)})();f(x.lineWidth=4,4,1072)
        if (document.contains(c)) requestAnimationFrame(loopFunc)
      }
      const loop = requestAnimationFrame(loopFunc)
    }
  }, 'Loading content')

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

skruv

Features

Examples

Basic todo-list (with state, css scoping and jsx)

Docs

Scoped CSS

JSX

SSG/SSR

Open issues

TODO: