npm - cajoa - Versions diffs - 0.6.0 → 0.8.0 - Mend

cajoa 0.6.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/LICENSE CHANGED Viewed

@@ -1,201 +1,201 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-   1. Definitions.
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-   END OF TERMS AND CONDITIONS
-   APPENDIX: How to apply the Apache License to your work.
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-   Copyright [yyyy] [name of copyright owner]
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-       http://www.apache.org/licenses/LICENSE-2.0
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+   1. Definitions.
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+   END OF TERMS AND CONDITIONS
+   APPENDIX: How to apply the Apache License to your work.
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+   Copyright [yyyy] [name of copyright owner]
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md CHANGED Viewed

@@ -1,223 +1,273 @@
-# Cajoa
-A small, beginner-friendly frontend framework built on **signals** and **JSX**.
-No virtual DOM, no hooks rules, no re-rendering components.
-> ⚠️ **v0.6 (early stage).** The API may still change. Not production-ready yet.
-## Why Cajoa?
-- **Components run once.** A component is just a function that builds DOM. Only the parts that depend on a signal update.
-- **Plain JSX.** Write `<button onClick={...}>`, no special syntax to learn.
-- **Tiny and readable.** The whole core is small enough to read in one sitting.
-- **TypeScript-first**, ESM + CommonJS, zero runtime dependencies.
-## Install
-```bash
-npm create cajoa@latest my-app
-```
-## Setup (JSX)
-In your `tsconfig.json`:
-```json
-{
-  "compilerOptions": {
-    "jsx": "react-jsx",
-    "jsxImportSource": "cajoa"
-  }
-}
-```
-If you use Vite and your JSX is not transformed, also set it in `vite.config.ts`
-(`oxc: { jsx: { runtime: "automatic", importSource: "cajoa" } }` on newer Vite,
-or `esbuild: { jsx: "automatic", jsxImportSource: "cajoa" }` on older ones).
-## Quick start
-```tsx
-import { createSignal, render } from "cajoa";
-function Counter() {
-  const [count, setCount] = createSignal(0);
-  return (
-    <button onClick={() => setCount((c) => c + 1)}>
-      Clicked {count} times
-    </button>
-  );
-}
-render(Counter, document.getElementById("app")!);
-```
-## Two rules to remember
-Cajoa has no compiler, so JSX expressions run exactly once. That gives two rules:
-1. **Pass the signal, don't call it.**
-   `{count}` is reactive. `{count()}` is read once and never updates.
-   For computed values, pass a function: `{() => count() * 2}`.
-2. **`Show` children are a function.**
-   `<Show when={on}>{() => <p>Hello</p>}</Show>`
-   Otherwise the element is created even when it is hidden.
-## Lists and conditions
-```tsx
-import { createSignal, Show, For } from "cajoa";
-const [todos, setTodos] = createSignal([{ id: 1, text: "Learn Cajoa" }]);
-<Show when={() => todos().length > 0} fallback={() => <p>Nothing to do.</p>}>
-  {() => (
-    <ul>
-      <For each={todos}>{(todo) => <li>{todo.text}</li>}</For>
-    </ul>
-  )}
-</Show>;
-```
-## Routing
-```tsx
-import { render, Router, Route, Link, useParams } from "cajoa";
-const User = () => <h1>User {useParams().id}</h1>;
-render(
-  () => (
-    <div>
-      <nav>
-        <Link href="/">Home</Link> <Link href="/users/7">User 7</Link>
-      </nav>
-      <Router>
-        <Route path="/" component={() => <h1>Home</h1>} />
-        <Route path="/users/:id" component={User} />
-        <Route path="*" component={() => <h1>Not found</h1>} />
-      </Router>
-    </div>
-  ),
-  document.getElementById("app")!,
-);
-```
-Routes are matched in order, so put `path="*"` last.
-## API
-### Reactivity
-| Function              | What it does                                                                                                           |
-| --------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| `createSignal(value)` | Returns `[get, set]`. Reading `get()` inside an effect subscribes to it. `set` accepts a value or an updater function. |
-| `createEffect(fn)`    | Runs `fn` now and again whenever a signal it read changes.                                                             |
-| `createMemo(fn)`      | Cached computed value. Only notifies when the result changes.                                                          |
-| `batch(fn)`           | Groups several `set` calls into one update.                                                                            |
-### Components
-| Component              | What it does                                                                                         |
-| ---------------------- | ---------------------------------------------------------------------------------------------------- |
-| `<Show when fallback>` | Conditional rendering. `children` and `fallback` are functions.                                      |
-| `<For each key?>`      | List rendering. Reuses DOM nodes for unchanged items. The child is a function that returns a `Node`. |
-### Rendering
-| Function                       | What it does                                      |
-| ------------------------------ | ------------------------------------------------- |
-| `render(component, container)` | Mounts a component. Returns a `dispose` function. |
-| `h(tag, props, ...children)`   | Low-level element creator. JSX compiles to this.  |
-### Lifecycle
-| Function         | What it does                                                      |
-| ---------------- | ----------------------------------------------------------------- |
-| `onMount(fn)`    | Runs `fn` after the component is rendered.                        |
-| `onCleanup(fn)`  | Runs `fn` before an effect re-runs or when its owner is disposed. |
-| `createRoot(fn)` | Creates a top-level owner you can dispose manually.               |
-### Context
-| Function                  | What it does                                           |
-| ------------------------- | ------------------------------------------------------ |
-| `createContext(default)`  | Creates a context with a default value.                |
-| `provide(ctx, value, fn)` | Runs `fn`; everything created inside can read `value`. |
-| `useContext(ctx)`         | Reads the nearest provided value (or the default).     |
-### Router
-| Function                     | What it does                                               |
-| ---------------------------- | ---------------------------------------------------------- |
-| `<Router>`                   | Renders the first `<Route>` that matches the current path. |
-| `<Route path component>`     | Maps a path (`/users/:id`, `*`) to a component.            |
-| `<Link href>`                | An `<a>` that navigates without reloading the page.        |
-| `navigate(to, { replace? })` | Navigates programmatically.                                |
-| `useParams()`                | Reads the route params (`{ id: "7" }`).                    |
-| `usePath()`                  | Returns a signal getter for the current pathname.          |
-| `untrack(fn)`                | Runs `fn` without subscribing to signals.                  |
-### Renderer
-| Function                | What it does                                                       |
-| ----------------------- | ------------------------------------------------------------------ |
-| `setRenderer(renderer)` | Swaps the renderer (default: DOM). Used to target other platforms. |
-| `getRenderer()`         | Returns the current renderer.                                      |
-| `domRenderer`           | The built-in DOM renderer.                                         |
-## Packages
-| Package       | What it is                                                           |
-| ------------- | -------------------------------------------------------------------- |
-| `cajoa`       | The package most apps install (core + DOM)                           |
-| `@cajoa/core` | Renderer-agnostic core: signals, JSX runtime, `Show`, `For`, context |
-| `@cajoa/dom`  | DOM renderer and router                                              |
-## Good to know
-- `For` uses the item itself as the key by default. If you pass `key`, items with the same key are **not** re-rendered when their data changes, so keys must be unique and the item should hold its own signals if it needs to update.
-- `useContext` only works while a component is being created (or inside `onMount` / effects). Read it at the top of your component and use the value later in handlers.
-- Updating an object in place will not trigger effects. Set a new object instead.
-- Fragments (`<>...</>`) work anywhere, but inside `<For>` the child must be a single element, because `For` reuses that node.
-## Known limitations
-- No SSR.
-- Router: pathname only (no query/hash handling), no nested routes, no `base` path.
-- `<Show>` and `<Router>` return a function, so they must sit inside an element, not be the root returned by `render`.
-- Single-page apps need a server fallback to `index.html` for unknown paths.
-- `createMemo` can show a brief inconsistent state when memos depend on each other.
-- `set` calls are not batched automatically inside event handlers. Wrap them in `batch()`.
-- The Router and event names (`onClick`) are still web-specific for now.
-## Roadmap
-- [x] Signals and effects
-- [x] DOM bindings and `render`
-- [x] `Show`, `For` (keyed)
-- [x] Lifecycle and disposal
-- [x] `createMemo`, `batch`
-- [x] Context
-- [x] JSX support
-- [x] Fragments
-- [x] Router
-- [x] Renderer abstraction (core no longer depends on DOM)
-- [ ] Split into packages ('@cajoa/core', '@cajoa/dom')
-- [ ] Vite plugin (removes the two rules above)
-- [ ] Native renderer (mobile, desktop)
-- [ ] SSR
-## Development
-```bash
-npm install
-npm test          # run tests
-npm run dev       # open the playground
-npm run build     # build to dist/
-```
-## License
-[Apache-2.0](./LICENSE)
+# Cajoa
+A small, beginner-friendly frontend framework built on **signals** and **JSX**.
+No virtual DOM, no hooks rules, no re-rendering components.
+> ⚠️ **Early stage.** The API may still change before 1.0.
+## Why Cajoa?
+- **Components run once.** A component is just a function that builds DOM. Only the parts that depend on a signal update.
+- **Plain JSX.** Write `<button onClick={...}>`, no special syntax to learn.
+- **Tiny and readable.** The core is small enough to read in one sitting.
+- **Renderer-agnostic core.** `@cajoa/core` has no DOM dependency, so other targets (native, SSR) can plug in their own renderer.
+- **TypeScript-first**, ESM + CommonJS, zero runtime dependencies.
+## Get started
+The fastest way is the starter:
+```bash
+npm create cajoa@latest my-app
+cd my-app
+npm install
+npm run dev
+```
+Or add Cajoa to an existing project:
+```bash
+npm install cajoa
+```
+### Manual JSX setup
+In your `tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    "jsx": "react-jsx",
+    "jsxImportSource": "cajoa"
+  }
+}
+```
+With Vite, also set it in `vite.config.ts`
+(`oxc: { jsx: { runtime: "automatic", importSource: "cajoa" } }` on newer Vite,
+or `esbuild: { jsx: "automatic", jsxImportSource: "cajoa" }` on older ones).
+## Quick start
+```tsx
+import { createSignal, render } from "cajoa";
+function Counter() {
+  const [count, setCount] = createSignal(0);
+  return (
+    <button onClick={() => setCount((c) => c + 1)}>
+      Clicked {count} times
+    </button>
+  );
+}
+render(Counter, document.getElementById("app")!);
+```
+## Two rules to remember
+Cajoa has no compiler yet, so JSX expressions run exactly once. That gives two rules:
+1. **Pass the signal, don't call it.**
+   `{count}` is reactive. `{count()}` is read once and never updates.
+   For computed values, pass a function: `{() => count() * 2}`.
+2. **`Show` children are a function.**
+   `<Show when={on}>{() => <p>Hello</p>}</Show>`
+   Otherwise the element is created even when it is hidden.
+## Lists and conditions
+```tsx
+import { createSignal, Show, For } from "cajoa";
+const [todos, setTodos] = createSignal([{ id: 1, text: "Learn Cajoa" }]);
+<Show when={() => todos().length > 0} fallback={() => <p>Nothing to do.</p>}>
+  {() => (
+    <ul>
+      <For each={todos}>{(todo) => <li>{todo.text}</li>}</For>
+    </ul>
+  )}
+</Show>;
+```
+## Routing
+## Forms, styles and events
+```tsx
+const [name, setName] = createSignal("");
+const [agree, setAgree] = createSignal(false);
+<form>
+  <input
+    placeholder="Name"
+    value={name}
+    onInput={(e) => setName(e.target.value)}
+  />
+  <label>
+    <input
+      type="checkbox"
+      checked={agree}
+      onChange={(e) => setAgree(e.target.checked)}
+    />
+    I agree
+  </label>
+  <p style={() => ({ color: agree() ? "green" : "gray", fontSize: "18px" })}>
+    Hello, {() => name() || "stranger"}!
+  </p>
+</form>;
+```
+- `value`, `checked` and `selected` are set as DOM properties, so they stay in sync even after the user typed. Write `value` after `type`, `min` and `max`.
+- `style` takes a string or an object (camelCase keys, kebab-case keys, or custom properties like `--accent`). Numbers are not converted to `px`, so write `"12px"`. For a reactive style, pass a function: `style={() => ({ color: color() })}`. An object with signals inside, like `style={{ color: color() }}`, is read once.
+- Events are native DOM events. `onChange` fires when a field loses focus, so use `onInput` for every keystroke. `onDoubleClick` listens to `dblclick`.
+- `className` and `htmlFor` work. Inline string handlers like `onclick="..."` are ignored.
+```tsx
+import { render, Router, Route, Link, useParams } from "cajoa";
+const User = () => <h1>User {useParams().id}</h1>;
+render(
+  () => (
+    <div>
+      <nav>
+        <Link href="/">Home</Link> <Link href="/users/7">User 7</Link>
+      </nav>
+      <Router>
+        <Route path="/" component={() => <h1>Home</h1>} />
+        <Route path="/users/:id" component={User} />
+        <Route path="*" component={() => <h1>Not found</h1>} />
+      </Router>
+    </div>
+  ),
+  document.getElementById("app")!,
+);
+```
+Routes are matched in order, so put `path="*"` last.
+## Packages
+| Package        | What it is                                                                                 |
+| -------------- | ------------------------------------------------------------------------------------------ |
+| `cajoa`        | The package most apps install (core + DOM)                                                 |
+| `@cajoa/core`  | Renderer-agnostic core: signals, JSX runtime, `Show`, `For`, context, `Renderer` interface |
+| `@cajoa/dom`   | DOM renderer and router                                                                    |
+| `create-cajoa` | Project starter (`npm create cajoa@latest`)                                                |
+## API
+### Reactivity
+| Function              | What it does                                                                                                           |
+| --------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| `createSignal(value)` | Returns `[get, set]`. Reading `get()` inside an effect subscribes to it. `set` accepts a value or an updater function. |
+| `createEffect(fn)`    | Runs `fn` now and again whenever a signal it read changes.                                                             |
+| `createMemo(fn)`      | Cached computed value. Only notifies when the result changes.                                                          |
+| `batch(fn)`           | Groups several `set` calls into one update.                                                                            |
+| `untrack(fn)`         | Runs `fn` without subscribing to signals.                                                                              |
+### Components
+| Component              | What it does                                                                                              |
+| ---------------------- | --------------------------------------------------------------------------------------------------------- |
+| `<Show when fallback>` | Conditional rendering. `children` and `fallback` are functions.                                           |
+| `<For each key?>`      | List rendering. Reuses DOM nodes for unchanged items. The child is a function that returns a single node. |
+| `<>...</>` (Fragment)  | Groups siblings without a wrapper element.                                                                |
+### Rendering
+| Function                       | What it does                                      |
+| ------------------------------ | ------------------------------------------------- |
+| `render(component, container)` | Mounts a component. Returns a `dispose` function. |
+| `h(tag, props, ...children)`   | Low-level element creator. JSX compiles to this.  |
+### Lifecycle
+| Function         | What it does                                                      |
+| ---------------- | ----------------------------------------------------------------- |
+| `onMount(fn)`    | Runs `fn` after the component is rendered.                        |
+| `onCleanup(fn)`  | Runs `fn` before an effect re-runs or when its owner is disposed. |
+| `createRoot(fn)` | Creates a top-level owner you can dispose manually.               |
+### Context
+| Function                  | What it does                                           |
+| ------------------------- | ------------------------------------------------------ |
+| `createContext(default)`  | Creates a context with a default value.                |
+| `provide(ctx, value, fn)` | Runs `fn`; everything created inside can read `value`. |
+| `useContext(ctx)`         | Reads the nearest provided value (or the default).     |
+### Router
+| Function                     | What it does                                               |
+| ---------------------------- | ---------------------------------------------------------- |
+| `<Router>`                   | Renders the first `<Route>` that matches the current path. |
+| `<Route path component>`     | Maps a path (`/users/:id`, `*`) to a component.            |
+| `<Link href>`                | An `<a>` that navigates without reloading the page.        |
+| `navigate(to, { replace? })` | Navigates programmatically.                                |
+| `useParams()`                | Reads the route params (`{ id: "7" }`).                    |
+| `usePath()`                  | Returns a signal getter for the current pathname.          |
+### Renderer
+| Function                | What it does                                                       |
+| ----------------------- | ------------------------------------------------------------------ |
+| `setRenderer(renderer)` | Swaps the renderer (default: DOM). Used to target other platforms. |
+| `getRenderer()`         | Returns the current renderer.                                      |
+| `domRenderer`           | The built-in DOM renderer.                                         |
+## Good to know
+- `For` uses the item itself as the key by default. If you pass `key`, items with the same key are **not** re-rendered when their data changes, so keys must be unique and the item should hold its own signals if it needs to update.
+- Inside `<For>`, return a single element (not a fragment), because `For` reuses that node.
+- `useContext` and `useParams` only work while a component is being created (or inside `onMount` / effects). Read them at the top of your component and use the value later in handlers.
+- Updating an object in place will not trigger effects. Set a new object instead.
+## Known limitations
+- No SSR.
+- Router: pathname only (no query/hash handling), no nested routes, no `base` path.
+- `<Show>` and `<Router>` return a function, so they must sit inside an element, not be the root returned by `render`.
+- Single-page apps need a server fallback to `index.html` for unknown paths.
+- SVG is not supported yet: `<svg>` is created as an HTML element, so it does not render.
+- No `ref` prop yet.
+- `<select value>` works only when the `<option>` elements are direct children of the `<select>`.
+- `createMemo` can show a brief inconsistent state when memos depend on each other.
+- `set` calls are not batched automatically inside event handlers. Wrap them in `batch()`.
+- Types in the core use a loose `HostNode` type for now.
+## Roadmap
+- [x] Signals, effects, memo, batch
+- [x] DOM bindings, `Show`, keyed `For`, Fragments
+- [x] Lifecycle, context
+- [x] JSX support
+- [x] Router
+- [x] Renderer abstraction, split into packages
+- [x] Automated releases
+- [x] Form, style and event handling in the DOM renderer
+- [ ] SVG and `ref` support
+- [ ] Vite plugin (removes the two rules above)
+- [ ] Better form and style handling in the DOM renderer
+- [ ] Native renderers (mobile, desktop)
+- [ ] SSR
+- [ ] Docs site
+## Development
+```bash
+npm install
+npm test          # run tests
+npm run dev       # open the playground
+npm run verify    # typecheck, tests, build, sync and package checks
+```
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for the release flow.
+## License
+[Apache-2.0](./LICENSE)

package/package.json CHANGED Viewed

@@ -1,40 +1,85 @@
-{
-  "name": "cajoa",
-  "version": "0.6.0",
-  "description": "A small, beginner-friendly frontend framework built on signals and JSX.",
-  "type": "module",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
-      "require": { "types": "./dist/index.d.cts", "default": "./dist/index.cjs" }
-    },
-    "./jsx-runtime": {
-      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
-      "require": { "types": "./dist/index.d.cts", "default": "./dist/index.cjs" }
-    },
-    "./jsx-dev-runtime": {
-      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
-      "require": { "types": "./dist/index.d.cts", "default": "./dist/index.cjs" }
-    }
-  },
-  "files": ["dist"],
-  "sideEffects": true,
-  "dependencies": {
-    "@cajoa/core": "^0.6.0",
-    "@cajoa/dom": "^0.6.0"
-  },
-  "scripts": { "build": "tsup src/index.ts --format esm,cjs --dts --clean" },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/CajoaTS/Cajoa.git",
-    "directory": "packages/cajoa"
-  },
-  "keywords": ["frontend", "framework", "signals", "reactive", "ui", "cajoa"],
-  "author": "cjmgrc",
-  "license": "Apache-2.0",
-  "bugs": { "url": "https://github.com/CajoaTS/Cajoa/issues" },
-  "homepage": "https://github.com/CajoaTS/Cajoa#readme"
-}
+{
+  "name": "cajoa",
+  "version": "0.8.0",
+  "description": "A small, beginner-friendly frontend framework built on signals and JSX.",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./jsx-runtime": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./jsx-dev-runtime": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "jsx-runtime": [
+        "./dist/index.d.ts"
+      ],
+      "jsx-dev-runtime": [
+        "./dist/index.d.ts"
+      ]
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": true,
+  "dependencies": {
+    "@cajoa/core": "^0.8.0",
+    "@cajoa/dom": "^0.8.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "check:package": "publint && attw --pack ."
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/CajoaTS/Cajoa.git",
+    "directory": "packages/cajoa"
+  },
+  "keywords": [
+    "frontend",
+    "framework",
+    "signals",
+    "reactive",
+    "ui",
+    "cajoa"
+  ],
+  "author": "cjmgrc",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/CajoaTS/Cajoa/issues"
+  },
+  "homepage": "https://github.com/CajoaTS/Cajoa#readme"
+}