Minimal JavaScript UI Library
Go to file
Geoff Doty 8d88102170 dist 2024-07-20 16:47:43 -04:00
.github/workflows github actions 2024-05-22 13:47:12 -04:00
dist dist 2024-07-20 16:47:43 -04:00
example start to refine/expand example todo 2024-07-20 16:45:38 -04:00
src dom diffing for more effecent rerendering 2024-07-20 16:22:06 -04:00
.gitignore first pass 2024-05-04 20:34:27 -04:00
LICENSE Initial commit 2024-05-04 20:31:29 -04:00
README.md dom diffing for more effecent rerendering 2024-07-20 16:22:06 -04:00
deno.json dist 2024-07-20 16:47:43 -04:00
deno.lock replace makefile with deno tasks 2024-05-22 14:28:22 -04:00
index.js dom diffing for more effecent rerendering 2024-07-20 16:22:06 -04:00

README.md

Um

Minimal JavaScript UI Builder

Um, is an experimental composable UI builder that takes ideas from early hyperapp design, but does not stick to strict Elm Architecture.

Um, because you should think about, um, NOT using it.

Features

Install

Via JSDelivr CDN

import {app,h} from "https://cdn.jsdelivr.net/gh/n2geoff/um/dist/um.min.js";

Overview

Um only has 2 exported functions, app() and h(), and the later is optional.

app({opts})

The app() is the builder function and takes an opts object:

Input:

Property Default Description
state {} initial data state
actions {} function object passed to view
view (state, actions) => null function that takes state and actions and returns valid dom
mount body valid query selector as mounting point

Output:

Interface with internal state for utility expansion

Property Description
state internal state object
update() function to render dom state

h(tag, [...args])

The h() is an optional hypertext build utility that weighs in around ~250b and is provided as a way to build out your view DOM, but you can build your view using any method you like as long as it returns valid DOM.

Example

    <script type="module">
        import {app, h} from "./um.min.js";

        const myapp = app({
            state: {name: "[Your Name Here]", job: "Developer"},
            view(state, actions) {
                return h("main", [
                    h("strong", `Greeting from ${state.name}`),
                    h("div", `Your local ${state.job}`),
                    h("div", {id: "test"}, [
                        h("h1", "Um, Hello"),
                        h("p", 21),
                        h("hr")
                    ])
                ]);
            }
        });
    </script>

Notes

WORK-IN-PROGRESS

TODO

  • Some tag attributes do not work, like rowspan on td
  • Rethink State Management, might be ok