lithent 1.20.1 → 1.21.0

package/README.md

@@ -1,342 +1,137 @@
+<img src="./lithentDocs/public/lithent.png" alt="Lithent" height="60" align="left" style="margin-right: 10px;" />
 
-## ➿ lithent
-> An extensible JSX-based virtual DOM library for lightweight use in a variety of environments.
+# Lithent &nbsp; [![npm version](https://img.shields.io/npm/v/lithent.svg)](https://www.npmjs.com/package/lithent) [![Bundle Size](https://img.shields.io/bundlephobia/minzip/lithent)](https://bundlephobia.com/package/lithent) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) [![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
 
+<br clear="left"/>
 
-![lithent-text](https://github.com/user-attachments/assets/a8848484-d315-4f81-be3b-61490d2be2b9)
+**Lithent is a JavaScript library for building lightweight, predictable UIs with familiar closure-based patterns.**
 
-![npm](https://img.shields.io/npm/v/lithent)
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/lithent)
-![npm](https://img.shields.io/npm/dt/lithent)
-![NPM](https://img.shields.io/npm/l/lithent)
+It trims away unnecessary magic and complex APIs so your UI code stays simple, explicit, and easy to reason about.
 
+<br />
 
+<div align="center">
 
+### 🚀 [Get Started](https://superlucky84.github.io/lithent/#/guide/quick-start) · 📖 [Documentation](https://superlucky84.github.io/lithent/#/) · 💡 [Examples](https://superlucky84.github.io/lithent/#/examples/1)
 
-- [Manual](https://medium.com/p/13d6fe6d3330)
-- [Korean Manual](https://medium.com/@superlucky84/lithent-전체-기능-설명서-3cfab04c0722)
-- [Home Page](https://superlucky84.github.io/lithent) - (This page is written in lithent.)
+</div>
 
-Lithent were developed to make it easy to insert Virtual DOM component
-fragments into pages already drawn with SSR, and are intended to be
-used lightly in a variety of situations.
+<br />
 
-`(lithent.mjs  14.25 kB │ gzip: 4.49 kB │ map: 59.74 kB)`
-`(lithent.umd.js  10.39 kB │ gzip: 4.03 kB │ map: 58.16 kB)`
+## Why Lithent?
 
-## 🚩 Table of Contents
-- [Thanks for the introduction](#thanks-for-the-introduction)
-- [Why Use Lithent](#why-use-lithent)
-- [Basic Guide](#basic-guide)
-- [Lithent Ssr Boilerplate](#lithent-ssr-boilerplate)
-- [How To Install](#how-to-install)
-  - [Use NPM](#use-npm)
-  - [Use CDN](#or-use-cdn)
-  - [With JSX](#with-jsx)
-  - [With FTAGS](#with-ftags)
-  - [With HTM](#with-htm)
-- [Examples](#examples)
-  - [With ESM](#with-esm)
-  - [With UMD](#with-umd)
-- [Context API](#context-api)
-  - [Multi-value Provider Example](#multi-value-provider-example)
-- [Related Projects](#related-projects)
-- [Develop Guide](#develop-guide)
-- [Test](#test)
+**Lightweight DOM manipulation without the framework weight.** The 4KB core drives complete UIs. Need state management? Opt into helpers like expansion packs instead of adopting a full stack.
 
-## Thanks for the introduction
-- [unsuckjs](https://unsuckjs.com/)
-- [jster](https://jster.net/blog/jster-198/)
-- [webtoolsweekly](https://webtoolsweekly.com/archives/issue-531/)
+Bring in only what you need — let the stack scale with your project.
 
-## Why use Lithent?
+**Design philosophy:**
+- **Small Bundle** — 4KB core with optional extensions
+- **Closure-based State** — No magic, just JavaScript
+- **Manual or Reactive** — Choose your update strategy
+- **Progressive Enhancement** — From static HTML to full SPA
 
-### Lithent have the bare minimum of necessary functionality, with no unnecessary features.
+<br />
 
-In a real-world development environment, you may want to use Virtual DOM lightly, with only the bare minimum of core functionality.
+## Quick start
 
-"Lithent" makes it easy to add, remove, and update virtual DOM to specific parts of a pre-drawn SSR page.
-
-"Lithent" has implemented the bare minimum functionality needed to create and update virtual DOM in general (we only need to know 'render', 'mounter', 'updater', 'renewer', 'mountCallback', and 'updateCallback').
-
-We provide code in the form of 'helpers' that extend the basic functionality, but using the helpers is only optional and users can extend and develop custom helpers for their own projects.
-
-### Approach with the developer-friendly concept of closures between "component mounter" and "renderer"
-
-JavaScript users are used to using closures and love to develop with them.
-
-"Lithent" provides a familiar approach to my JavaScript development, as it leverages the properties of higher-order functions and closures to define and recycle the state of a component.
-
-## Basic Guide
-
-- https://superlucky84.github.io/lithent/
-
-## Lithent Ssr Boilerplate
-
-`Lithent-Ssr-Boilerplate` is a boilerplate designed for building server-side rendering (SSR) websites using the [Lithent](https://superlucky84.github.io/lithent/) UI library.
-
-* [README](https://github.com/superlucky84/lithent/tree/master/createLithent#readme)
+### Create a new project
 
 ```bash
-npx create-lithent-ssr@latest
+npx create-lithent@latest
 ```
 
+Pick a project name and template (SSR/SPA) and you’re ready to go.
 
-## How To Install
-
-#### Use NPM
+### Install via npm
 
 ```bash
-pnpm add lithent
+npm install lithent
 ```
 
-#### Or Use CDN
-
-* UMD : https://cdn.jsdelivr.net/npm/lithent@1.20.1/dist/lithent.umd.js
-* UMD-HELPER: https://cdn.jsdelivr.net/npm/lithent@1.20.1/helper/dist/lithentHelper.umd.js
-* UMD-FTAGS: https://cdn.jsdelivr.net/npm/lithent@1.20.1/ftags/dist/lithentFTags.umd.js
-* UMD-TAG: https://cdn.jsdelivr.net/npm/lithent@1.20.1/tag/dist/lithentTag.umd.js
-* ESM : https://cdn.jsdelivr.net/npm/lithent@1.20.1/dist/lithent.mjs
-* ESM-HELPER: https://cdn.jsdelivr.net/npm/lithent@1.20.1/helper/dist/lithentHelper.mjs
-* ESM-FTAGS: https://cdn.jsdelivr.net/npm/lithent@1.20.1/ftags/dist/lithentFTags.mjs
-* ESM-TAG: https://cdn.jsdelivr.net/npm/lithent@1.20.1/tag/dist/lithentTag.mjs
-
-
-It's easier to use lithent with JSX or HTM.
-
-#### With JSX
-
-* Lithent is built on top of JSX.
-  * [Setting Guide](https://superlucky84.github.io/lithent/#install)
+### Use directly from a CDN
 
-
-#### With FTAGS
-
-You don't need to use h functions or JSX, you can call functions to mark them up.
-When creating a component, use `fMount` instead of `mount`.
-When creating a fragment, use `fFragment` instead of `Fragment`.
-
-```ts
-/* ESM */
-import { render, h } from 'lithent';
-import { fTags, fFragment, fMount } from 'lithent/ftags';
-
-const { section, div, p, br, strong } = fTags;
-
-/* UMD
-<script src="https://cdn.jsdelivr.net/npm/lithent@1.20.1/dist/lithent.umd.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/lithent@1.20.1/helper/dist/lithentHelper.umd.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/lithent@1.20.1/ftags/dist/lithentFTags.umd.js"></script>
-
-const { render } = lithent;
-const { fTags, fMount, fFragment } = lithentFTags;
-const { section, div, p, br, strong } = fTags;
-*/
-
-const fTagComponent = fMount<{ firstProp: number }>((_r, props, children) => {
-  return () =>
-    fFragment(
-      'first inner',
-      div({ style: { border: '1px solid red' } }, 'second inner'),
-      div('The props argument can be omitted.'),
-      props.firstProp,
-      ...children
-    );
-});
-
-render(
-  fTagComponent(
-    { firstProp: 3 }, // The props argument can be omitted.
-    div({ style: { border: '1px solid green' } }, `Fchildren1`),
-    'Fchildren2',
-    br()
-  ),
-  document.getElementById('root')
-);
-```
-
-#### With HTM
-
-- [Htm Github](https://github.com/developit/htm)
-
-```js
-import { lTag } from 'lithent/tag';
-const destroy = render(lTag`<${Component} />`, document.getElementById('root'), document.getElementById('#insert-before-this-element'));
+```html
+<script src="https://cdn.jsdelivr.net/npm/lithent/dist/lithent.umd.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/lithent/ftags/dist/lithentFTags.umd.js"></script>
 ```
 
+> **[📦 View all available CDN URLs](https://superlucky84.github.io/lithent/#/guide/quick-start)**
 
-## Examples
-
-- [More Examples](https://superlucky84.github.io/lithent/#examples)
+<br />
 
-#### With ESM
-```js
-import { h, render, mount, Fragment } from 'lithent';
-import { lTag } from 'lithent/tag';
-import { state } from 'lithent/helper';
+## Two ways to build components
 
-const Component = mount((renew, _props) => {
-  const count = state(0, renew);
+Lithent offers two complementary styles you can freely mix in the same project.
 
-  const change = () => {
-    count.value += 1;
-  };
-
-  // Updater
-  return () => lTag`
-    <${Fragment}>
-      <li>count: ${count.value}</li>
-      <button onClick=${change}>increase</button>
-    <//>
-  `;
-});
-
-// appendChild or insertBefore
-// The third argument is an optional value for insertBefore.
-const destroy = render(lTag`<${Component} />`, document.getElementById('root'), document.getElementById('#insert-before-this-element'));
-```
-
-#### With UMD
+**Manual Mode** — Explicit control with `renew()`
+```tsx
+import { mount } from 'lithent';
 
-```html
-<script src="https://cdn.jsdelivr.net/npm/lithent@1.20.1/dist/lithent.umd.js"></script>
-<!--script src="https://cdn.jsdelivr.net/npm/lithent@1.20.1/helper/dist/lithentHelper.umd.js"></script-->
-<script src="https://cdn.jsdelivr.net/npm/lithent@1.20.1/tag/dist/lithentTag.umd.js"></script>
-<!--script src="https://cdn.jsdelivr.net/npm/lithent@1.20.1/ftags/dist/lithentFTags.umd.js"></script-->
-
-<div id="root"></div>
-
-<script>
-const { h, Fragment, render, mount } = lithent;
-const { lTag } = lithentTag;
-// const { state } = lithentHelper;
-
-const Component = mount(renew => {
-  count = 0;
-
-  const change = () => {
-    count += 1;
-    renew();
-  };
-
-  // Updater
-  return () => lTag`
-    <${Fragment}>
-      <li>count: ${count}</li>
-      <button onClick=${change}>increase</button>
-    <//>
-  `;
+const Counter = mount(renew => {
+  let count = 0;
+  return () => <button onClick={() => { count++; renew(); }}>{count}</button>;
 });
-
-// appendChild or insertBefore
-// The third argument is an optional value for insertBefore.
-const destroy = render(lTag`<${Component} />`, document.getElementById('root'), document.getElementById('#insert-before-this-element'));
-</script>
 ```
 
-## Context API
-
-Lithent-helper ships a lightweight context system so you can share state without manual prop drilling. Providers stay isolated from consumer renews and you can subscribe to every key or only the slices you need.
-
-### Multi-value Provider Example
-
+**Light API Mode** — Automatic reactivity
 ```tsx
-import { h, mount } from 'lithent';
-import { createContext } from 'lithent-helper';
-
-type AppState = { user: string; theme: string; count: number };
-
-const AppContext = createContext<AppState>();
-const { Provider, contextState, useContext } = AppContext;
-
-const AppProvider = mount((_renew, _props, children) => {
-  // Provider owns the shared state; consumers cannot trigger its renew directly.
-  const user = contextState('Alice');
-  const theme = contextState('dark');
-  const count = contextState(0);
-
-  return () => (
-    <Provider user={user} theme={theme} count={count}>
-      {children}
-    </Provider>
-  );
-});
+import { lmount } from 'lithent';
+import { lstate } from 'lithent/helper';
 
-const StatsPanel = mount(renew => {
-  // Omitting the subscribe list subscribes to every value exposed by the Provider.
-  const ctx = useContext(AppContext, renew);
-  return () => (
-    <section>
-      <p>User: {ctx.user?.value}</p>
-      <p>Theme: {ctx.theme?.value}</p>
-      <p>Count: {ctx.count?.value}</p>
-      <button onClick={() => ctx.count && (ctx.count.value += 1)}>
-        Increment
-      </button>
-      <button onClick={() => ctx.count && (ctx.count.value = 3)}>
-        Set count to 3
-      </button>
-    </section>
-  );
-});
-
-const ThemeBadge = mount(renew => {
-  // Subscribe only to the theme key; user/count updates will not rerender this component.
-  const ctx = useContext(AppContext, renew, ['theme']);
-  return () => <span>Theme: {ctx.theme?.value}</span>;
-});
-
-const App = mount(() => {
-  return () => (
-    <AppProvider>
-      <StatsPanel />
-      <ThemeBadge />
-    </AppProvider>
-  );
+const Counter = lmount(() => {
+  const count = lstate(0);
+  return () => <button onClick={() => count.value++}>{count.value}</button>;
 });
 ```
 
-## Related Projects
-- [htm](https://www.npmjs.com/package/htm) - making **H**yperscript **T**agged **M**arkup possible
+> **[📚 Explore component patterns in detail](https://superlucky84.github.io/lithent/#/guide/mounter)**
 
-## Develop Guide
+<br />
 
-It's open source, so you can develop and contribute together.
+## Key features
 
-### pnpm install (this project was created using pnpm.)
+### Core
+- **mount / lmount** — Component initialization
+- **Portal** — Render outside parent DOM
+- **Hooks** — Lifecycle callbacks (`mountCallback`, `updateCallback`, `mountReadyCallback`)
+- **Ref** — Direct DOM access
 
-```bash
-npm install -g pnpm
-```
+### Helpers (optional)
+- **state / lstate** — Reactive state management
+- **computed** — Derived values
+- **effect** — Side effects
+- **store / lstore** — Global state
+- **context / lcontext** — Cross-component data sharing
 
-### project install
+### Template options
+- **JSX** — Via Vite plugin
+- **FTags** — Function-style tags (no build step)
+- **HTM** — Tagged template literals
+- **Template Strings** — Custom templates
 
-```bash
-git clone https://github.com/superlucky84/lithent.git
+> **[📖 View full API reference](https://superlucky84.github.io/lithent/#/)**
 
-cd lithent
+<br />
 
-pnpm install
-```
+## Ecosystem
 
-### project build
+| Package | Description |
+|--------|-------------|
+| [lithent](https://www.npmjs.com/package/lithent) | Core library (~4KB) |
+| [lithent/helper](https://www.npmjs.com/package/lithent) | Reactive state helpers |
+| [lithent/ssr](https://www.npmjs.com/package/lithent) | Server‑side rendering |
+| [lithent/ftags](https://www.npmjs.com/package/lithent) | Function‑style tag API |
+| [lithent/tag](https://www.npmjs.com/package/lithent) | HTM template support |
+| [create-lithent](https://www.npmjs.com/package/create-lithent) | Project scaffolding tool |
 
-```bash
-pnpm build
-```
+<br />
 
-### Running the development environment
+## License
 
-```bash
-pnpm dev // or pnpm dev:core
-```
+[MIT](LICENSE) © [superlucky84](https://github.com/superlucky84)
 
-## Test
+<br />
 
-> To fully test everything, including plugins like helper and ftags, a build is required.
-
-```bash
-pnpm install
-pnpm build
-pnpm test
-```
+<div align="center">
+  <sub>Built with ❤️ by the Lithent community</sub>
+</div>

package/dist/hook/useRenew.d.ts

@@ -0,0 +1,6 @@
+import { Renew } from '../types';
+/**
+ * Hook to get the renew (component update) function.
+ * Useful for lmount components that need to trigger updates.
+ */
+export declare const useRenew: () => Renew;

package/dist/index.d.ts

@@ -1,14 +1,15 @@
 import type { Props } from './types';
-export { h, Fragment, portal, mount, replaceWDom } from './wDom';
+export { h, Fragment, portal, mount, lmount, replaceWDom } from './wDom';
 export { isPropType } from './utils';
 export { componentUpdate } from './utils/redraw';
-export { getComponentKey, componentMap, getComponentSubInfo, setComponentMapManualMode, disposeComponentEntry, } from './utils/universalRef';
+export { getComponentKey, componentMap, getComponentSubInfo, setComponentMapManualMode, disposeComponentEntry, lmountComponentSet, } from './utils/universalRef';
 export { render } from './render';
 export { mountCallback } from './hook/mountCallback';
 export { mountReadyCallback } from './hook/mountReadyCallback';
 export { updateCallback } from './hook/updateCallback';
 export { ref, nextTick } from './hook/ref';
-export type { WDom, TagFunction, TagFunctionResolver, FragmentFunction, Component, ComponentSubKey, ComponentMap, ComponentInfo, CompKey, Props, Renew, MiddleStateWDomChildren, MiddleStateWDom, NodePointer, Param, } from './types';
+export { useRenew } from './hook/useRenew';
+export type { WDom, TagFunction, TagFunctionResolver, FragmentFunction, Component, LComponent, ComponentSubKey, ComponentMap, ComponentInfo, CompKey, Props, Renew, MiddleStateWDomChildren, MiddleStateWDom, NodePointer, Param, } from './types';
 declare global {
     namespace JSX {
         interface IntrinsicElements {