@kayelaa/canvas 0.1.13 → 0.1.14

package/README.md

@@ -16,7 +16,7 @@ It's a **very thin declarative layer** on top of LEA — all performance-critica
 Made by **Kayelaa Cagara** (@LianeKayee39 on X / GitHub) in Calamba, Philippines.
 
 ## API Reference (worth checking if you want a true API reference for every variables, properties, etc)
-[API Reference](./canvas/docs/README.md)
+[API Reference](https://lianecagara.github.io/kayelaa-canvas-docs/)
 
 **This Documentation might be INACCURATE! Always visit the .d.ts files to verify.**
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kayelaa/canvas",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "description": "Declarative entity composition hooks + canvas utilities for LEA-based 2D games",
   "license": "MIT",
   "author": "Kayelaa Cagara",
@@ -31,8 +31,7 @@
     }
   },
   "files": [
-    "dist",
-    "docs"
+    "dist"
   ],
   "scripts": {
     "build": "tsup",

package/docs/@kayelaa/namespaces/Kayla/README.md

@@ -1,67 +0,0 @@
-[**@kayelaa/canvas**](../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../README.md) / Kayla
-
-# Kayla
-
-## Namespaces
-
-- [KaylaInternals](namespaces/KaylaInternals/README.md)
-- [JSX](namespaces/JSX/README.md)
-
-## Interfaces
-
-- [FC](interfaces/FC.md)
-- [KaylaElement](interfaces/KaylaElement.md)
-- [KaylaState](interfaces/KaylaState.md)
-- [KaylaRef](interfaces/KaylaRef.md)
-- [KaylaGame](interfaces/KaylaGame.md)
-- [KaylaScene](interfaces/KaylaScene.md)
-- [KaylaRenderer](interfaces/KaylaRenderer.md)
-- [KaylaRect](interfaces/KaylaRect.md)
-- [UnsafeKaylaFiber](interfaces/UnsafeKaylaFiber.md)
-- [KaylaFiberControl](interfaces/KaylaFiberControl.md)
-- [KaylaCustomHookConfig](interfaces/KaylaCustomHookConfig.md)
-
-## Type Aliases
-
-- [FCProps](type-aliases/FCProps.md)
-- [FCExports](type-aliases/FCExports.md)
-- [KaylaExportables](type-aliases/KaylaExportables.md)
-- [KaylaExports](type-aliases/KaylaExports.md)
-- [PropOfFC](type-aliases/PropOfFC.md)
-- [ExportsOfFC](type-aliases/ExportsOfFC.md)
-- [KaylaElementRef](type-aliases/KaylaElementRef.md)
-- [Reassignable](type-aliases/Reassignable.md)
-
-## Variables
-
-- [useState](variables/useState.md)
-- [useRef](variables/useRef.md)
-- [useShouldRefresh](variables/useShouldRefresh.md)
-- [useEffect](variables/useEffect.md)
-- [useInitialization](variables/useInitialization.md)
-- [useRect](variables/useRect.md)
-- [useTick](variables/useTick.md)
-- [usePaint](variables/usePaint.md)
-- [useExports](variables/useExports.md)
-- [useSelf](variables/useSelf.md)
-- [useFiberControl](variables/useFiberControl.md)
-- [useFiber](variables/useFiber.md)
-- [useEntity](variables/useEntity.md)
-- [self](variables/self.md)
-- [KaylaFragment](variables/KaylaFragment.md)
-
-## Functions
-
-- [createGame](functions/createGame.md)
-- [createScene](functions/createScene.md)
-- [createRenderer](functions/createRenderer.md)
-- [createElement](functions/createElement.md)
-- [useNextStack](functions/useNextStack.md)
-- [useDisposableRef](functions/useDisposableRef.md)
-- [createReassignableObject](functions/createReassignableObject.md)
-- [setLogLevel](functions/setLogLevel.md)
-- [createUseHook](functions/createUseHook.md)

package/docs/@kayelaa/namespaces/Kayla/functions/createElement.md

@@ -1,51 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / createElement
-
-# Function: createElement()
-
-> **createElement**\<`Props`\>(`fc`, `props`): [`KaylaElement`](../interfaces/KaylaElement.md)\<`Props`\>
-
-Defined in: [kayla-internals.ts:121](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L121)
-
-Creates a Kayla element descriptor (virtual representation of an entity/component).
-
-This is the JSX factory used internally by the transpiler. You rarely call it directly,
-but it powers declarative trees passed to `scene.spawn()`.
-
-## Type Parameters
-
-### Props
-
-`Props` *extends* [`FCProps`](../type-aliases/FCProps.md)
-
-Props type accepted by the component
-
-## Parameters
-
-### fc
-
-[`FC`](../interfaces/FC.md)\<`Props`\>
-
-The functional component
-
-### props
-
-`Props`
-
-Props including `key`, `ref`, `exportsRef`, `children`, etc.
-
-## Returns
-
-[`KaylaElement`](../interfaces/KaylaElement.md)\<`Props`\>
-
-Element descriptor
-
-## Example
-
-```ts
-const elem = createElement(Player, { x: 400, y: 300 });
-scene.spawn(elem);
-```

package/docs/@kayelaa/namespaces/Kayla/functions/createGame.md

@@ -1,55 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / createGame
-
-# Function: createGame()
-
-> **createGame**(`config`): [`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md)
-
-Defined in: [kayla-internals.ts:53](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L53)
-
-Creates a new game instance that coordinates scenes, renderers, and a shared ticker.
-
-The game manages the global update loop (via `updateHz`) and allows attaching multiple renderers
-and scenes. Start the game with `game.start()` to begin ticking and rendering.
-
-## Parameters
-
-### config
-
-Configuration options
-
-#### width
-
-`number`
-
-Logical viewport width (used for entity coordinates)
-
-#### height
-
-`number`
-
-Logical viewport height
-
-#### updateHz?
-
-`number` \| `"frames"` = `"frames"`
-
-Tick frequency:
-  - `"frames"` = run updates every render frame (RAF-synced, variable timestep)
-  - number = fixed timestep in Hz (e.g. 60)
-
-## Returns
-
-[`KaylaGame`](../namespaces/KaylaInternals/classes/KaylaGame.md)
-
-A `KaylaGame` instance
-
-## Example
-
-```ts
-const game = createGame({ width: 800, height: 600, updateHz: 60 });
-game.start();
-```

package/docs/@kayelaa/namespaces/Kayla/functions/createReassignableObject.md

@@ -1,27 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / createReassignableObject
-
-# Function: createReassignableObject()
-
-> **createReassignableObject**\<`T`\>(`initial`): [`Reassignable`](../type-aliases/Reassignable.md)\<`T`\>
-
-Defined in: [kayla-internals.ts:1865](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1865)
-
-## Type Parameters
-
-### T
-
-`T` *extends* `object`
-
-## Parameters
-
-### initial
-
-`T`
-
-## Returns
-
-[`Reassignable`](../type-aliases/Reassignable.md)\<`T`\>

package/docs/@kayelaa/namespaces/Kayla/functions/createRenderer.md

@@ -1,38 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / createRenderer
-
-# Function: createRenderer()
-
-> **createRenderer**(`canvas`): [`KaylaRenderer`](../interfaces/KaylaRenderer.md)
-
-Defined in: [kayla-internals.ts:101](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L101)
-
-Creates a renderer that drives the canvas draw loop and handles pointer tracking.
-
-The renderer automatically clears the canvas each frame and emits a `"draw"` event
-where scenes can paint. Call `renderer.start()` to begin the RAF loop.
-
-## Parameters
-
-### canvas
-
-`HTMLCanvasElement`
-
-The target `<canvas>` element
-
-## Returns
-
-[`KaylaRenderer`](../interfaces/KaylaRenderer.md)
-
-A `KaylaRenderer` instance
-
-## Example
-
-```ts
-const canvas = document.getElementById("game") as HTMLCanvasElement;
-const renderer = createRenderer(canvas);
-renderer.start();
-```

package/docs/@kayelaa/namespaces/Kayla/functions/createScene.md

@@ -1,37 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / createScene
-
-# Function: createScene()
-
-> **createScene**(`name`): [`KaylaScene`](../namespaces/KaylaInternals/classes/KaylaScene.md)
-
-Defined in: [kayla-internals.ts:82](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L82)
-
-Creates a scene that manages a collection of entities and their update/draw lifecycle.
-
-Scenes handle z-sorted drawing, paused state, and entity addition/removal.
-Use `scene.spawn()` to mount a root component tree.
-
-## Parameters
-
-### name
-
-`string`
-
-Unique identifier for the scene
-
-## Returns
-
-[`KaylaScene`](../namespaces/KaylaInternals/classes/KaylaScene.md)
-
-A `KaylaScene` wrapper with `.spawn()` and other methods
-
-## Example
-
-```ts
-const scene = createScene("main");
-scene.spawn(<GameWorld />);
-```

package/docs/@kayelaa/namespaces/Kayla/functions/createUseHook.md

@@ -1,83 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / createUseHook
-
-# Function: createUseHook()
-
-> **createUseHook**\<`Return`, `Params`\>(`config`): (`params?`) => `Return`
-
-Defined in: [kayla-internals.ts:1989](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1989)
-
-Factory to create custom, reusable hooks for Kayla that can accept runtime parameters.
-
-The returned hook can be called with optional params that are passed to `onUse`.
-By default, the result is memoized (runs `onUse` only once per entity).
-
-## Type Parameters
-
-### Return
-
-`Return`
-
-The type of value the hook returns
-
-### Params
-
-`Params` = `void`
-
-= void Optional type of runtime params passed to the hook
-
-## Parameters
-
-### config
-
-[`KaylaCustomHookConfig`](../interfaces/KaylaCustomHookConfig.md)\<`Return`, `Params`\>
-
-Configuration with onUse + optional memoize/name
-
-## Returns
-
-A hook function you can call in components, optionally with params
-
-> (`params?`): `Return`
-
-### Parameters
-
-#### params?
-
-`Params`
-
-### Returns
-
-`Return`
-
-## Examples
-
-```ts
-Basic memoized hook with no params
-const useMyTimer = createUseHook({
-  name: "useMyTimer",
-  onUse: () => {
-    const elapsed = useRef(0);
-    useTick(dt => { elapsed.current += dt; });
-    return { getElapsed: () => elapsed.current };
-  }
-});
-```
-
-```ts
-Hook that accepts runtime params
-const useMoveSpeed = createUseHook<number, { baseSpeed: number }>({
-  name: "useMoveSpeed",
-  onUse: (fiber, global, { baseSpeed }) => {
-    const speed = useRef(baseSpeed);
-    useTick(dt => { speed.current += 0.1 * dt; });
-    return speed.current;
-  }
-});
-
-// usage
-const speed = useMoveSpeed({ baseSpeed: 200 });
-```

package/docs/@kayelaa/namespaces/Kayla/functions/setLogLevel.md

@@ -1,21 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / setLogLevel
-
-# Function: setLogLevel()
-
-> **setLogLevel**(`level`): `void`
-
-Defined in: [kayla-internals.ts:1910](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1910)
-
-## Parameters
-
-### level
-
-`"silent"` | `"warn"` | `"info"` | `"debug"`
-
-## Returns
-
-`void`

package/docs/@kayelaa/namespaces/Kayla/functions/useDisposableRef.md

@@ -1,45 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / useDisposableRef
-
-# Function: useDisposableRef()
-
-> **useDisposableRef**\<`T`\>(`initialValue`): [`KaylaRef`](../interfaces/KaylaRef.md)\<`T`\>
-
-Defined in: [kayla-internals.ts:1850](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1850)
-
-Creates a temporary ref object **outside** of component context.
-
-Unlike `useRef`, this ref **does not persist** across entity refreshes — it is recreated
-every time the component function runs. Use for one-off values or render-pass temporaries.
-
-## Type Parameters
-
-### T
-
-`T`
-
-Type of the ref's value
-
-## Parameters
-
-### initialValue
-
-`T`
-
-Initial value for `.current`
-
-## Returns
-
-[`KaylaRef`](../interfaces/KaylaRef.md)\<`T`\>
-
-A fresh `KaylaRef` instance
-
-## Example
-
-```ts
-const temp = useDisposableRef({ count: 0 });
-// temp.current is only valid for this render
-```

package/docs/@kayelaa/namespaces/Kayla/functions/useNextStack.md

@@ -1,28 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / useNextStack
-
-# Function: useNextStack()
-
-> **useNextStack**(`callback`): `void`
-
-Defined in: [kayla-internals.ts:1773](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1773)
-
-Schedules a callback to run in the next microtask (via `Promise.resolve().then`).
-
-Used internally to defer entity refreshes safely and prevent synchronous re-entrancy.
-Rarely needed directly by users.
-
-## Parameters
-
-### callback
-
-() => `void`
-
-The function to schedule
-
-## Returns
-
-`void`

package/docs/@kayelaa/namespaces/Kayla/interfaces/FC.md

@@ -1,41 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / FC
-
-# Interface: FC()\<Props, Exports\>
-
-Defined in: [kayla-internals.ts:22](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L22)
-
-## Type Parameters
-
-### Props
-
-`Props` *extends* [`FCProps`](../type-aliases/FCProps.md) = [`FCProps`](../type-aliases/FCProps.md)
-
-### Exports
-
-`Exports` *extends* [`FCExports`](../type-aliases/FCExports.md) = [`FCExports`](../type-aliases/FCExports.md)
-
-> **FC**(`props`): `void` \| [`KaylaElement`](KaylaElement.md)\<`any`\> \| [`KaylaElement`](KaylaElement.md)\<`any`\>[]
-
-Defined in: [kayla-internals.ts:26](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L26)
-
-## Parameters
-
-### props
-
-`Props` & `object`
-
-## Returns
-
-`void` \| [`KaylaElement`](KaylaElement.md)\<`any`\> \| [`KaylaElement`](KaylaElement.md)\<`any`\>[]
-
-## Properties
-
-### displayName?
-
-> `optional` **displayName**: `string`
-
-Defined in: [kayla-internals.ts:32](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L32)

package/docs/@kayelaa/namespaces/Kayla/interfaces/KaylaCustomHookConfig.md

@@ -1,86 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / KaylaCustomHookConfig
-
-# Interface: KaylaCustomHookConfig\<Return, Params\>
-
-Defined in: [kayla-internals.ts:1924](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1924)
-
-Configuration for a custom Kayla hook created via `createUseHook`.
-
-## Type Parameters
-
-### Return
-
-`Return`
-
-### Params
-
-`Params` = `void`
-
-## Properties
-
-### onUse()
-
-> **onUse**: (`unsafeFiber`, `global`, `params`) => `Return`
-
-Defined in: [kayla-internals.ts:1934](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1934)
-
-Called when the hook is used (once if memoized, every render if not).
-Receives the current fiber, global context, and any runtime params passed to the hook.
-
-#### Parameters
-
-##### unsafeFiber
-
-[`UnsafeKaylaFiber`](UnsafeKaylaFiber.md)
-
-Direct reference to the internal fiber (use with caution!)
-
-##### global
-
-[`GlobalKayla`](../namespaces/KaylaInternals/classes/GlobalKayla.md)
-
-The GlobalKayla instance (for logger, etc.)
-
-##### params
-
-`Params`
-
-Optional runtime parameters passed when calling the hook
-
-#### Returns
-
-`Return`
-
-The value that the hook will return
-
-***
-
-### memoize?
-
-> `optional` **memoize**: `boolean`
-
-Defined in: [kayla-internals.ts:1947](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1947)
-
-Whether to memoize (cache) the result of onUse across component refreshes.
-- `true` (default): runs onUse only once per entity lifetime → most common & performant
-- `false`: runs onUse on every render → useful for hooks that must recompute frequently
-
-#### Default
-
-```ts
-true
-```
-
-***
-
-### name
-
-> **name**: `string`
-
-Defined in: [kayla-internals.ts:1952](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1952)
-
-Required name for this custom hook — used in dev-mode logs/warnings to identify it.

package/docs/@kayelaa/namespaces/Kayla/interfaces/KaylaElement.md

@@ -1,31 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-
-***
-
-[@kayelaa/canvas](../../../../README.md) / [Kayla](../README.md) / KaylaElement
-
-# Interface: KaylaElement\<Props\>
-
-Defined in: [kayla-internals.ts:131](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L131)
-
-## Type Parameters
-
-### Props
-
-`Props` *extends* [`FCProps`](../type-aliases/FCProps.md)
-
-## Properties
-
-### type
-
-> **type**: [`FC`](FC.md)\<`Props`\>
-
-Defined in: [kayla-internals.ts:132](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L132)
-
-***
-
-### props
-
-> **props**: `Props`
-
-Defined in: [kayla-internals.ts:133](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L133)