npm - @kayelaa/canvas - Versions diffs - 0.1.13 → 0.1.14 - Mend

@kayelaa/canvas 0.1.13 → 0.1.14

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 (136) hide show

package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/classes/KaylaFiber.md DELETED Viewed

@@ -1,526 +0,0 @@
-[**@kayelaa/canvas**](../../../../../../README.md)
-***
-[@kayelaa/canvas](../../../../../../README.md) / [Kayla](../../../README.md) / [KaylaInternals](../README.md) / KaylaFiber
-# Class: KaylaFiber\<Props, Exports\>
-Defined in: [kayla-internals.ts:860](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L860)
-## Extended by
-- [`UnsafeKaylaFiber`](../../../interfaces/UnsafeKaylaFiber.md)
-## Type Parameters
-### Props
-`Props` *extends* [`FCProps`](../../../type-aliases/FCProps.md) = \{ \}
-### Exports
-`Exports` *extends* [`FCExports`](../../../type-aliases/FCExports.md) = [`FCExports`](../../../type-aliases/FCExports.md)
-## Implements
-- [`KaylaFiberControl`](../interfaces/KaylaFiberControl.md)
-## Constructors
-### Constructor
-> **new KaylaFiber**\<`Props`, `Exports`\>(`globalKayla`, `scene`, `element`): `KaylaFiber`\<`Props`, `Exports`\>
-Defined in: [kayla-internals.ts:874](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L874)
-#### Parameters
-##### globalKayla
-[`GlobalKayla`](GlobalKayla.md)
-##### scene
-[`KaylaScene`](KaylaScene.md)
-##### element
-[`KaylaElement`](../../../interfaces/KaylaElement.md)\<`Props`\>
-#### Returns
-`KaylaFiber`\<`Props`, `Exports`\>
-## Properties
-### state
-> **state**: [`KaylaState`](../../../interfaces/KaylaState.md)\<`any`\>[]
-Defined in: [kayla-internals.ts:864](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L864)
-***
-### refs
-> **refs**: [`KaylaRef`](../../../interfaces/KaylaRef.md)\<`unknown`\>[]
-Defined in: [kayla-internals.ts:865](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L865)
-***
-### global
-> **global**: [`GlobalKayla`](GlobalKayla.md)
-Defined in: [kayla-internals.ts:866](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L866)
-***
-### callProps
-> **callProps**: `Props`
-Defined in: [kayla-internals.ts:867](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L867)
-***
-### scene
-> **scene**: [`KaylaScene`](KaylaScene.md)
-Defined in: [kayla-internals.ts:868](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L868)
-***
-### exports
-> **exports**: [`KaylaExports`](../../../type-aliases/KaylaExports.md)\<`Exports`\>
-Defined in: [kayla-internals.ts:869](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L869)
-***
-### maxSafeChildren
-> **maxSafeChildren**: `number`
-Defined in: [kayla-internals.ts:873](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L873)
-Advisory maximum number of direct children allowed before warning or enforcement.
-Default: 40.
-Can be changed via `setMaxChildren()`.
-Enforcement is **soft** by default (logs warning + removes excess oldest children).
-Set to `Infinity` to disable limit.
-#### Implementation of
-[`KaylaFiberControl`](../interfaces/KaylaFiberControl.md).[`maxSafeChildren`](../interfaces/KaylaFiberControl.md#maxsafechildren)
-***
-### entity?
-> `optional` **entity**: [`KaylaRectEntity`](KaylaRectEntity.md)
-Defined in: [kayla-internals.ts:909](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L909)
-***
-### onExport()
-> **onExport**: () => [`KaylaExports`](../../../type-aliases/KaylaExports.md)\<`Exports`\>
-Defined in: [kayla-internals.ts:910](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L910)
-#### Returns
-[`KaylaExports`](../../../type-aliases/KaylaExports.md)\<`Exports`\>
-***
-### onEffect
-> **onEffect**: () => `void` \| () => `void`[]
-Defined in: [kayla-internals.ts:911](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L911)
-#### Returns
-`void` \| () => `void`
-***
-### onInit()
-> **onInit**: () => `void` \| () => `void`
-Defined in: [kayla-internals.ts:912](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L912)
-#### Returns
-`void` \| () => `void`
-***
-### onUnInit()
-> **onUnInit**: () => `void` \| () => `void`
-Defined in: [kayla-internals.ts:913](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L913)
-#### Returns
-`void` \| () => `void`
-***
-### onUnEffect
-> **onUnEffect**: () => `void`[]
-Defined in: [kayla-internals.ts:914](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L914)
-#### Returns
-`void`
-***
-### onEffectDeps?
-> `optional` **onEffectDeps**: [`KaylaState`](../../../interfaces/KaylaState.md)\<`any`\>[]
-Defined in: [kayla-internals.ts:915](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L915)
-***
-### onPaint
-> **onPaint**: (`ctx`, `event`) => `void`[]
-Defined in: [kayla-internals.ts:916](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L916)
-#### Parameters
-##### ctx
-`CanvasRenderingContext2D`
-##### event
-[`KaylaEvent`](KaylaEvent.md)
-#### Returns
-`void`
-***
-### onTick
-> **onTick**: (`deltaS`, `event`) => `void`[]
-Defined in: [kayla-internals.ts:917](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L917)
-#### Parameters
-##### deltaS
-`number`
-##### event
-[`KaylaEvent`](KaylaEvent.md)
-#### Returns
-`void`
-***
-### fc?
-> `optional` **fc**: [`FC`](../../../interfaces/FC.md)\<`any`\>
-Defined in: [kayla-internals.ts:918](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L918)
-***
-### useStateCallIndex
-> **useStateCallIndex**: `number` = `0`
-Defined in: [kayla-internals.ts:919](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L919)
-***
-### useEffectCallIndex
-> **useEffectCallIndex**: `number` = `0`
-Defined in: [kayla-internals.ts:920](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L920)
-***
-### useDrawCallIndex
-> **useDrawCallIndex**: `number` = `0`
-Defined in: [kayla-internals.ts:921](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L921)
-***
-### useStepCallIndex
-> **useStepCallIndex**: `number` = `0`
-Defined in: [kayla-internals.ts:922](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L922)
-***
-### useRefCallIndex
-> **useRefCallIndex**: `number` = `0`
-Defined in: [kayla-internals.ts:923](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L923)
-***
-### lastStateDeps
-> **lastStateDeps**: `object`[]
-Defined in: [kayla-internals.ts:924](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L924)
-#### stateRef
-> **stateRef**: [`KaylaState`](../../../interfaces/KaylaState.md)\<`any`\>
-#### stamp
-> **stamp**: `number`
-***
-### watchedDeps?
-> `optional` **watchedDeps**: [`KaylaState`](../../../interfaces/KaylaState.md)\<`any`\>[]
-Defined in: [kayla-internals.ts:926](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L926)
-***
-### lastDepStamps
-> **lastDepStamps**: `number`[] = `[]`
-Defined in: [kayla-internals.ts:928](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L928)
-***
-### lastChildren
-> **lastChildren**: `KaylaFiber`\<`any`, `Record`\<`string`, [`KaylaExportables`](../../../type-aliases/KaylaExportables.md)\>\>[]
-Defined in: [kayla-internals.ts:1059](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1059)
-***
-### isFirstUse
-> **isFirstUse**: `boolean` = `true`
-Defined in: [kayla-internals.ts:1060](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1060)
-## Accessors
-### childrenCount
-#### Get Signature
-> **get** **childrenCount**(): `number`
-Defined in: [kayla-internals.ts:870](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L870)
-Current number of direct child fibers (readonly).
-Reflects the length of `lastChildren` after the last reconciliation.
-##### Returns
-`number`
-#### Implementation of
-[`KaylaFiberControl`](../interfaces/KaylaFiberControl.md).[`childrenCount`](../interfaces/KaylaFiberControl.md#childrencount)
-***
-### key
-#### Get Signature
-> **get** **key**(): `string`
-Defined in: [kayla-internals.ts:897](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L897)
-##### Returns
-`string`
-#### Set Signature
-> **set** **key**(`s`): `void`
-Defined in: [kayla-internals.ts:900](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L900)
-##### Parameters
-###### s
-`string`
-##### Returns
-`void`
-***
-### children
-#### Get Signature
-> **get** **children**(): [`KaylaElement`](../../../interfaces/KaylaElement.md)\<`any`\>[]
-Defined in: [kayla-internals.ts:903](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L903)
-##### Returns
-[`KaylaElement`](../../../interfaces/KaylaElement.md)\<`any`\>[]
-#### Set Signature
-> **set** **children**(`s`): `void`
-Defined in: [kayla-internals.ts:906](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L906)
-##### Parameters
-###### s
-[`KaylaElement`](../../../interfaces/KaylaElement.md)\<`any`\>[]
-##### Returns
-`void`
-## Methods
-### setMaxChildren()
-> **setMaxChildren**(`max`): `void`
-Defined in: [kayla-internals.ts:930](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L930)
-Sets the maximum allowed number of direct children for this fiber.
-If current child count exceeds the new limit, **excess oldest children are immediately unmounted**.
-#### Parameters
-##### max
-`number`
-New maximum (must be >= 0). Use `Infinity` to remove limit.
-#### Returns
-`void`
-#### Implementation of
-[`KaylaFiberControl`](../interfaces/KaylaFiberControl.md).[`setMaxChildren`](../interfaces/KaylaFiberControl.md#setmaxchildren)
-***
-### getMaxChildren()
-> **getMaxChildren**(): `number`
-Defined in: [kayla-internals.ts:953](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L953)
-Returns the current maximum allowed number of direct children.
-#### Returns
-`number`
-The limit (Infinity if no limit set)
-#### Implementation of
-[`KaylaFiberControl`](../interfaces/KaylaFiberControl.md).[`getMaxChildren`](../interfaces/KaylaFiberControl.md#getmaxchildren)
-***
-### shouldFullRefresh()
-> **shouldFullRefresh**(): `boolean`
-Defined in: [kayla-internals.ts:957](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L957)
-#### Returns
-`boolean`
-***
-### captureDepStamps()
-> **captureDepStamps**(): `void`
-Defined in: [kayla-internals.ts:971](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L971)
-#### Returns
-`void`
-***
-### refresh()
-> **refresh**(): `void`
-Defined in: [kayla-internals.ts:976](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L976)
-#### Returns
-`void`
-***
-### use()
-> **use**(): `void`
-Defined in: [kayla-internals.ts:1062](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1062)
-#### Returns
-`void`
-***
-### unuse()
-> **unuse**(): `void`
-Defined in: [kayla-internals.ts:1154](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L1154)
-#### Returns
-`void`