sigwork

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 32 Open GitHub ↗

A 1.7kb frontend framework that just works. The invisible fine-grained reactivity engine, designed for timeless interfaces.

다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Sigwork.

<p align="left">
  <strong>A frontend <a href="https://framework.thatjust.works" target="_blank">framework that just works</a>. The invisible granular reactive engine, designed for timeless interfaces.</strong>
</p>

## The Story

**Sigwork** was created to be the core of [That Just Works](https://thatjust.works) — an ecosystem of instant, zero-friction productivity tools.

We needed an engine that could load in milliseconds, had absolutely no Virtual DOM memory overhead, worked natively in the browser or bundled, and provided an API compatible with native JSX. Sigwork is the result of that engineering.

**The 2kb Pact:** Our strict architectural limit is 2kb gzipped. Currently at **1.7kb**, the framework already solves 99% of modern UI problems without the bloatware.

---

## Architectural Highlights

* 🪶 **Minuscule:** Smaller than most CSS resets or icon libraries.
* 🧠 **Signal based:** A solid reactivity system with a smart scope-effect tree that destroys effects from unmounted components without leaving memory leaks.
* 🎯 **Zero Virtual DOM:** Signals directly and surgically update the affected text node or attribute. The component never re-renders.
* 💨 **Buildless:** Can be used via CDN directly in the browser, no Node.js or bundlers required.
* 🔷 **TypeScript-first:** Full type definitions included, with JSX namespace support out of the box.

## Installation

```bash
npm install sigwork
```

### Official Documentation
Explore the full API, component references, and interactive examples at:  
👉 **[framework.thatjust.works/docs](https://framework.thatjust.works/docs)**

---

## Quick Start (JSX / Vite / ESBuild)

Configure your *JSX Pragma* in `tsconfig.json` or `vite.config.js`:
```json
{
  "jsx": "react",
  "jsxFactory": "h",
  "jsxFragmentFactory": "null"
}
```

```jsx
import Sigwork, { h, signal, computed } from 'sigwork';

const App = () => {
  const stress = signal(0);
  const status = computed(() => stress.value > 5 ? 'Overload' : 'Stable');

return (
    <div class="card">
      <h1>RPM: {() => stress.value}</h1>
      <p>Status: {() => status.value}</p>
      <button onClick={() => stress.value++}>Accelerate</button>
    </div>
  );
};

Sigwork(document.getElementById('app'), App);
```

## Buildless (Directly in the Browser)

Use Sigwork natively in the browser by pairing it with the `htm` library for a better experience:

```html
<!DOCTYPE html>
<html>
<body>
  <div id="app"></div>

Sigwork(document.getElementById('app'), App);
  </script>
</body>
</html>
```

Or you can use it without any additional library by using the `h(tag, {props}, ...children)` function:

```javascript
//...
      return h('div', {},
        h('h2', {}, () => count.value),
        h('button', { onClick: () => count.value++ }, "Add")
      );
//...
```

## Known Limitations

* **Single root per component:** Components must return a single root node. Using a fragment (`<>...</>`) as the root of a top-level component (passed directly to `Sigwork(target, root)`) is not supported — wrap it in an element instead. Fragments work normally as children inside other components.
* **Transition is not reversible mid-exit:** Once a `Transition` leave animation begins, the element is no longer managed by the reactive system. If the condition is reversed during the exit, a new element will appear rather than the outgoing one being recaptured.
* **Shared HTML/SVG tag names in SVG context:** Tags that exist in both HTML and SVG namespaces (`<a>`, `<style>`, `<script>`, etc.) are not supported inside SVG. Sigwork detects SVG by checking for `HTMLUnknownElement`, so these shared tags — which are valid HTML — will be created in the HTML namespace and silently fail inside an SVG tree.

---

## Contributing & License

Sigwork was designed to be audited in a single coffee reading. Contributions (that respect the 2kb limit, size is the priority) are extremely welcome.

**Author:** Murillo Brandão (@murillobrand)  
**License:** MIT

sigwork

다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

sigwork

다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README