@zeix/le-truc 0.15.0

package/docs-src/api/functions/defineComponent.md

@@ -0,0 +1,65 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / defineComponent
+
+# Function: defineComponent()
+
+> **defineComponent**\<`P`, `U`\>(`name`, `props`, `select`, `setup`): [`Component`](../type-aliases/Component.md)\<`P`\>
+
+Defined in: [src/component.ts:76](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/component.ts#L76)
+
+Define a component with dependency resolution and setup function (connectedCallback)
+
+## Type Parameters
+
+### P
+
+`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+### U
+
+`U` *extends* [`UI`](../type-aliases/UI.md) = \{ \}
+
+## Parameters
+
+### name
+
+`string`
+
+Custom element name
+
+### props
+
+[`Initializers`](../type-aliases/Initializers.md)\<`P`, `U`\> = `...`
+
+Component properties
+
+### select
+
+(`elementQueries`) => `U`
+
+Function to select UI elements
+
+### setup
+
+(`ui`) => [`Effects`](../type-aliases/Effects.md)\<`P`, [`ComponentUI`](../type-aliases/ComponentUI.md)\<`P`, `U`\>\>
+
+Setup function
+
+## Returns
+
+[`Component`](../type-aliases/Component.md)\<`P`\>
+
+## Since
+
+0.15.0
+
+## Throws
+
+If component name is invalid
+
+## Throws
+
+If property name is invalid

package/docs-src/api/functions/isCollection.md

@@ -0,0 +1,37 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / isCollection
+
+# Function: isCollection()
+
+> **isCollection**\<`E`\>(`value`): `value is Collection<E>`
+
+Defined in: [src/signals/collection.ts:242](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/signals/collection.ts#L242)
+
+Check if a value is a collection signal
+
+## Type Parameters
+
+### E
+
+`E` *extends* `Element` = `Element`
+
+## Parameters
+
+### value
+
+`unknown`
+
+Value to check
+
+## Returns
+
+`value is Collection<E>`
+
+- True if value is a collection signal, false otherwise
+
+## Since
+
+0.15.0

package/docs-src/api/functions/isParser.md

@@ -0,0 +1,41 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / isParser
+
+# Function: isParser()
+
+> **isParser**\<`T`, `U`\>(`value`): `value is Parser<T, U>`
+
+Defined in: [src/parsers.ts:32](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/parsers.ts#L32)
+
+Check if a value is a parser
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### U
+
+`U` *extends* [`UI`](../type-aliases/UI.md)
+
+## Parameters
+
+### value
+
+`unknown`
+
+Value to check if it is a parser
+
+## Returns
+
+`value is Parser<T, U>`
+
+True if the value is a parser, false otherwise
+
+## Since
+
+0.14.0

package/docs-src/api/functions/match.md

@@ -0,0 +1,47 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / match
+
+# Function: match()
+
+> **match**\<`S`\>(`result`, `handlers`): `void`
+
+Defined in: node\_modules/@zeix/cause-effect/types/src/match.d.ts:20
+
+Match on resolve result and call appropriate handler for side effects
+
+This is a utility function for those who prefer the handler pattern.
+All handlers are for side effects only and return void. If you need
+cleanup logic, use a hoisted let variable in your effect.
+
+## Type Parameters
+
+### S
+
+`S` *extends* `UnknownSignalRecord`
+
+## Parameters
+
+### result
+
+[`ResolveResult`](../type-aliases/ResolveResult.md)\<`S`\>
+
+Result from resolve()
+
+### handlers
+
+[`MatchHandlers`](../type-aliases/MatchHandlers.md)\<`S`\>
+
+Handlers for different states (side effects only)
+
+## Returns
+
+`void`
+
+- Always returns void
+
+## Since
+
+0.15.0

package/docs-src/api/functions/on.md

@@ -0,0 +1,58 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / on
+
+# Function: on()
+
+> **on**\<`K`, `P`, `E`\>(`type`, `handler`, `options`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Defined in: [src/effects/event.ts:30](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/effects/event.ts#L30)
+
+Effect for attaching an event listener to an element.
+Provides proper cleanup when the effect is disposed.
+
+## Type Parameters
+
+### K
+
+`K` *extends* `string`
+
+### P
+
+`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+### E
+
+`E` *extends* `Element` = `HTMLElement`
+
+## Parameters
+
+### type
+
+`K`
+
+Event type
+
+### handler
+
+[`EventHandler`](../type-aliases/EventHandler.md)\<`P`, [`EventType`](../type-aliases/EventType.md)\<`K`\>\>
+
+Event handler function
+
+### options
+
+`AddEventListenerOptions` = `{}`
+
+Event listener options
+
+## Returns
+
+[`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Effect function that manages the event listener
+
+## Since
+
+0.14.0

package/docs-src/api/functions/pass.md

@@ -0,0 +1,53 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / pass
+
+# Function: pass()
+
+> **pass**\<`P`, `Q`\>(`props`): [`Effect`](../type-aliases/Effect.md)\<`P`, [`Component`](../type-aliases/Component.md)\<`Q`\>\>
+
+Defined in: [src/effects/pass.ts:39](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/effects/pass.ts#L39)
+
+Effect for passing reactive values to a descendant Le Truc component.
+
+## Type Parameters
+
+### P
+
+`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+### Q
+
+`Q` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+## Parameters
+
+### props
+
+Reactive values to pass
+
+[`PassedProps`](../type-aliases/PassedProps.md)\<`P`, `Q`\> | (`target`) => [`PassedProps`](../type-aliases/PassedProps.md)\<`P`, `Q`\>
+
+## Returns
+
+[`Effect`](../type-aliases/Effect.md)\<`P`, [`Component`](../type-aliases/Component.md)\<`Q`\>\>
+
+Effect function that passes reactive values to the descendant component
+
+## Since
+
+0.15.0
+
+## Throws
+
+When the target element is not a valid custom element
+
+## Throws
+
+When the provided reactives is not a record of signals, reactive property names or functions
+
+## Throws
+
+When passing signals failed for some other reason

package/docs-src/api/functions/provideContexts.md

@@ -0,0 +1,47 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / provideContexts
+
+# Function: provideContexts()
+
+> **provideContexts**\<`P`\>(`contexts`): (`host`) => [`Cleanup`](../type-aliases/Cleanup.md)
+
+Defined in: [src/context.ts:106](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/context.ts#L106)
+
+Provide a context for descendant component consumers
+
+## Type Parameters
+
+### P
+
+`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+## Parameters
+
+### contexts
+
+keyof `P`[]
+
+Array of contexts to provide
+
+## Returns
+
+Function to add an event listener for ContextRequestEvent returning a cleanup function to remove the event listener
+
+> (`host`): [`Cleanup`](../type-aliases/Cleanup.md)
+
+### Parameters
+
+#### host
+
+[`Component`](../type-aliases/Component.md)\<`P`\>
+
+### Returns
+
+[`Cleanup`](../type-aliases/Cleanup.md)
+
+## Since
+
+0.13.3

package/docs-src/api/functions/read.md

@@ -0,0 +1,47 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / read
+
+# Function: read()
+
+> **read**\<`T`, `U`\>(`reader`, `fallback`): [`Reader`](../type-aliases/Reader.md)\<`T`, `U`\>
+
+Defined in: [src/parsers.ts:69](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/parsers.ts#L69)
+
+Read a value from a UI element
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### U
+
+`U` *extends* [`UI`](../type-aliases/UI.md)
+
+## Parameters
+
+### reader
+
+[`LooseReader`](../type-aliases/LooseReader.md)\<`T`, `U`\>
+
+Reader function returning T | string | null | undefined
+
+### fallback
+
+[`ParserOrFallback`](../type-aliases/ParserOrFallback.md)\<`T`, `U`\>
+
+Fallback value or parser function
+
+## Returns
+
+[`Reader`](../type-aliases/Reader.md)\<`T`, `U`\>
+
+Parsed value or fallback value
+
+## Since
+
+0.15.0

package/docs-src/api/functions/requestContext.md

@@ -0,0 +1,51 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / requestContext
+
+# Function: requestContext()
+
+> **requestContext**\<`T`, `P`, `U`\>(`context`, `fallback`): [`Reader`](../type-aliases/Reader.md)\<[`Computed`](../type-aliases/Computed.md)\<`T`\>, `U` & `object`\>
+
+Defined in: [src/context.ts:134](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/context.ts#L134)
+
+Consume a context value for a component
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### P
+
+`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+### U
+
+`U` *extends* [`UI`](../type-aliases/UI.md)
+
+## Parameters
+
+### context
+
+[`Context`](../type-aliases/Context.md)\<`string`, () => `T`\>
+
+Context key to consume
+
+### fallback
+
+[`Fallback`](../type-aliases/Fallback.md)\<`T`, `U` & `object`\>
+
+Fallback value or reader function for fallback
+
+## Returns
+
+[`Reader`](../type-aliases/Reader.md)\<[`Computed`](../type-aliases/Computed.md)\<`T`\>, `U` & `object`\>
+
+Computed signal that returns the consumed context the fallback value
+
+## Since
+
+0.15.0

package/docs-src/api/functions/resolve.md

@@ -0,0 +1,40 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / resolve
+
+# Function: resolve()
+
+> **resolve**\<`S`\>(`signals`): [`ResolveResult`](../type-aliases/ResolveResult.md)\<`S`\>
+
+Defined in: node\_modules/@zeix/cause-effect/types/src/resolve.d.ts:28
+
+Resolve signal values with perfect type inference
+
+Always returns a discriminated union result, regardless of whether
+handlers are provided or not. This ensures a predictable API.
+
+## Type Parameters
+
+### S
+
+`S` *extends* `UnknownSignalRecord`
+
+## Parameters
+
+### signals
+
+`S`
+
+Signals to resolve
+
+## Returns
+
+[`ResolveResult`](../type-aliases/ResolveResult.md)\<`S`\>
+
+- Discriminated union result
+
+## Since
+
+0.15.0

package/docs-src/api/functions/runEffects.md

@@ -0,0 +1,51 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / runEffects
+
+# Function: runEffects()
+
+> **runEffects**\<`P`, `U`\>(`ui`, `effects`): [`Cleanup`](../type-aliases/Cleanup.md)
+
+Defined in: [src/effects.ts:167](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/effects.ts#L167)
+
+Run component effects
+
+## Type Parameters
+
+### P
+
+`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+### U
+
+`U` *extends* [`UI`](../type-aliases/UI.md) & `object`
+
+## Parameters
+
+### ui
+
+`U`
+
+Component UI
+
+### effects
+
+[`Effects`](../type-aliases/Effects.md)\<`P`, `U`\>
+
+Effect functions to run
+
+## Returns
+
+[`Cleanup`](../type-aliases/Cleanup.md)
+
+- Cleanup function that runs collected cleanup functions
+
+## Since
+
+0.15.0
+
+## Throws
+
+- If the effects are invalid

package/docs-src/api/functions/runElementEffects.md

@@ -0,0 +1,57 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / runElementEffects
+
+# Function: runElementEffects()
+
+> **runElementEffects**\<`P`, `E`\>(`host`, `target`, `effects`): [`MaybeCleanup`](../type-aliases/MaybeCleanup.md)
+
+Defined in: [src/effects.ts:98](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/effects.ts#L98)
+
+Run element effects
+
+## Type Parameters
+
+### P
+
+`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+### E
+
+`E` *extends* `Element`
+
+## Parameters
+
+### host
+
+[`Component`](../type-aliases/Component.md)\<`P`\>
+
+Host component
+
+### target
+
+`E`
+
+Target element
+
+### effects
+
+[`ElementEffects`](../type-aliases/ElementEffects.md)\<`P`, `E`\>
+
+Effect functions to run
+
+## Returns
+
+[`MaybeCleanup`](../type-aliases/MaybeCleanup.md)
+
+- Cleanup function that runs collected cleanup functions
+
+## Since
+
+0.15.0
+
+## Throws
+
+- If the effects are invalid

package/docs-src/api/functions/schedule.md

@@ -0,0 +1,33 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / schedule
+
+# Function: schedule()
+
+> **schedule**(`element`, `task`): `void`
+
+Defined in: [src/scheduler.ts:41](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/scheduler.ts#L41)
+
+Schedule a task to be executed on the next animation frame, with automatic
+deduplication per component. If the same component schedules multiple tasks
+before the next frame, only the latest task will be executed.
+
+## Parameters
+
+### element
+
+`Element`
+
+Element for deduplication
+
+### task
+
+() => `void`
+
+Function to execute (typically calls batch() or sets a signal)
+
+## Returns
+
+`void`

package/docs-src/api/functions/setAttribute.md

@@ -0,0 +1,48 @@
+[**le-truc**](../README.md)
+
+***
+
+[le-truc](../globals.md) / setAttribute
+
+# Function: setAttribute()
+
+> **setAttribute**\<`P`, `E`\>(`name`, `reactive`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Defined in: [src/effects/attribute.ts:41](https://github.com/zeixcom/le-truc/blob/5bd629bc02429c8193f06a75f94397faf30ed891/src/effects/attribute.ts#L41)
+
+Effect for setting an attribute on an element.
+Sets the specified attribute with security validation for unsafe values.
+
+## Type Parameters
+
+### P
+
+`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md)
+
+### E
+
+`E` *extends* `Element`
+
+## Parameters
+
+### name
+
+`string`
+
+Name of the attribute to set
+
+### reactive
+
+[`Reactive`](../type-aliases/Reactive.md)\<`string`, `P`, `E`\> = `...`
+
+Reactive value bound to the attribute value (defaults to attribute name)
+
+## Returns
+
+[`Effect`](../type-aliases/Effect.md)\<`P`, `E`\>
+
+Effect function that sets the attribute on the element
+
+## Since
+
+0.8.0