From 230cd6cc9b2252d1741350e7be8be3e04b6f2cf4 Mon Sep 17 00:00:00 2001 From: Esther Brunner Date: Wed, 22 Oct 2025 09:28:37 +0200 Subject: [PATCH 1/2] chore: rename to le-truc --- CONTRIBUTING.md | 10 +- README.md | 42 +- docs-src/includes/menu.html | 130 +- docs-src/layout.html | 4 +- docs-src/pages/about.md | 26 +- docs-src/pages/api/README.md | 46 +- .../api/classes/CircularMutationError.md | 8 +- .../api/classes/DependencyTimeoutError.md | 64 +- .../api/classes/InvalidComponentNameError.md | 64 +- .../pages/api/classes/InvalidEffectsError.md | 64 +- .../api/classes/InvalidPropertyNameError.md | 64 +- .../pages/api/classes/InvalidSignalError.md | 64 +- .../pages/api/classes/MissingElementError.md | 64 +- docs-src/pages/api/functions/asBoolean.md | 8 +- docs-src/pages/api/functions/asEnum.md | 8 +- docs-src/pages/api/functions/asInteger.md | 10 +- docs-src/pages/api/functions/asJSON.md | 12 +- docs-src/pages/api/functions/asNumber.md | 10 +- docs-src/pages/api/functions/asString.md | 10 +- docs-src/pages/api/functions/batch.md | 4 +- docs-src/pages/api/functions/component.md | 10 +- docs-src/pages/api/functions/computed.md | 10 +- .../api/functions/dangerouslySetInnerHTML.md | 12 +- docs-src/pages/api/functions/effect.md | 10 +- docs-src/pages/api/functions/emitEvent.md | 12 +- docs-src/pages/api/functions/enqueue.md | 8 +- docs-src/pages/api/functions/fromContext.md | 6 +- docs-src/pages/api/functions/fromDOM.md | 14 +- docs-src/pages/api/functions/fromEvents.md | 14 +- docs-src/pages/api/functions/fromSelector.md | 18 +- docs-src/pages/api/functions/getAttribute.md | 10 +- .../pages/api/functions/getDescription.md | 10 +- docs-src/pages/api/functions/getFallback.md | 12 +- docs-src/pages/api/functions/getLabel.md | 10 +- docs-src/pages/api/functions/getProperty.md | 12 +- docs-src/pages/api/functions/getStyle.md | 10 +- docs-src/pages/api/functions/getText.md | 10 +- docs-src/pages/api/functions/hasAttribute.md | 8 +- docs-src/pages/api/functions/hasClass.md | 8 +- .../api/functions/insertOrRemoveElement.md | 12 +- docs-src/pages/api/functions/isComputed.md | 4 +- docs-src/pages/api/functions/isParser.md | 12 +- docs-src/pages/api/functions/isSignal.md | 10 +- docs-src/pages/api/functions/isState.md | 10 +- docs-src/pages/api/functions/log.md | 8 +- docs-src/pages/api/functions/on.md | 14 +- docs-src/pages/api/functions/pass.md | 16 +- .../pages/api/functions/provideContexts.md | 12 +- .../pages/api/functions/resolveReactive.md | 14 +- docs-src/pages/api/functions/setAttribute.md | 12 +- docs-src/pages/api/functions/setProperty.md | 14 +- docs-src/pages/api/functions/setStyle.md | 12 +- docs-src/pages/api/functions/setText.md | 12 +- docs-src/pages/api/functions/show.md | 12 +- docs-src/pages/api/functions/state.md | 10 +- docs-src/pages/api/functions/toSignal.md | 10 +- .../pages/api/functions/toggleAttribute.md | 12 +- docs-src/pages/api/functions/toggleClass.md | 12 +- docs-src/pages/api/functions/updateElement.md | 14 +- docs-src/pages/api/globals.md | 16 +- docs-src/pages/api/type-aliases/Cleanup.md | 10 +- docs-src/pages/api/type-aliases/Component.md | 16 +- .../pages/api/type-aliases/ComponentProps.md | 8 +- docs-src/pages/api/type-aliases/Computed.md | 16 +- .../api/type-aliases/ComputedCallback.md | 12 +- docs-src/pages/api/type-aliases/Context.md | 10 +- .../pages/api/type-aliases/ContextType.md | 12 +- .../DangerouslySetInnerHTMLOptions.md | 14 +- docs-src/pages/api/type-aliases/Effect.md | 12 +- .../pages/api/type-aliases/EffectMatcher.md | 26 +- docs-src/pages/api/type-aliases/Effects.md | 12 +- .../pages/api/type-aliases/ElementEffects.md | 14 +- .../api/type-aliases/ElementFromSelector.md | 12 +- .../pages/api/type-aliases/ElementInserter.md | 24 +- .../pages/api/type-aliases/ElementUpdater.md | 36 +- .../pages/api/type-aliases/ElementUsage.md | 16 +- .../pages/api/type-aliases/ElementsUsage.md | 12 +- .../pages/api/type-aliases/EventHandler.md | 14 +- .../api/type-aliases/EventTransformer.md | 16 +- .../api/type-aliases/EventTransformers.md | 14 +- docs-src/pages/api/type-aliases/EventType.md | 12 +- docs-src/pages/api/type-aliases/ExtractTag.md | 12 +- docs-src/pages/api/type-aliases/Extractor.md | 12 +- docs-src/pages/api/type-aliases/Fallback.md | 12 +- docs-src/pages/api/type-aliases/Helpers.md | 24 +- .../pages/api/type-aliases/Initializer.md | 12 +- docs-src/pages/api/type-aliases/KnownTag.md | 12 +- docs-src/pages/api/type-aliases/LogLevel.md | 8 +- .../pages/api/type-aliases/LooseExtractor.md | 10 +- .../pages/api/type-aliases/MaybeSignal.md | 12 +- docs-src/pages/api/type-aliases/Parser.md | 6 +- .../api/type-aliases/ParserOrFallback.md | 12 +- docs-src/pages/api/type-aliases/Reactive.md | 12 +- docs-src/pages/api/type-aliases/Reactives.md | 12 +- .../pages/api/type-aliases/ReservedWords.md | 8 +- docs-src/pages/api/type-aliases/Setup.md | 10 +- docs-src/pages/api/type-aliases/Signal.md | 14 +- docs-src/pages/api/type-aliases/State.md | 24 +- .../pages/api/type-aliases/UnknownContext.md | 8 +- .../pages/api/type-aliases/UpdateOperation.md | 8 +- .../api/type-aliases/ValidPropertyKey.md | 10 +- .../type-aliases/ValidateComponentProps.md | 8 +- docs-src/pages/api/variables/DEV_MODE.md | 12 +- docs-src/pages/api/variables/LOG_DEBUG.md | 12 +- docs-src/pages/api/variables/LOG_ERROR.md | 12 +- docs-src/pages/api/variables/LOG_INFO.md | 12 +- docs-src/pages/api/variables/LOG_WARN.md | 12 +- docs-src/pages/api/variables/RESET.md | 8 +- docs-src/pages/api/variables/UNSET.md | 10 +- docs-src/pages/blog.md | 2 +- docs-src/pages/blog/rethinking-reactivity.md | 4 +- .../pages/blog/the-case-for-components.md | 16 +- docs-src/pages/components.md | 42 +- docs-src/pages/data-flow.md | 12 +- docs-src/pages/examples.md | 2 +- docs-src/pages/getting-started.md | 34 +- docs-src/pages/index.md | 20 +- docs-src/pages/styling.md | 6 +- docs-src/server/build-optimized-assets.ts | 4 +- docs-src/server/generate-sitemap.ts | 2 +- docs-src/server/serve-docs.ts | 2 +- docs/.htaccess | 2 +- docs/_headers | 2 +- docs/about.html | 633 ++- docs/api.html | 847 ++-- docs/api/README.html | 664 +-- docs/api/classes/CircularMutationError.html | 1175 +++--- docs/api/classes/DependencyTimeoutError.html | 1171 +++--- .../classes/InvalidComponentNameError.html | 1159 ++--- docs/api/classes/InvalidEffectsError.html | 1174 +++--- .../api/classes/InvalidPropertyNameError.html | 1193 +++--- docs/api/classes/InvalidSignalError.html | 1169 +++--- docs/api/classes/MissingElementError.html | 1192 +++--- docs/api/functions/asBoolean.html | 257 +- docs/api/functions/asEnum.html | 291 +- docs/api/functions/asInteger.html | 331 +- docs/api/functions/asJSON.html | 370 +- docs/api/functions/asNumber.html | 326 +- docs/api/functions/asString.html | 326 +- docs/api/functions/batch.html | 265 +- docs/api/functions/component.html | 393 +- docs/api/functions/computed.html | 323 +- .../functions/dangerouslySetInnerHTML.html | 377 +- docs/api/functions/effect.html | 6 +- docs/api/functions/emitEvent.html | 380 +- docs/api/functions/enqueue.html | 10 +- docs/api/functions/fromContext.html | 370 +- docs/api/functions/fromDOM.html | 378 +- docs/api/functions/fromEvents.html | 401 +- docs/api/functions/fromSelector.html | 557 ++- docs/api/functions/getAttribute.html | 301 +- docs/api/functions/getDescription.html | 302 +- docs/api/functions/getFallback.html | 349 +- docs/api/functions/getLabel.html | 300 +- docs/api/functions/getProperty.html | 313 +- docs/api/functions/getStyle.html | 302 +- docs/api/functions/getText.html | 274 +- docs/api/functions/hasAttribute.html | 267 +- docs/api/functions/hasClass.html | 267 +- docs/api/functions/insertOrRemoveElement.html | 382 +- docs/api/functions/isComputed.html | 315 +- docs/api/functions/isParser.html | 329 +- docs/api/functions/isSignal.html | 313 +- docs/api/functions/isState.html | 316 +- docs/api/functions/log.html | 354 +- docs/api/functions/on.html | 401 +- docs/api/functions/pass.html | 391 +- docs/api/functions/provideContexts.html | 407 +- docs/api/functions/resolveReactive.html | 384 +- docs/api/functions/setAttribute.html | 371 +- docs/api/functions/setProperty.html | 382 +- docs/api/functions/setStyle.html | 373 +- docs/api/functions/setText.html | 352 +- docs/api/functions/show.html | 350 +- docs/api/functions/state.html | 323 +- docs/api/functions/toSignal.html | 326 +- docs/api/functions/toggleAttribute.html | 374 +- docs/api/functions/toggleClass.html | 369 +- docs/api/functions/updateElement.html | 392 +- docs/api/globals.html | 695 +-- docs/api/type-aliases/Cleanup.html | 8 +- docs/api/type-aliases/Component.html | 628 +-- docs/api/type-aliases/ComponentProps.html | 226 +- docs/api/type-aliases/Computed.html | 383 +- docs/api/type-aliases/ComputedCallback.html | 297 +- docs/api/type-aliases/Context.html | 316 +- docs/api/type-aliases/ContextType.html | 266 +- .../DangerouslySetInnerHTMLOptions.html | 305 +- docs/api/type-aliases/Effect.html | 335 +- docs/api/type-aliases/EffectMatcher.html | 523 ++- docs/api/type-aliases/Effects.html | 282 +- docs/api/type-aliases/ElementEffects.html | 574 +-- .../api/type-aliases/ElementFromSelector.html | 277 +- docs/api/type-aliases/ElementInserter.html | 507 ++- docs/api/type-aliases/ElementUpdater.html | 710 ++-- docs/api/type-aliases/ElementUsage.html | 659 +-- docs/api/type-aliases/ElementsUsage.html | 454 +- docs/api/type-aliases/EventHandler.html | 376 +- docs/api/type-aliases/EventTransformer.html | 394 +- docs/api/type-aliases/EventTransformers.html | 290 +- docs/api/type-aliases/EventType.html | 256 +- docs/api/type-aliases/ExtractTag.html | 261 +- docs/api/type-aliases/Extractor.html | 311 +- docs/api/type-aliases/Fallback.html | 272 +- docs/api/type-aliases/Helpers.html | 404 +- docs/api/type-aliases/Initializer.html | 276 +- docs/api/type-aliases/KnownTag.html | 261 +- docs/api/type-aliases/LogLevel.html | 224 +- docs/api/type-aliases/LooseExtractor.html | 315 +- docs/api/type-aliases/MaybeSignal.html | 297 +- docs/api/type-aliases/Parser.html | 343 +- docs/api/type-aliases/ParserOrFallback.html | 274 +- docs/api/type-aliases/Reactive.html | 297 +- docs/api/type-aliases/Reactives.html | 276 +- docs/api/type-aliases/ReservedWords.html | 229 +- docs/api/type-aliases/Setup.html | 327 +- docs/api/type-aliases/Signal.html | 341 +- docs/api/type-aliases/State.html | 519 +-- docs/api/type-aliases/UnknownContext.html | 226 +- docs/api/type-aliases/UpdateOperation.html | 230 +- docs/api/type-aliases/ValidPropertyKey.html | 258 +- .../type-aliases/ValidateComponentProps.html | 258 +- docs/api/variables/DEV_MODE.html | 222 +- docs/api/variables/LOG_DEBUG.html | 224 +- docs/api/variables/LOG_ERROR.html | 224 +- docs/api/variables/LOG_INFO.html | 224 +- docs/api/variables/LOG_WARN.html | 224 +- docs/api/variables/RESET.html | 221 +- docs/api/variables/UNSET.html | 260 +- docs/assets/main.0b0743f4.js | 2 +- docs/assets/main.0b0743f4.js.map | 2 +- docs/assets/main.js | 2 +- docs/assets/main.js.map | 2 +- docs/blog.html | 250 +- docs/blog/composing-complexity.html | 6 +- docs/blog/flow-from-cause-to-effect.html | 211 +- docs/blog/html-first-thinking.html | 211 +- docs/blog/rethinking-reactivity.html | 962 +++-- docs/blog/the-case-for-components.html | 905 ++-- docs/components.html | 1861 ++++++--- docs/data-flow.html | 1954 ++++++--- docs/examples.html | 3716 ++++++++++------- docs/getting-started.html | 946 +++-- docs/index.html | 849 ++-- docs/sitemap.xml | 238 +- docs/styling.html | 12 +- docs/sw.js | 6 +- index.dev.js | 2 +- index.dev.ts | 2 +- index.js | 2 +- index.js.map | 4 +- index.ts | 2 +- llms.txt | 12 +- package-lock.json | 4 +- package.json | 6 +- src/lib/effects.ts | 6 +- types/index.d.ts | 2 +- types/index.dev.d.ts | 2 +- types/src/lib/effects.d.ts | 4 +- 259 files changed, 32814 insertions(+), 23501 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 22dd56fa..655ccb08 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Contributing to UIElement +# Contributing to Le Truc -Thank you for your interest in contributing to **UIElement**! Your contributions help improve the project and benefit the community. This guide outlines how to get involved. +Thank you for your interest in contributing to **Le Truc**! Your contributions help improve the project and benefit the community. This guide outlines how to get involved. --- @@ -31,7 +31,7 @@ By participating in this project, you agree to abide by our **[Code of Conduct]( If you find a bug or have a feature request: 1. **Search the issue tracker** to check if your issue has already been reported. -2. If not, [open a new issue](https://github.com/zeixcom/ui-element/issues/new) and provide: +2. If not, [open a new issue](https://github.com/zeixcom/le-truc/issues/new) and provide: - A clear and descriptive title. - Steps to reproduce the issue (if applicable). - Expected vs. actual behavior. @@ -71,7 +71,7 @@ To set up the project locally: bun install ``` -(UIElement uses Bun as its package manager and runtime.) +(Le Truc uses Bun as its package manager and runtime.) **Run tests in watch mode:** @@ -157,4 +157,4 @@ By contributing, you agree that your contributions will be licensed under the MI --- -Thank you for contributing to UIElement! 🚀 +Thank you for contributing to Le Truc! 🚀 diff --git a/README.md b/README.md index ef48dea2..354dfb1d 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,45 @@ -# UIElement +# Le Truc Version 0.14.0 -**UIElement** - a HTML-first library for reactive Web Components +**Le Truc** - a HTML-first library for reactive Web Components -UIElement is a set of functions to build reusable, loosely coupled Web Components with reactive properties. It provides structure through components and simplifies state management and DOM synchronization using declarative signals and effects, leading to more organized and maintainable code without a steep learning curve. +Le Truc is a set of functions to build reusable, loosely coupled Web Components with reactive properties. It provides structure through components and simplifies state management and DOM synchronization using declarative signals and effects, leading to more organized and maintainable code without a steep learning curve. -Unlike SPA frameworks (React, Vue, Svelte, etc.) UIElement takes a HTML-first approach, progressively enhancing sever-rendered HTML rather than recreating (rendering) it using JavaScript. UIElement achieves the same result as SPA frameworks with SSR, but with a simpler, more efficient approach. It works with a backend written in any language or with any static site generator. +Unlike SPA frameworks (React, Vue, Svelte, etc.) Le Truc takes a HTML-first approach, progressively enhancing sever-rendered HTML rather than recreating (rendering) it using JavaScript. Le Truc achieves the same result as SPA frameworks with SSR, but with a simpler, more efficient approach. It works with a backend written in any language or with any static site generator. ## Key Features -- 🧱 **HTML Web Components**: Build on standard HTML and enhance it with encapsulated, reusable Web Components. No virtual DOM – UIElement works directly with the real DOM. +- 🧱 **HTML Web Components**: Build on standard HTML and enhance it with encapsulated, reusable Web Components. No virtual DOM – Le Truc works directly with the real DOM. - 🚦 **Reactive Properties**: Define reactive properties for fine-grained, efficient state management (signals). Changes automatically propagate only to the parts of the DOM that need updating, avoiding unnecessary re-renders. - 🧩 **Function Composition**: Declare component behavior by composing small, reusable functions (attribute parsers and effects). This promotes cleaner code compared to spaghetti code problems that commonly occur when writing low-level imperative code. -- 🛠️ **Customizable**: UIElement is designed to be easily customizable and extensible. You can create your own custom attribute parsers and effects to suit your specific needs. +- 🛠️ **Customizable**: Le Truc is designed to be easily customizable and extensible. You can create your own custom attribute parsers and effects to suit your specific needs. - 🌐 **Context Support**: Share global states across components without prop drilling or tightly coupling logic. - 🪶 **Tiny footprint**: Minimal core (~4kB gzipped) with tree-shaking support, adding only the necessary JavaScript to enhance your HTML. - 🛡️ **Type Safety**: Get early warnings when types don't match, improving code quality and reducing bugs. -UIElement uses [Cause & Effect](https://github.com/zeixcom/cause-effect) internally for state management with signals and for scheduled DOM updates. But you could easily rewrite the `component()` function to use a signals library of your choice or to produce something else than Web Components. +Le Truc uses [Cause & Effect](https://github.com/zeixcom/cause-effect) internally for state management with signals and for scheduled DOM updates. But you could easily rewrite the `component()` function to use a signals library of your choice or to produce something else than Web Components. ## Installation ```bash # with npm -npm install @zeix/ui-element +npm install @zeix/le-truc # or with bun -bun add @zeix/ui-element +bun add @zeix/le-truc ``` ## Documentation The full documentation is still work in progress. The following chapters are already reasonably complete: -- [Introduction](https://zeixcom.github.io/ui-element/index.html) -- [Getting Started](https://zeixcom.github.io/ui-element/getting-started.html) -- [Components](https://zeixcom.github.io/ui-element/components.html) -- [Styling](https://zeixcom.github.io/ui-element/styling.html) -- [Data Flow](https://zeixcom.github.io/ui-element/data-flow.html) -- [About](https://zeixcom.github.io/ui-element/about.html) +- [Introduction](https://zeixcom.github.io/le-truc/index.html) +- [Getting Started](https://zeixcom.github.io/le-truc/getting-started.html) +- [Components](https://zeixcom.github.io/le-truc/components.html) +- [Styling](https://zeixcom.github.io/le-truc/styling.html) +- [Data Flow](https://zeixcom.github.io/le-truc/data-flow.html) +- [About](https://zeixcom.github.io/le-truc/about.html) ## Basic Usage @@ -53,10 +53,10 @@ Server-rendered markup: ``` -UIElement component: +Le Truc component: ```js -import { asInteger, component, on, setText } from '@zeix/ui-element' +import { asInteger, component, on, setText } from '@zeix/le-truc' export default component( 'basic-counter', @@ -157,10 +157,10 @@ Server-rendered markup: ``` -UIElement component: +Le Truc component: ````js -import { component, on, setProperty, show } from '@zeix/ui-element' +import { component, on, setProperty, show } from '@zeix/le-truc' import { manageArrowKeyFocus } from './manage-arrow-key-focus' export default component('module-tabgroup', { @@ -298,7 +298,7 @@ An example demonstrating how to use a custom attribute parser (sanitize an URL) ``` -UIElement component: +Le Truc component: ```js import { @@ -310,7 +310,7 @@ import { show, state, toggleClass, -} from '@zeix/ui-element' +} from '@zeix/le-truc' import { asURL } from './as-url' export default component( diff --git a/docs-src/includes/menu.html b/docs-src/includes/menu.html index 1d4c30ea..e7e93bf9 100644 --- a/docs-src/includes/menu.html +++ b/docs-src/includes/menu.html @@ -1,80 +1,78 @@ - - \ No newline at end of file + diff --git a/docs-src/layout.html b/docs-src/layout.html index 23b06f30..207b5ffe 100644 --- a/docs-src/layout.html +++ b/docs-src/layout.html @@ -3,7 +3,7 @@ - {{ title }} – UIElement Docs + {{ title }} – Le Truc Docs

- UIElement Docs Version 0.14.0 + Le Truc Docs Version 0.14.0

{{ include 'menu.html' }} ### Versioning Scheme -UIElement follows [Semantic Versioning](https://semver.org/) (SemVer), which is structured as MAJOR.MINOR.PATCH. +Le Truc follows [Semantic Versioning](https://semver.org/) (SemVer), which is structured as MAJOR.MINOR.PATCH. - **MAJOR**: Breaking changes that require migrations. - **MINOR**: New features that are backwards compatible. @@ -72,7 +72,7 @@ UIElement follows [Semantic Versioning](https://semver.org/) (SemVer), which is ### Previous Pre-Releases -View all releases and associated notes on [Github Releases](https://github.com/zeixcom/ui-element/releases). +View all releases and associated notes on [Github Releases](https://github.com/zeixcom/le-truc/releases). @@ -80,19 +80,19 @@ View all releases and associated notes on [Github Releases](https://github.com/z ## Getting Involved -UIElement is **an open-source project**, and contributions are always welcome! Whether you’re **reporting bugs, improving documentation, or suggesting features**, here's how you can help: +Le Truc is **an open-source project**, and contributions are always welcome! Whether you’re **reporting bugs, improving documentation, or suggesting features**, here's how you can help: -- [Open an Issue](https://github.com/zeixcom/ui-element/issues) – Report bugs or suggest features. -- [Submit a Pull Request](https://github.com/zeixcom/ui-element/blob/main/CONTRIBUTING.md) – Help improve UIElement by fixing issues or adding new features. +- [Open an Issue](https://github.com/zeixcom/le-truc/issues) – Report bugs or suggest features. +- [Submit a Pull Request](https://github.com/zeixcom/le-truc/blob/main/CONTRIBUTING.md) – Help improve Le Truc by fixing issues or adding new features. - Join the Discussion – Share ideas and get feedback from the community. ### Contributing Code - Fork the repository, create a new branch, and submit a pull request. -- Read the [Contributing Guidelines](https://github.com/zeixcom/ui-element/blob/main/CONTRIBUTING.md) for setting up a development environment and best practices. +- Read the [Contributing Guidelines](https://github.com/zeixcom/le-truc/blob/main/CONTRIBUTING.md) for setting up a development environment and best practices. ### Community Guidelines -We strive for a welcoming and inclusive environment. Please follow our [Code of Conduct](https://github.com/zeixcom/ui-element/blob/main/CODE_OF_CONDUCT.md) when contributing. +We strive for a welcoming and inclusive environment. Please follow our [Code of Conduct](https://github.com/zeixcom/le-truc/blob/main/CODE_OF_CONDUCT.md) when contributing. diff --git a/docs-src/pages/api/README.md b/docs-src/pages/api/README.md index b2d26bc2..ee23d5f9 100644 --- a/docs-src/pages/api/README.md +++ b/docs-src/pages/api/README.md @@ -1,49 +1,49 @@ -**@zeix/ui-element** +**@zeix/le-truc** -*** +--- -# UIElement +# Le Truc Version 0.14.0 -**UIElement** - a HTML-first library for reactive Web Components +**Le Truc** - a HTML-first library for reactive Web Components -UIElement is a set of functions to build reusable, loosely coupled Web Components with reactive properties. It provides structure through components and simplifies state management and DOM synchronization using declarative signals and effects, leading to more organized and maintainable code without a steep learning curve. +Le Truc is a set of functions to build reusable, loosely coupled Web Components with reactive properties. It provides structure through components and simplifies state management and DOM synchronization using declarative signals and effects, leading to more organized and maintainable code without a steep learning curve. -Unlike SPA frameworks (React, Vue, Svelte, etc.) UIElement takes a HTML-first approach, progressively enhancing sever-rendered HTML rather than recreating (rendering) it using JavaScript. UIElement achieves the same result as SPA frameworks with SSR, but with a simpler, more efficient approach. It works with a backend written in any language or with any static site generator. +Unlike SPA frameworks (React, Vue, Svelte, etc.) Le Truc takes a HTML-first approach, progressively enhancing sever-rendered HTML rather than recreating (rendering) it using JavaScript. Le Truc achieves the same result as SPA frameworks with SSR, but with a simpler, more efficient approach. It works with a backend written in any language or with any static site generator. ## Key Features -- 🧱 **HTML Web Components**: Build on standard HTML and enhance it with encapsulated, reusable Web Components. No virtual DOM – UIElement works directly with the real DOM. +- 🧱 **HTML Web Components**: Build on standard HTML and enhance it with encapsulated, reusable Web Components. No virtual DOM – Le Truc works directly with the real DOM. - 🚦 **Reactive Properties**: Define reactive properties for fine-grained, efficient state management (signals). Changes automatically propagate only to the parts of the DOM that need updating, avoiding unnecessary re-renders. - 🧩 **Function Composition**: Declare component behavior by composing small, reusable functions (attribute parsers and effects). This promotes cleaner code compared to spaghetti code problems that commonly occur when writing low-level imperative code. -- 🛠️ **Customizable**: UIElement is designed to be easily customizable and extensible. You can create your own custom attribute parsers and effects to suit your specific needs. +- 🛠️ **Customizable**: Le Truc is designed to be easily customizable and extensible. You can create your own custom attribute parsers and effects to suit your specific needs. - 🌐 **Context Support**: Share global states across components without prop drilling or tightly coupling logic. - 🪶 **Tiny footprint**: Minimal core (~4kB gzipped) with tree-shaking support, adding only the necessary JavaScript to enhance your HTML. - 🛡️ **Type Safety**: Get early warnings when types don't match, improving code quality and reducing bugs. -UIElement uses [Cause & Effect](https://github.com/zeixcom/cause-effect) internally for state management with signals and for scheduled DOM updates. But you could easily rewrite the `component()` function to use a signals library of your choice or to produce something else than Web Components. +Le Truc uses [Cause & Effect](https://github.com/zeixcom/cause-effect) internally for state management with signals and for scheduled DOM updates. But you could easily rewrite the `component()` function to use a signals library of your choice or to produce something else than Web Components. ## Installation ```bash # with npm -npm install @zeix/ui-element +npm install @zeix/le-truc # or with bun -bun add @zeix/ui-element +bun add @zeix/le-truc ``` ## Documentation The full documentation is still work in progress. The following chapters are already reasonably complete: -- [Introduction](https://zeixcom.github.io/ui-element/index.html) -- [Getting Started](https://zeixcom.github.io/ui-element/getting-started.html) -- [Components](https://zeixcom.github.io/ui-element/components.html) -- [Styling](https://zeixcom.github.io/ui-element/styling.html) -- [Data Flow](https://zeixcom.github.io/ui-element/data-flow.html) -- [About](https://zeixcom.github.io/ui-element/about.html) +- [Introduction](https://zeixcom.github.io/le-truc/index.html) +- [Getting Started](https://zeixcom.github.io/le-truc/getting-started.html) +- [Components](https://zeixcom.github.io/le-truc/components.html) +- [Styling](https://zeixcom.github.io/le-truc/styling.html) +- [Data Flow](https://zeixcom.github.io/le-truc/data-flow.html) +- [About](https://zeixcom.github.io/le-truc/about.html) ## Basic Usage @@ -57,10 +57,10 @@ Server-rendered markup: ``` -UIElement component: +Le Truc component: ```js -import { asInteger, component, on, setText } from '@zeix/ui-element' +import { asInteger, component, on, setText } from '@zeix/le-truc' export default component( 'basic-counter', @@ -161,10 +161,10 @@ Server-rendered markup: ``` -UIElement component: +Le Truc component: ````js -import { component, on, setProperty, show } from '@zeix/ui-element' +import { component, on, setProperty, show } from '@zeix/le-truc' import { manageArrowKeyFocus } from './manage-arrow-key-focus' export default component('module-tabgroup', { @@ -302,7 +302,7 @@ An example demonstrating how to use a custom attribute parser (sanitize an URL) ``` -UIElement component: +Le Truc component: ```js import { @@ -314,7 +314,7 @@ import { show, state, toggleClass, -} from '@zeix/ui-element' +} from '@zeix/le-truc' import { asURL } from './as-url' export default component( diff --git a/docs-src/pages/api/classes/CircularMutationError.md b/docs-src/pages/api/classes/CircularMutationError.md index 8a9e5d4a..3706de63 100644 --- a/docs-src/pages/api/classes/CircularMutationError.md +++ b/docs-src/pages/api/classes/CircularMutationError.md @@ -1,12 +1,12 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) *** -[@zeix/ui-element](../globals.md) / CircularMutationError +[@zeix/le-truc](../globals.md) / CircularMutationError # Class: CircularMutationError -Defined in: [src/core/errors.ts:10](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L10) +Defined in: [src/core/errors.ts:10](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L10) Error thrown when a circular dependency is detected in a selection signal @@ -24,7 +24,7 @@ Error thrown when a circular dependency is detected in a selection signal > **new CircularMutationError**(`host`, `selector`): `CircularMutationError` -Defined in: [src/core/errors.ts:15](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L15) +Defined in: [src/core/errors.ts:15](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L15) #### Parameters diff --git a/docs-src/pages/api/classes/DependencyTimeoutError.md b/docs-src/pages/api/classes/DependencyTimeoutError.md index 1effc23f..3f364922 100644 --- a/docs-src/pages/api/classes/DependencyTimeoutError.md +++ b/docs-src/pages/api/classes/DependencyTimeoutError.md @@ -1,12 +1,12 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / DependencyTimeoutError +[@zeix/le-truc](../globals.md) / DependencyTimeoutError # Class: DependencyTimeoutError -Defined in: [src/core/errors.ts:115](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L115) +Defined in: [src/core/errors.ts:115](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L115) Error when a component's dependencies are not met within a specified timeout @@ -24,7 +24,7 @@ Error when a component's dependencies are not met within a specified timeout > **new DependencyTimeoutError**(`host`, `missing`): `DependencyTimeoutError` -Defined in: [src/core/errors.ts:116](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L116) +Defined in: [src/core/errors.ts:116](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L116) #### Parameters @@ -50,7 +50,7 @@ Defined in: [src/core/errors.ts:116](https://github.com/zeixcom/ui-element/blob/ > `optional` **cause**: `unknown` -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 +Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26 The cause of the error. @@ -58,49 +58,49 @@ The cause of the error. `Error.cause` -*** +--- ### message > **message**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077 #### Inherited from `Error.message` -*** +--- ### name > **name**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 #### Inherited from `Error.name` -*** +--- ### stack? > `optional` **stack**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078 #### Inherited from `Error.stack` -*** +--- ### stackTraceLimit > `static` **stackTraceLimit**: `number` -Defined in: node\_modules/bun-types/globals.d.ts:990 +Defined in: node_modules/bun-types/globals.d.ts:990 The maximum number of stack frames to capture. @@ -116,7 +116,7 @@ The maximum number of stack frames to capture. > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` -Defined in: node\_modules/bun-types/globals.d.ts:985 +Defined in: node_modules/bun-types/globals.d.ts:985 Create .stack property on a target object @@ -142,16 +142,16 @@ Create .stack property on a target object > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` -Defined in: node\_modules/@types/node/globals.d.ts:145 +Defined in: node_modules/@types/node/globals.d.ts:145 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js -const myObject = {}; -Error.captureStackTrace(myObject); -myObject.stack; // Similar to `new Error().stack` +const myObject = {} +Error.captureStackTrace(myObject) +myObject.stack // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with @@ -166,26 +166,26 @@ details of error generation from the user. For instance: ```js function a() { - b(); + b() } function b() { - c(); + c() } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. - const { stackTraceLimit } = Error; - Error.stackTraceLimit = 0; - const error = new Error(); - Error.stackTraceLimit = stackTraceLimit; + const { stackTraceLimit } = Error + Error.stackTraceLimit = 0 + const error = new Error() + Error.stackTraceLimit = stackTraceLimit // Capture the stack trace above function b - Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace - throw error; + Error.captureStackTrace(error, b) // Neither function c, nor b is included in the stack trace + throw error } -a(); +a() ``` ##### Parameters @@ -206,13 +206,13 @@ a(); `Error.captureStackTrace` -*** +--- ### isError() > `static` **isError**(`value`): `value is Error` -Defined in: node\_modules/bun-types/globals.d.ts:980 +Defined in: node_modules/bun-types/globals.d.ts:980 Check if a value is an instance of Error @@ -234,13 +234,13 @@ True if the value is an instance of Error, false otherwise `Error.isError` -*** +--- ### prepareStackTrace() > `static` **prepareStackTrace**(`err`, `stackTraces`): `any` -Defined in: node\_modules/@types/node/globals.d.ts:149 +Defined in: node_modules/@types/node/globals.d.ts:149 #### Parameters diff --git a/docs-src/pages/api/classes/InvalidComponentNameError.md b/docs-src/pages/api/classes/InvalidComponentNameError.md index 71c5142f..455c44cf 100644 --- a/docs-src/pages/api/classes/InvalidComponentNameError.md +++ b/docs-src/pages/api/classes/InvalidComponentNameError.md @@ -1,12 +1,12 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / InvalidComponentNameError +[@zeix/le-truc](../globals.md) / InvalidComponentNameError # Class: InvalidComponentNameError -Defined in: [src/core/errors.ts:28](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L28) +Defined in: [src/core/errors.ts:28](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L28) Error thrown when component name violates rules for custom element names @@ -24,7 +24,7 @@ Error thrown when component name violates rules for custom element names > **new InvalidComponentNameError**(`component`): `InvalidComponentNameError` -Defined in: [src/core/errors.ts:32](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L32) +Defined in: [src/core/errors.ts:32](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L32) #### Parameters @@ -48,7 +48,7 @@ Component name > `optional` **cause**: `unknown` -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 +Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26 The cause of the error. @@ -56,49 +56,49 @@ The cause of the error. `Error.cause` -*** +--- ### message > **message**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077 #### Inherited from `Error.message` -*** +--- ### name > **name**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 #### Inherited from `Error.name` -*** +--- ### stack? > `optional` **stack**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078 #### Inherited from `Error.stack` -*** +--- ### stackTraceLimit > `static` **stackTraceLimit**: `number` -Defined in: node\_modules/bun-types/globals.d.ts:990 +Defined in: node_modules/bun-types/globals.d.ts:990 The maximum number of stack frames to capture. @@ -114,7 +114,7 @@ The maximum number of stack frames to capture. > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` -Defined in: node\_modules/bun-types/globals.d.ts:985 +Defined in: node_modules/bun-types/globals.d.ts:985 Create .stack property on a target object @@ -140,16 +140,16 @@ Create .stack property on a target object > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` -Defined in: node\_modules/@types/node/globals.d.ts:145 +Defined in: node_modules/@types/node/globals.d.ts:145 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js -const myObject = {}; -Error.captureStackTrace(myObject); -myObject.stack; // Similar to `new Error().stack` +const myObject = {} +Error.captureStackTrace(myObject) +myObject.stack // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with @@ -164,26 +164,26 @@ details of error generation from the user. For instance: ```js function a() { - b(); + b() } function b() { - c(); + c() } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. - const { stackTraceLimit } = Error; - Error.stackTraceLimit = 0; - const error = new Error(); - Error.stackTraceLimit = stackTraceLimit; + const { stackTraceLimit } = Error + Error.stackTraceLimit = 0 + const error = new Error() + Error.stackTraceLimit = stackTraceLimit // Capture the stack trace above function b - Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace - throw error; + Error.captureStackTrace(error, b) // Neither function c, nor b is included in the stack trace + throw error } -a(); +a() ``` ##### Parameters @@ -204,13 +204,13 @@ a(); `Error.captureStackTrace` -*** +--- ### isError() > `static` **isError**(`value`): `value is Error` -Defined in: node\_modules/bun-types/globals.d.ts:980 +Defined in: node_modules/bun-types/globals.d.ts:980 Check if a value is an instance of Error @@ -232,13 +232,13 @@ True if the value is an instance of Error, false otherwise `Error.isError` -*** +--- ### prepareStackTrace() > `static` **prepareStackTrace**(`err`, `stackTraces`): `any` -Defined in: node\_modules/@types/node/globals.d.ts:149 +Defined in: node_modules/@types/node/globals.d.ts:149 #### Parameters diff --git a/docs-src/pages/api/classes/InvalidEffectsError.md b/docs-src/pages/api/classes/InvalidEffectsError.md index 278a8cee..c2b35522 100644 --- a/docs-src/pages/api/classes/InvalidEffectsError.md +++ b/docs-src/pages/api/classes/InvalidEffectsError.md @@ -1,12 +1,12 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / InvalidEffectsError +[@zeix/le-truc](../globals.md) / InvalidEffectsError # Class: InvalidEffectsError -Defined in: [src/core/errors.ts:64](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L64) +Defined in: [src/core/errors.ts:64](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L64) Error thrown when setup function does not return effects @@ -24,7 +24,7 @@ Error thrown when setup function does not return effects > **new InvalidEffectsError**(`host`, `cause?`): `InvalidEffectsError` -Defined in: [src/core/errors.ts:69](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L69) +Defined in: [src/core/errors.ts:69](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L69) #### Parameters @@ -54,7 +54,7 @@ Error that caused the invalid effects > `optional` **cause**: `unknown` -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 +Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26 The cause of the error. @@ -62,49 +62,49 @@ The cause of the error. `Error.cause` -*** +--- ### message > **message**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077 #### Inherited from `Error.message` -*** +--- ### name > **name**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 #### Inherited from `Error.name` -*** +--- ### stack? > `optional` **stack**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078 #### Inherited from `Error.stack` -*** +--- ### stackTraceLimit > `static` **stackTraceLimit**: `number` -Defined in: node\_modules/bun-types/globals.d.ts:990 +Defined in: node_modules/bun-types/globals.d.ts:990 The maximum number of stack frames to capture. @@ -120,7 +120,7 @@ The maximum number of stack frames to capture. > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` -Defined in: node\_modules/bun-types/globals.d.ts:985 +Defined in: node_modules/bun-types/globals.d.ts:985 Create .stack property on a target object @@ -146,16 +146,16 @@ Create .stack property on a target object > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` -Defined in: node\_modules/@types/node/globals.d.ts:145 +Defined in: node_modules/@types/node/globals.d.ts:145 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js -const myObject = {}; -Error.captureStackTrace(myObject); -myObject.stack; // Similar to `new Error().stack` +const myObject = {} +Error.captureStackTrace(myObject) +myObject.stack // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with @@ -170,26 +170,26 @@ details of error generation from the user. For instance: ```js function a() { - b(); + b() } function b() { - c(); + c() } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. - const { stackTraceLimit } = Error; - Error.stackTraceLimit = 0; - const error = new Error(); - Error.stackTraceLimit = stackTraceLimit; + const { stackTraceLimit } = Error + Error.stackTraceLimit = 0 + const error = new Error() + Error.stackTraceLimit = stackTraceLimit // Capture the stack trace above function b - Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace - throw error; + Error.captureStackTrace(error, b) // Neither function c, nor b is included in the stack trace + throw error } -a(); +a() ``` ##### Parameters @@ -210,13 +210,13 @@ a(); `Error.captureStackTrace` -*** +--- ### isError() > `static` **isError**(`value`): `value is Error` -Defined in: node\_modules/bun-types/globals.d.ts:980 +Defined in: node_modules/bun-types/globals.d.ts:980 Check if a value is an instance of Error @@ -238,13 +238,13 @@ True if the value is an instance of Error, false otherwise `Error.isError` -*** +--- ### prepareStackTrace() > `static` **prepareStackTrace**(`err`, `stackTraces`): `any` -Defined in: node\_modules/@types/node/globals.d.ts:149 +Defined in: node_modules/@types/node/globals.d.ts:149 #### Parameters diff --git a/docs-src/pages/api/classes/InvalidPropertyNameError.md b/docs-src/pages/api/classes/InvalidPropertyNameError.md index 25034a1e..efd5616d 100644 --- a/docs-src/pages/api/classes/InvalidPropertyNameError.md +++ b/docs-src/pages/api/classes/InvalidPropertyNameError.md @@ -1,12 +1,12 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / InvalidPropertyNameError +[@zeix/le-truc](../globals.md) / InvalidPropertyNameError # Class: InvalidPropertyNameError -Defined in: [src/core/errors.ts:45](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L45) +Defined in: [src/core/errors.ts:45](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L45) Error thrown when trying to assign a property name that conflicts with reserved words or inherited HTMLElement properties @@ -24,7 +24,7 @@ Error thrown when trying to assign a property name that conflicts with reserved > **new InvalidPropertyNameError**(`component`, `prop`, `reason`): `InvalidPropertyNameError` -Defined in: [src/core/errors.ts:51](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L51) +Defined in: [src/core/errors.ts:51](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L51) #### Parameters @@ -60,7 +60,7 @@ Explanation why the property is invalid > `optional` **cause**: `unknown` -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 +Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26 The cause of the error. @@ -68,49 +68,49 @@ The cause of the error. `Error.cause` -*** +--- ### message > **message**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077 #### Inherited from `Error.message` -*** +--- ### name > **name**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 #### Inherited from `Error.name` -*** +--- ### stack? > `optional` **stack**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078 #### Inherited from `Error.stack` -*** +--- ### stackTraceLimit > `static` **stackTraceLimit**: `number` -Defined in: node\_modules/bun-types/globals.d.ts:990 +Defined in: node_modules/bun-types/globals.d.ts:990 The maximum number of stack frames to capture. @@ -126,7 +126,7 @@ The maximum number of stack frames to capture. > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` -Defined in: node\_modules/bun-types/globals.d.ts:985 +Defined in: node_modules/bun-types/globals.d.ts:985 Create .stack property on a target object @@ -152,16 +152,16 @@ Create .stack property on a target object > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` -Defined in: node\_modules/@types/node/globals.d.ts:145 +Defined in: node_modules/@types/node/globals.d.ts:145 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js -const myObject = {}; -Error.captureStackTrace(myObject); -myObject.stack; // Similar to `new Error().stack` +const myObject = {} +Error.captureStackTrace(myObject) +myObject.stack // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with @@ -176,26 +176,26 @@ details of error generation from the user. For instance: ```js function a() { - b(); + b() } function b() { - c(); + c() } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. - const { stackTraceLimit } = Error; - Error.stackTraceLimit = 0; - const error = new Error(); - Error.stackTraceLimit = stackTraceLimit; + const { stackTraceLimit } = Error + Error.stackTraceLimit = 0 + const error = new Error() + Error.stackTraceLimit = stackTraceLimit // Capture the stack trace above function b - Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace - throw error; + Error.captureStackTrace(error, b) // Neither function c, nor b is included in the stack trace + throw error } -a(); +a() ``` ##### Parameters @@ -216,13 +216,13 @@ a(); `Error.captureStackTrace` -*** +--- ### isError() > `static` **isError**(`value`): `value is Error` -Defined in: node\_modules/bun-types/globals.d.ts:980 +Defined in: node_modules/bun-types/globals.d.ts:980 Check if a value is an instance of Error @@ -244,13 +244,13 @@ True if the value is an instance of Error, false otherwise `Error.isError` -*** +--- ### prepareStackTrace() > `static` **prepareStackTrace**(`err`, `stackTraces`): `any` -Defined in: node\_modules/@types/node/globals.d.ts:149 +Defined in: node_modules/@types/node/globals.d.ts:149 #### Parameters diff --git a/docs-src/pages/api/classes/InvalidSignalError.md b/docs-src/pages/api/classes/InvalidSignalError.md index a626ebfc..19b4b559 100644 --- a/docs-src/pages/api/classes/InvalidSignalError.md +++ b/docs-src/pages/api/classes/InvalidSignalError.md @@ -1,12 +1,12 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / InvalidSignalError +[@zeix/le-truc](../globals.md) / InvalidSignalError # Class: InvalidSignalError -Defined in: [src/core/errors.ts:82](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L82) +Defined in: [src/core/errors.ts:82](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L82) Error thrown when setSignal on component is called with a non-signal value @@ -24,7 +24,7 @@ Error thrown when setSignal on component is called with a non-signal value > **new InvalidSignalError**(`host`, `prop`): `InvalidSignalError` -Defined in: [src/core/errors.ts:83](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L83) +Defined in: [src/core/errors.ts:83](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L83) #### Parameters @@ -50,7 +50,7 @@ Defined in: [src/core/errors.ts:83](https://github.com/zeixcom/ui-element/blob/a > `optional` **cause**: `unknown` -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 +Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26 The cause of the error. @@ -58,49 +58,49 @@ The cause of the error. `Error.cause` -*** +--- ### message > **message**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077 #### Inherited from `Error.message` -*** +--- ### name > **name**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 #### Inherited from `Error.name` -*** +--- ### stack? > `optional` **stack**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078 #### Inherited from `Error.stack` -*** +--- ### stackTraceLimit > `static` **stackTraceLimit**: `number` -Defined in: node\_modules/bun-types/globals.d.ts:990 +Defined in: node_modules/bun-types/globals.d.ts:990 The maximum number of stack frames to capture. @@ -116,7 +116,7 @@ The maximum number of stack frames to capture. > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` -Defined in: node\_modules/bun-types/globals.d.ts:985 +Defined in: node_modules/bun-types/globals.d.ts:985 Create .stack property on a target object @@ -142,16 +142,16 @@ Create .stack property on a target object > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` -Defined in: node\_modules/@types/node/globals.d.ts:145 +Defined in: node_modules/@types/node/globals.d.ts:145 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js -const myObject = {}; -Error.captureStackTrace(myObject); -myObject.stack; // Similar to `new Error().stack` +const myObject = {} +Error.captureStackTrace(myObject) +myObject.stack // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with @@ -166,26 +166,26 @@ details of error generation from the user. For instance: ```js function a() { - b(); + b() } function b() { - c(); + c() } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. - const { stackTraceLimit } = Error; - Error.stackTraceLimit = 0; - const error = new Error(); - Error.stackTraceLimit = stackTraceLimit; + const { stackTraceLimit } = Error + Error.stackTraceLimit = 0 + const error = new Error() + Error.stackTraceLimit = stackTraceLimit // Capture the stack trace above function b - Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace - throw error; + Error.captureStackTrace(error, b) // Neither function c, nor b is included in the stack trace + throw error } -a(); +a() ``` ##### Parameters @@ -206,13 +206,13 @@ a(); `Error.captureStackTrace` -*** +--- ### isError() > `static` **isError**(`value`): `value is Error` -Defined in: node\_modules/bun-types/globals.d.ts:980 +Defined in: node_modules/bun-types/globals.d.ts:980 Check if a value is an instance of Error @@ -234,13 +234,13 @@ True if the value is an instance of Error, false otherwise `Error.isError` -*** +--- ### prepareStackTrace() > `static` **prepareStackTrace**(`err`, `stackTraces`): `any` -Defined in: node\_modules/@types/node/globals.d.ts:149 +Defined in: node_modules/@types/node/globals.d.ts:149 #### Parameters diff --git a/docs-src/pages/api/classes/MissingElementError.md b/docs-src/pages/api/classes/MissingElementError.md index 822023f0..17b15d70 100644 --- a/docs-src/pages/api/classes/MissingElementError.md +++ b/docs-src/pages/api/classes/MissingElementError.md @@ -1,12 +1,12 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / MissingElementError +[@zeix/le-truc](../globals.md) / MissingElementError # Class: MissingElementError -Defined in: [src/core/errors.ts:96](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L96) +Defined in: [src/core/errors.ts:96](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L96) Error thrown when a required desacendent element does not exist in a component's DOM subtree @@ -24,7 +24,7 @@ Error thrown when a required desacendent element does not exist in a component's > **new MissingElementError**(`host`, `selector`, `required`): `MissingElementError` -Defined in: [src/core/errors.ts:102](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L102) +Defined in: [src/core/errors.ts:102](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/errors.ts#L102) #### Parameters @@ -60,7 +60,7 @@ Explanation why the element is required > `optional` **cause**: `unknown` -Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 +Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26 The cause of the error. @@ -68,49 +68,49 @@ The cause of the error. `Error.cause` -*** +--- ### message > **message**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077 #### Inherited from `Error.message` -*** +--- ### name > **name**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 #### Inherited from `Error.name` -*** +--- ### stack? > `optional` **stack**: `string` -Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 +Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078 #### Inherited from `Error.stack` -*** +--- ### stackTraceLimit > `static` **stackTraceLimit**: `number` -Defined in: node\_modules/bun-types/globals.d.ts:990 +Defined in: node_modules/bun-types/globals.d.ts:990 The maximum number of stack frames to capture. @@ -126,7 +126,7 @@ The maximum number of stack frames to capture. > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` -Defined in: node\_modules/bun-types/globals.d.ts:985 +Defined in: node_modules/bun-types/globals.d.ts:985 Create .stack property on a target object @@ -152,16 +152,16 @@ Create .stack property on a target object > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` -Defined in: node\_modules/@types/node/globals.d.ts:145 +Defined in: node_modules/@types/node/globals.d.ts:145 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js -const myObject = {}; -Error.captureStackTrace(myObject); -myObject.stack; // Similar to `new Error().stack` +const myObject = {} +Error.captureStackTrace(myObject) +myObject.stack // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with @@ -176,26 +176,26 @@ details of error generation from the user. For instance: ```js function a() { - b(); + b() } function b() { - c(); + c() } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. - const { stackTraceLimit } = Error; - Error.stackTraceLimit = 0; - const error = new Error(); - Error.stackTraceLimit = stackTraceLimit; + const { stackTraceLimit } = Error + Error.stackTraceLimit = 0 + const error = new Error() + Error.stackTraceLimit = stackTraceLimit // Capture the stack trace above function b - Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace - throw error; + Error.captureStackTrace(error, b) // Neither function c, nor b is included in the stack trace + throw error } -a(); +a() ``` ##### Parameters @@ -216,13 +216,13 @@ a(); `Error.captureStackTrace` -*** +--- ### isError() > `static` **isError**(`value`): `value is Error` -Defined in: node\_modules/bun-types/globals.d.ts:980 +Defined in: node_modules/bun-types/globals.d.ts:980 Check if a value is an instance of Error @@ -244,13 +244,13 @@ True if the value is an instance of Error, false otherwise `Error.isError` -*** +--- ### prepareStackTrace() > `static` **prepareStackTrace**(`err`, `stackTraces`): `any` -Defined in: node\_modules/@types/node/globals.d.ts:149 +Defined in: node_modules/@types/node/globals.d.ts:149 #### Parameters diff --git a/docs-src/pages/api/functions/asBoolean.md b/docs-src/pages/api/functions/asBoolean.md index f49ff92c..4c9b2c6e 100644 --- a/docs-src/pages/api/functions/asBoolean.md +++ b/docs-src/pages/api/functions/asBoolean.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / asBoolean +[@zeix/le-truc](../globals.md) / asBoolean # Function: asBoolean() > **asBoolean**(): [`Parser`](../type-aliases/Parser.md)\<`boolean`\> -Defined in: [src/lib/parsers.ts:23](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/parsers.ts#L23) +Defined in: [src/lib/parsers.ts:23](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/parsers.ts#L23) Parse a boolean attribute as an actual boolean value diff --git a/docs-src/pages/api/functions/asEnum.md b/docs-src/pages/api/functions/asEnum.md index 90536ebe..04671c93 100644 --- a/docs-src/pages/api/functions/asEnum.md +++ b/docs-src/pages/api/functions/asEnum.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / asEnum +[@zeix/le-truc](../globals.md) / asEnum # Function: asEnum() > **asEnum**(`valid`): [`Parser`](../type-aliases/Parser.md)\<`string`\> -Defined in: [src/lib/parsers.ts:93](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/parsers.ts#L93) +Defined in: [src/lib/parsers.ts:93](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/parsers.ts#L93) Parse a string as a multi-state value (for examnple: true, false, mixed), defaulting to the first valid option diff --git a/docs-src/pages/api/functions/asInteger.md b/docs-src/pages/api/functions/asInteger.md index 4e01ccdb..b9d360e8 100644 --- a/docs-src/pages/api/functions/asInteger.md +++ b/docs-src/pages/api/functions/asInteger.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / asInteger +[@zeix/le-truc](../globals.md) / asInteger # Function: asInteger() > **asInteger**\<`E`\>(`fallback?`): [`Parser`](../type-aliases/Parser.md)\<`number`, `E`\> -Defined in: [src/lib/parsers.ts:36](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/parsers.ts#L36) +Defined in: [src/lib/parsers.ts:36](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/parsers.ts#L36) Parse a string as a number forced to integer with a fallback @@ -18,7 +18,7 @@ Supports hexadecimal and scientific notation ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/asJSON.md b/docs-src/pages/api/functions/asJSON.md index 42a7ebe6..39aa119f 100644 --- a/docs-src/pages/api/functions/asJSON.md +++ b/docs-src/pages/api/functions/asJSON.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / asJSON +[@zeix/le-truc](../globals.md) / asJSON # Function: asJSON() > **asJSON**\<`T`, `E`\>(`fallback`): [`Parser`](../type-aliases/Parser.md)\<`T`, `E`\> -Defined in: [src/lib/parsers.ts:111](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/parsers.ts#L111) +Defined in: [src/lib/parsers.ts:111](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/parsers.ts#L111) Parse a string as a JSON serialized object with a fallback @@ -16,11 +16,11 @@ Parse a string as a JSON serialized object with a fallback ### T -`T` *extends* `object` +`T` _extends_ `object` ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/asNumber.md b/docs-src/pages/api/functions/asNumber.md index 1f9089e7..8d1ce922 100644 --- a/docs-src/pages/api/functions/asNumber.md +++ b/docs-src/pages/api/functions/asNumber.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / asNumber +[@zeix/le-truc](../globals.md) / asNumber # Function: asNumber() > **asNumber**\<`E`\>(`fallback?`): [`Parser`](../type-aliases/Parser.md)\<`number`, `E`\> -Defined in: [src/lib/parsers.ts:65](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/parsers.ts#L65) +Defined in: [src/lib/parsers.ts:65](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/parsers.ts#L65) Parse a string as a number with a fallback @@ -16,7 +16,7 @@ Parse a string as a number with a fallback ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/asString.md b/docs-src/pages/api/functions/asString.md index 9da4a685..bfb01572 100644 --- a/docs-src/pages/api/functions/asString.md +++ b/docs-src/pages/api/functions/asString.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / asString +[@zeix/le-truc](../globals.md) / asString # Function: asString() > **asString**\<`E`\>(`fallback?`): [`Parser`](../type-aliases/Parser.md)\<`string`, `E`\> -Defined in: [src/lib/parsers.ts:79](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/parsers.ts#L79) +Defined in: [src/lib/parsers.ts:79](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/parsers.ts#L79) Parse a string as a string with a fallback @@ -16,7 +16,7 @@ Parse a string as a string with a fallback ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/batch.md b/docs-src/pages/api/functions/batch.md index 1bd2b76f..b3f1d1cc 100644 --- a/docs-src/pages/api/functions/batch.md +++ b/docs-src/pages/api/functions/batch.md @@ -1,8 +1,8 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) *** -[@zeix/ui-element](../globals.md) / batch +[@zeix/le-truc](../globals.md) / batch # Function: batch() diff --git a/docs-src/pages/api/functions/component.md b/docs-src/pages/api/functions/component.md index 2a9952b0..456ffbad 100644 --- a/docs-src/pages/api/functions/component.md +++ b/docs-src/pages/api/functions/component.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / component +[@zeix/le-truc](../globals.md) / component # Function: component() > **component**\<`P`\>(`name`, `init`, `setup`): `void` -Defined in: [src/component.ts:157](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/component.ts#L157) +Defined in: [src/component.ts:157](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/component.ts#L157) Define a component with dependency resolution and setup function (connectedCallback) @@ -16,7 +16,7 @@ Define a component with dependency resolution and setup function (connectedCallb ### P -`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) & [`ValidateComponentProps`](../type-aliases/ValidateComponentProps.md)\<`P`\> +`P` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) & [`ValidateComponentProps`](../type-aliases/ValidateComponentProps.md)\<`P`\> ## Parameters diff --git a/docs-src/pages/api/functions/computed.md b/docs-src/pages/api/functions/computed.md index 4b10d5dd..d5d9efe2 100644 --- a/docs-src/pages/api/functions/computed.md +++ b/docs-src/pages/api/functions/computed.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / computed +[@zeix/le-truc](../globals.md) / computed # Function: computed() > **computed**\<`T`\>(`fn`): [`Computed`](../type-aliases/Computed.md)\<`T`\> -Defined in: node\_modules/@zeix/cause-effect/src/computed.ts:40 +Defined in: node_modules/@zeix/cause-effect/src/computed.ts:40 Create a derived signal from existing signals @@ -16,7 +16,7 @@ Create a derived signal from existing signals ### T -`T` *extends* `object` +`T` _extends_ `object` ## Parameters diff --git a/docs-src/pages/api/functions/dangerouslySetInnerHTML.md b/docs-src/pages/api/functions/dangerouslySetInnerHTML.md index 298b1b66..81c17eac 100644 --- a/docs-src/pages/api/functions/dangerouslySetInnerHTML.md +++ b/docs-src/pages/api/functions/dangerouslySetInnerHTML.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / dangerouslySetInnerHTML +[@zeix/le-truc](../globals.md) / dangerouslySetInnerHTML # Function: dangerouslySetInnerHTML() > **dangerouslySetInnerHTML**\<`P`, `E`\>(`reactive`, `options`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\> -Defined in: [src/lib/effects.ts:495](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L495) +Defined in: [src/lib/effects.ts:495](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L495) Effect for setting the inner HTML of an element with optional Shadow DOM support. Provides security options for script execution and shadow root creation. @@ -17,11 +17,11 @@ Provides security options for script execution and shadow root creation. ### P -`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) +`P` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/effect.md b/docs-src/pages/api/functions/effect.md index dead6504..6a9e46e9 100644 --- a/docs-src/pages/api/functions/effect.md +++ b/docs-src/pages/api/functions/effect.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / effect +[@zeix/le-truc](../globals.md) / effect # Function: effect() > **effect**\<`S`\>(`matcher`): [`Cleanup`](../type-aliases/Cleanup.md) -Defined in: node\_modules/@zeix/cause-effect/src/effect.ts:23 +Defined in: node_modules/@zeix/cause-effect/src/effect.ts:23 Define what happens when a reactive state changes @@ -16,7 +16,7 @@ Define what happens when a reactive state changes ### S -`S` *extends* [`Signal`](../type-aliases/Signal.md)\<\{ \}\>[] +`S` _extends_ [`Signal`](../type-aliases/Signal.md)\<\{ \}\>[] ## Parameters diff --git a/docs-src/pages/api/functions/emitEvent.md b/docs-src/pages/api/functions/emitEvent.md index f5ba8250..838270c9 100644 --- a/docs-src/pages/api/functions/emitEvent.md +++ b/docs-src/pages/api/functions/emitEvent.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / emitEvent +[@zeix/le-truc](../globals.md) / emitEvent # Function: emitEvent() > **emitEvent**\<`T`, `P`, `E`\>(`type`, `reactive`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\> -Defined in: [src/core/events.ts:196](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/events.ts#L196) +Defined in: [src/core/events.ts:196](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/events.ts#L196) Effect for emitting custom events with reactive detail values. Creates and dispatches CustomEvent instances with bubbling enabled by default. @@ -21,11 +21,11 @@ Creates and dispatches CustomEvent instances with bubbling enabled by default. ### P -`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) +`P` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/enqueue.md b/docs-src/pages/api/functions/enqueue.md index 6c63c02e..99dd35b5 100644 --- a/docs-src/pages/api/functions/enqueue.md +++ b/docs-src/pages/api/functions/enqueue.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / enqueue +[@zeix/le-truc](../globals.md) / enqueue # Function: enqueue() > **enqueue**\<`T`\>(`fn`, `dedupe?`): `Promise`\<`undefined` \| `boolean` \| `T`\> -Defined in: node\_modules/@zeix/cause-effect/src/scheduler.ts:147 +Defined in: node_modules/@zeix/cause-effect/src/scheduler.ts:147 Enqueue a function to be executed on the next animation frame diff --git a/docs-src/pages/api/functions/fromContext.md b/docs-src/pages/api/functions/fromContext.md index 054804f8..59ff32a3 100644 --- a/docs-src/pages/api/functions/fromContext.md +++ b/docs-src/pages/api/functions/fromContext.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) *** -[@zeix/ui-element](../globals.md) / fromContext +[@zeix/le-truc](../globals.md) / fromContext # Function: fromContext() > **fromContext**\<`T`, `C`\>(`context`, `fallback`): [`Extractor`](../type-aliases/Extractor.md)\<[`Signal`](../type-aliases/Signal.md)\<`T`\>, `C`\> -Defined in: [src/core/context.ts:125](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/context.ts#L125) +Defined in: [src/core/context.ts:125](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/context.ts#L125) Consume a context value for a component. diff --git a/docs-src/pages/api/functions/fromDOM.md b/docs-src/pages/api/functions/fromDOM.md index 76bd320f..017a32b0 100644 --- a/docs-src/pages/api/functions/fromDOM.md +++ b/docs-src/pages/api/functions/fromDOM.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / fromDOM +[@zeix/le-truc](../globals.md) / fromDOM # Function: fromDOM() > **fromDOM**\<`T`, `C`, `S`\>(`extractors`, `fallback`): [`Extractor`](../type-aliases/Extractor.md)\<`T`, `C`\> -Defined in: [src/core/dom.ts:186](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L186) +Defined in: [src/core/dom.ts:186](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L186) Get a value from elements in the DOM @@ -16,15 +16,15 @@ Get a value from elements in the DOM ### T -`T` *extends* `object` +`T` _extends_ `object` ### C -`C` *extends* `HTMLElement` = `HTMLElement` +`C` _extends_ `HTMLElement` = `HTMLElement` ### S -`S` *extends* \{ \[K in string\]: LooseExtractor\\> \} = \{ \} +`S` _extends_ \{ \[K in string\]: LooseExtractor\\> \} = \{ \} ## Parameters diff --git a/docs-src/pages/api/functions/fromEvents.md b/docs-src/pages/api/functions/fromEvents.md index df5c4c2f..d6aeb8bc 100644 --- a/docs-src/pages/api/functions/fromEvents.md +++ b/docs-src/pages/api/functions/fromEvents.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / fromEvents +[@zeix/le-truc](../globals.md) / fromEvents # Function: fromEvents() > **fromEvents**\<`T`, `C`, `S`\>(`selector`, `events`, `initialize`): [`Extractor`](../type-aliases/Extractor.md)\<[`Computed`](../type-aliases/Computed.md)\<`T`\>, `C`\> -Defined in: [src/core/events.ts:66](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/events.ts#L66) +Defined in: [src/core/events.ts:66](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/events.ts#L66) Produce a computed signal from transformed event data @@ -16,15 +16,15 @@ Produce a computed signal from transformed event data ### T -`T` *extends* `object` +`T` _extends_ `object` ### C -`C` *extends* `HTMLElement` = `HTMLElement` +`C` _extends_ `HTMLElement` = `HTMLElement` ### S -`S` *extends* `string` = `string` +`S` _extends_ `string` = `string` ## Parameters diff --git a/docs-src/pages/api/functions/fromSelector.md b/docs-src/pages/api/functions/fromSelector.md index 7c310180..408beb94 100644 --- a/docs-src/pages/api/functions/fromSelector.md +++ b/docs-src/pages/api/functions/fromSelector.md @@ -1,8 +1,8 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / fromSelector +[@zeix/le-truc](../globals.md) / fromSelector # Function: fromSelector() @@ -10,7 +10,7 @@ > **fromSelector**\<`S`, `C`\>(`selector`): [`Extractor`](../type-aliases/Extractor.md)\<[`Computed`](../type-aliases/Computed.md)\<[`ElementFromSelector`](../type-aliases/ElementFromSelector.md)\<`S`\>[]\>, `C`\> -Defined in: [src/core/dom.ts:442](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L442) +Defined in: [src/core/dom.ts:442](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L442) Produce a computed signal of an array of elements matching a selector @@ -18,11 +18,11 @@ Produce a computed signal of an array of elements matching a selector #### S -`S` *extends* `string` +`S` _extends_ `string` #### C -`C` *extends* `HTMLElement` = `HTMLElement` +`C` _extends_ `HTMLElement` = `HTMLElement` ### Parameters @@ -50,7 +50,7 @@ If observed mutations would trigger infinite mutation cycles > **fromSelector**\<`E`, `C`\>(`selector`): [`Extractor`](../type-aliases/Extractor.md)\<[`Computed`](../type-aliases/Computed.md)\<`E`[]\>, `C`\> -Defined in: [src/core/dom.ts:445](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L445) +Defined in: [src/core/dom.ts:445](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L445) Produce a computed signal of an array of elements matching a selector @@ -58,11 +58,11 @@ Produce a computed signal of an array of elements matching a selector #### E -`E` *extends* `Element` +`E` _extends_ `Element` #### C -`C` *extends* `HTMLElement` = `HTMLElement` +`C` _extends_ `HTMLElement` = `HTMLElement` ### Parameters diff --git a/docs-src/pages/api/functions/getAttribute.md b/docs-src/pages/api/functions/getAttribute.md index fd9f439d..6818a7e1 100644 --- a/docs-src/pages/api/functions/getAttribute.md +++ b/docs-src/pages/api/functions/getAttribute.md @@ -1,20 +1,20 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / getAttribute +[@zeix/le-truc](../globals.md) / getAttribute # Function: getAttribute() > **getAttribute**\<`E`\>(`attr`): [`LooseExtractor`](../type-aliases/LooseExtractor.md)\<`string`, `E`\> -Defined in: [src/lib/extractors.ts:28](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/extractors.ts#L28) +Defined in: [src/lib/extractors.ts:28](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/extractors.ts#L28) ## Type Parameters ### E -`E` *extends* `Element` = `Element` +`E` _extends_ `Element` = `Element` ## Parameters diff --git a/docs-src/pages/api/functions/getDescription.md b/docs-src/pages/api/functions/getDescription.md index 93d8ef72..255d18e8 100644 --- a/docs-src/pages/api/functions/getDescription.md +++ b/docs-src/pages/api/functions/getDescription.md @@ -1,20 +1,20 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / getDescription +[@zeix/le-truc](../globals.md) / getDescription # Function: getDescription() > **getDescription**\<`E`\>(`selector`): [`Extractor`](../type-aliases/Extractor.md)\<`string`, `E`\> -Defined in: [src/lib/extractors.ts:49](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/extractors.ts#L49) +Defined in: [src/lib/extractors.ts:49](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/extractors.ts#L49) ## Type Parameters ### E -`E` *extends* `HTMLElement` +`E` _extends_ `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/getFallback.md b/docs-src/pages/api/functions/getFallback.md index fe0d5d9c..069aa660 100644 --- a/docs-src/pages/api/functions/getFallback.md +++ b/docs-src/pages/api/functions/getFallback.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / getFallback +[@zeix/le-truc](../globals.md) / getFallback # Function: getFallback() > **getFallback**\<`T`, `E`\>(`element`, `fallback`): `T` -Defined in: [src/core/dom.ts:172](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L172) +Defined in: [src/core/dom.ts:172](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L172) Get a fallback value for an element @@ -16,11 +16,11 @@ Get a fallback value for an element ### T -`T` *extends* `object` +`T` _extends_ `object` ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/getLabel.md b/docs-src/pages/api/functions/getLabel.md index 398775fa..801c5ca1 100644 --- a/docs-src/pages/api/functions/getLabel.md +++ b/docs-src/pages/api/functions/getLabel.md @@ -1,20 +1,20 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / getLabel +[@zeix/le-truc](../globals.md) / getLabel # Function: getLabel() > **getLabel**\<`E`\>(`selector`): [`Extractor`](../type-aliases/Extractor.md)\<`string`, `E`\> -Defined in: [src/lib/extractors.ts:44](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/extractors.ts#L44) +Defined in: [src/lib/extractors.ts:44](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/extractors.ts#L44) ## Type Parameters ### E -`E` *extends* `HTMLElement` +`E` _extends_ `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/getProperty.md b/docs-src/pages/api/functions/getProperty.md index 39a8ac24..1058f96a 100644 --- a/docs-src/pages/api/functions/getProperty.md +++ b/docs-src/pages/api/functions/getProperty.md @@ -1,24 +1,24 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / getProperty +[@zeix/le-truc](../globals.md) / getProperty # Function: getProperty() > **getProperty**\<`E`, `K`\>(`prop`): [`LooseExtractor`](../type-aliases/LooseExtractor.md)\<`E`\[`K`\], `E`\> -Defined in: [src/lib/extractors.ts:16](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/extractors.ts#L16) +Defined in: [src/lib/extractors.ts:16](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/extractors.ts#L16) ## Type Parameters ### E -`E` *extends* `Element` +`E` _extends_ `Element` ### K -`K` *extends* `string` +`K` _extends_ `string` ## Parameters diff --git a/docs-src/pages/api/functions/getStyle.md b/docs-src/pages/api/functions/getStyle.md index deed54a6..48097fea 100644 --- a/docs-src/pages/api/functions/getStyle.md +++ b/docs-src/pages/api/functions/getStyle.md @@ -1,20 +1,20 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / getStyle +[@zeix/le-truc](../globals.md) / getStyle # Function: getStyle() > **getStyle**\<`E`\>(`prop`): [`Extractor`](../type-aliases/Extractor.md)\<`string`, `E`\> -Defined in: [src/lib/extractors.ts:38](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/extractors.ts#L38) +Defined in: [src/lib/extractors.ts:38](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/extractors.ts#L38) ## Type Parameters ### E -`E` *extends* `HTMLElement` \| `SVGElement` \| `MathMLElement` = `HTMLElement` +`E` _extends_ `HTMLElement` \| `SVGElement` \| `MathMLElement` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/getText.md b/docs-src/pages/api/functions/getText.md index adc6c5fb..0961bae0 100644 --- a/docs-src/pages/api/functions/getText.md +++ b/docs-src/pages/api/functions/getText.md @@ -1,20 +1,20 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / getText +[@zeix/le-truc](../globals.md) / getText # Function: getText() > **getText**\<`E`\>(): [`LooseExtractor`](../type-aliases/LooseExtractor.md)\<`string`, `E`\> -Defined in: [src/lib/extractors.ts:4](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/extractors.ts#L4) +Defined in: [src/lib/extractors.ts:4](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/extractors.ts#L4) ## Type Parameters ### E -`E` *extends* `Element` = `Element` +`E` _extends_ `Element` = `Element` ## Returns diff --git a/docs-src/pages/api/functions/hasAttribute.md b/docs-src/pages/api/functions/hasAttribute.md index fb1b1b41..145f9927 100644 --- a/docs-src/pages/api/functions/hasAttribute.md +++ b/docs-src/pages/api/functions/hasAttribute.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / hasAttribute +[@zeix/le-truc](../globals.md) / hasAttribute # Function: hasAttribute() > **hasAttribute**(`attr`): [`Extractor`](../type-aliases/Extractor.md)\<`boolean`, `Element`\> -Defined in: [src/lib/extractors.ts:23](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/extractors.ts#L23) +Defined in: [src/lib/extractors.ts:23](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/extractors.ts#L23) ## Parameters diff --git a/docs-src/pages/api/functions/hasClass.md b/docs-src/pages/api/functions/hasClass.md index 57e96ec9..12b92ea9 100644 --- a/docs-src/pages/api/functions/hasClass.md +++ b/docs-src/pages/api/functions/hasClass.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / hasClass +[@zeix/le-truc](../globals.md) / hasClass # Function: hasClass() > **hasClass**(`token`): [`Extractor`](../type-aliases/Extractor.md)\<`boolean`, `Element`\> -Defined in: [src/lib/extractors.ts:33](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/extractors.ts#L33) +Defined in: [src/lib/extractors.ts:33](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/extractors.ts#L33) ## Parameters diff --git a/docs-src/pages/api/functions/insertOrRemoveElement.md b/docs-src/pages/api/functions/insertOrRemoveElement.md index a122a3b6..b83dd3af 100644 --- a/docs-src/pages/api/functions/insertOrRemoveElement.md +++ b/docs-src/pages/api/functions/insertOrRemoveElement.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / insertOrRemoveElement +[@zeix/le-truc](../globals.md) / insertOrRemoveElement # Function: insertOrRemoveElement() > **insertOrRemoveElement**\<`P`, `E`\>(`reactive`, `inserter?`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\> -Defined in: [src/lib/effects.ts:184](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L184) +Defined in: [src/lib/effects.ts:184](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L184) Effect for dynamically inserting or removing elements based on a reactive numeric value. Positive values insert elements, negative values remove them. @@ -17,11 +17,11 @@ Positive values insert elements, negative values remove them. ### P -`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) +`P` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/isComputed.md b/docs-src/pages/api/functions/isComputed.md index 6fd06bb1..7160b94a 100644 --- a/docs-src/pages/api/functions/isComputed.md +++ b/docs-src/pages/api/functions/isComputed.md @@ -1,8 +1,8 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) *** -[@zeix/ui-element](../globals.md) / isComputed +[@zeix/le-truc](../globals.md) / isComputed # Function: isComputed() diff --git a/docs-src/pages/api/functions/isParser.md b/docs-src/pages/api/functions/isParser.md index b420362e..27c72e00 100644 --- a/docs-src/pages/api/functions/isParser.md +++ b/docs-src/pages/api/functions/isParser.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / isParser +[@zeix/le-truc](../globals.md) / isParser # Function: isParser() > **isParser**\<`T`, `E`\>(`value`): `value is Parser` -Defined in: [src/core/dom.ts:160](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L160) +Defined in: [src/core/dom.ts:160](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L160) Check if a value is a string parser @@ -16,11 +16,11 @@ Check if a value is a string parser ### T -`T` *extends* `object` +`T` _extends_ `object` ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/isSignal.md b/docs-src/pages/api/functions/isSignal.md index 238e1fe7..202a39c3 100644 --- a/docs-src/pages/api/functions/isSignal.md +++ b/docs-src/pages/api/functions/isSignal.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / isSignal +[@zeix/le-truc](../globals.md) / isSignal # Function: isSignal() > **isSignal**\<`T`\>(`value`): `value is Signal` -Defined in: node\_modules/@zeix/cause-effect/src/signal.ts:34 +Defined in: node_modules/@zeix/cause-effect/src/signal.ts:34 Check whether a value is a Signal or not @@ -16,7 +16,7 @@ Check whether a value is a Signal or not ### T -`T` *extends* `object` +`T` _extends_ `object` ## Parameters diff --git a/docs-src/pages/api/functions/isState.md b/docs-src/pages/api/functions/isState.md index 5e1f868b..0618c1ee 100644 --- a/docs-src/pages/api/functions/isState.md +++ b/docs-src/pages/api/functions/isState.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / isState +[@zeix/le-truc](../globals.md) / isState # Function: isState() > **isState**\<`T`\>(`value`): `value is State` -Defined in: node\_modules/@zeix/cause-effect/src/state.ts:83 +Defined in: node_modules/@zeix/cause-effect/src/state.ts:83 Check if the provided value is a State instance @@ -16,7 +16,7 @@ Check if the provided value is a State instance ### T -`T` *extends* `object` +`T` _extends_ `object` ## Parameters diff --git a/docs-src/pages/api/functions/log.md b/docs-src/pages/api/functions/log.md index de2d05d6..cd3d3689 100644 --- a/docs-src/pages/api/functions/log.md +++ b/docs-src/pages/api/functions/log.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / log +[@zeix/le-truc](../globals.md) / log # Function: log() > **log**\<`T`\>(`value`, `msg`, `level`): `T` -Defined in: [src/core/util.ts:141](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/util.ts#L141) +Defined in: [src/core/util.ts:141](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/util.ts#L141) Log a message to the console with the specified level diff --git a/docs-src/pages/api/functions/on.md b/docs-src/pages/api/functions/on.md index a1741fa7..70eea3e3 100644 --- a/docs-src/pages/api/functions/on.md +++ b/docs-src/pages/api/functions/on.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / on +[@zeix/le-truc](../globals.md) / on # Function: on() > **on**\<`K`, `P`, `E`\>(`type`, `handler`, `options`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\> -Defined in: [src/core/events.ts:147](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/events.ts#L147) +Defined in: [src/core/events.ts:147](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/events.ts#L147) Effect for attaching an event listener to an element. Provides proper cleanup when the effect is disposed. @@ -17,15 +17,15 @@ Provides proper cleanup when the effect is disposed. ### K -`K` *extends* `string` +`K` _extends_ `string` ### P -`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) +`P` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/pass.md b/docs-src/pages/api/functions/pass.md index 66aabdaf..f07df08f 100644 --- a/docs-src/pages/api/functions/pass.md +++ b/docs-src/pages/api/functions/pass.md @@ -1,26 +1,26 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / pass +[@zeix/le-truc](../globals.md) / pass # Function: pass() > **pass**\<`P`, `Q`\>(`reactives`): [`Effect`](../type-aliases/Effect.md)\<`P`, [`Component`](../type-aliases/Component.md)\<`Q`\>\> -Defined in: [src/lib/effects.ts:540](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L540) +Defined in: [src/lib/effects.ts:540](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L540) -Effect for passing reactive values to a descendant UIElement component. +Effect for passing reactive values to a descendant Le Truc component. ## Type Parameters ### P -`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) +`P` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) ### Q -`Q` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) +`Q` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) ## Parameters @@ -42,7 +42,7 @@ Effect function that passes reactive values to the descendant component ## Throws -When the provided reactives are not an object or the target is not a UIElement component +When the provided reactives are not an object or the target is not a Le Truc component ## Throws diff --git a/docs-src/pages/api/functions/provideContexts.md b/docs-src/pages/api/functions/provideContexts.md index ffb96808..9fe906f2 100644 --- a/docs-src/pages/api/functions/provideContexts.md +++ b/docs-src/pages/api/functions/provideContexts.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / provideContexts +[@zeix/le-truc](../globals.md) / provideContexts # Function: provideContexts() > **provideContexts**\<`P`, `K`\>(`contexts`): (`host`) => [`Cleanup`](../type-aliases/Cleanup.md) -Defined in: [src/core/context.ts:98](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/context.ts#L98) +Defined in: [src/core/context.ts:98](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/context.ts#L98) Provide a context for descendant component consumers @@ -16,11 +16,11 @@ Provide a context for descendant component consumers ### P -`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) +`P` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) ### K -`K` *extends* `string` \| `number` \| `symbol` +`K` _extends_ `string` \| `number` \| `symbol` ## Parameters diff --git a/docs-src/pages/api/functions/resolveReactive.md b/docs-src/pages/api/functions/resolveReactive.md index 0d90ceb1..ec1b6274 100644 --- a/docs-src/pages/api/functions/resolveReactive.md +++ b/docs-src/pages/api/functions/resolveReactive.md @@ -1,28 +1,28 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / resolveReactive +[@zeix/le-truc](../globals.md) / resolveReactive # Function: resolveReactive() > **resolveReactive**\<`T`, `P`, `E`\>(`reactive`, `host`, `target`, `context?`): `T` -Defined in: [src/core/reactive.ts:75](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/reactive.ts#L75) +Defined in: [src/core/reactive.ts:75](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/reactive.ts#L75) ## Type Parameters ### T -`T` *extends* `object` +`T` _extends_ `object` ### P -`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) +`P` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) ### E -`E` *extends* `Element` = [`Component`](../type-aliases/Component.md)\<`P`\> +`E` _extends_ `Element` = [`Component`](../type-aliases/Component.md)\<`P`\> ## Parameters diff --git a/docs-src/pages/api/functions/setAttribute.md b/docs-src/pages/api/functions/setAttribute.md index 1d639033..f22808e7 100644 --- a/docs-src/pages/api/functions/setAttribute.md +++ b/docs-src/pages/api/functions/setAttribute.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / setAttribute +[@zeix/le-truc](../globals.md) / setAttribute # Function: setAttribute() > **setAttribute**\<`P`, `E`\>(`name`, `reactive`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\> -Defined in: [src/lib/effects.ts:392](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L392) +Defined in: [src/lib/effects.ts:392](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L392) Effect for setting an attribute on an element. Sets the specified attribute with security validation for unsafe values. @@ -17,11 +17,11 @@ Sets the specified attribute with security validation for unsafe values. ### P -`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) +`P` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/setProperty.md b/docs-src/pages/api/functions/setProperty.md index 48bc0e71..316f48f4 100644 --- a/docs-src/pages/api/functions/setProperty.md +++ b/docs-src/pages/api/functions/setProperty.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / setProperty +[@zeix/le-truc](../globals.md) / setProperty # Function: setProperty() > **setProperty**\<`P`, `K`, `E`\>(`key`, `reactive`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\> -Defined in: [src/lib/effects.ts:296](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L296) +Defined in: [src/lib/effects.ts:296](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L296) Effect for setting a property on an element. Sets the specified property directly on the element object. @@ -17,15 +17,15 @@ Sets the specified property directly on the element object. ### P -`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) +`P` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) ### K -`K` *extends* `string` +`K` _extends_ `string` ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/setStyle.md b/docs-src/pages/api/functions/setStyle.md index 41a8afe8..956bf44d 100644 --- a/docs-src/pages/api/functions/setStyle.md +++ b/docs-src/pages/api/functions/setStyle.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / setStyle +[@zeix/le-truc](../globals.md) / setStyle # Function: setStyle() > **setStyle**\<`P`, `E`\>(`prop`, `reactive`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\> -Defined in: [src/lib/effects.ts:467](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L467) +Defined in: [src/lib/effects.ts:467](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L467) Effect for setting a CSS style property on an element. Sets the specified style property with support for deletion via UNSET. @@ -17,11 +17,11 @@ Sets the specified style property with support for deletion via UNSET. ### P -`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) +`P` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) ### E -`E` *extends* `HTMLElement` \| `SVGElement` \| `MathMLElement` = `HTMLElement` +`E` _extends_ `HTMLElement` \| `SVGElement` \| `MathMLElement` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/setText.md b/docs-src/pages/api/functions/setText.md index 2fde1742..1adede90 100644 --- a/docs-src/pages/api/functions/setText.md +++ b/docs-src/pages/api/functions/setText.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / setText +[@zeix/le-truc](../globals.md) / setText # Function: setText() > **setText**\<`P`, `E`\>(`reactive`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\> -Defined in: [src/lib/effects.ts:273](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L273) +Defined in: [src/lib/effects.ts:273](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L273) Effect for setting the text content of an element. Replaces all child nodes (except comments) with a single text node. @@ -17,11 +17,11 @@ Replaces all child nodes (except comments) with a single text node. ### P -`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) +`P` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/show.md b/docs-src/pages/api/functions/show.md index 99df5125..02f1e5d4 100644 --- a/docs-src/pages/api/functions/show.md +++ b/docs-src/pages/api/functions/show.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / show +[@zeix/le-truc](../globals.md) / show # Function: show() > **show**\<`P`, `E`\>(`reactive`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\> -Defined in: [src/lib/effects.ts:321](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L321) +Defined in: [src/lib/effects.ts:321](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L321) Effect for controlling element visibility by setting the 'hidden' property. When the reactive value is true, the element is shown; when false, it's hidden. @@ -17,11 +17,11 @@ When the reactive value is true, the element is shown; when false, it's hidden. ### P -`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) +`P` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) ### E -`E` *extends* `HTMLElement` = `HTMLElement` +`E` _extends_ `HTMLElement` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/state.md b/docs-src/pages/api/functions/state.md index 1e756ca2..12d3adac 100644 --- a/docs-src/pages/api/functions/state.md +++ b/docs-src/pages/api/functions/state.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / state +[@zeix/le-truc](../globals.md) / state # Function: state() > **state**\<`T`\>(`initialValue`): [`State`](../type-aliases/State.md)\<`T`\> -Defined in: node\_modules/@zeix/cause-effect/src/state.ts:27 +Defined in: node_modules/@zeix/cause-effect/src/state.ts:27 Create a new state signal @@ -16,7 +16,7 @@ Create a new state signal ### T -`T` *extends* `object` +`T` _extends_ `object` ## Parameters diff --git a/docs-src/pages/api/functions/toSignal.md b/docs-src/pages/api/functions/toSignal.md index acc52a55..3fb9358e 100644 --- a/docs-src/pages/api/functions/toSignal.md +++ b/docs-src/pages/api/functions/toSignal.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / toSignal +[@zeix/le-truc](../globals.md) / toSignal # Function: toSignal() > **toSignal**\<`T`\>(`value`): [`Signal`](../type-aliases/Signal.md)\<`T`\> -Defined in: node\_modules/@zeix/cause-effect/src/signal.ts:45 +Defined in: node_modules/@zeix/cause-effect/src/signal.ts:45 Convert a value to a Signal if it's not already a Signal @@ -16,7 +16,7 @@ Convert a value to a Signal if it's not already a Signal ### T -`T` *extends* `object` +`T` _extends_ `object` ## Parameters diff --git a/docs-src/pages/api/functions/toggleAttribute.md b/docs-src/pages/api/functions/toggleAttribute.md index 73521a0d..fbdc85b1 100644 --- a/docs-src/pages/api/functions/toggleAttribute.md +++ b/docs-src/pages/api/functions/toggleAttribute.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / toggleAttribute +[@zeix/le-truc](../globals.md) / toggleAttribute # Function: toggleAttribute() > **toggleAttribute**\<`P`, `E`\>(`name`, `reactive`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\> -Defined in: [src/lib/effects.ts:420](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L420) +Defined in: [src/lib/effects.ts:420](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L420) Effect for toggling a boolean attribute on an element. When the reactive value is true, the attribute is present; when false, it's absent. @@ -17,11 +17,11 @@ When the reactive value is true, the attribute is present; when false, it's abse ### P -`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) +`P` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/toggleClass.md b/docs-src/pages/api/functions/toggleClass.md index 09a767c0..bbbf3abc 100644 --- a/docs-src/pages/api/functions/toggleClass.md +++ b/docs-src/pages/api/functions/toggleClass.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / toggleClass +[@zeix/le-truc](../globals.md) / toggleClass # Function: toggleClass() > **toggleClass**\<`P`, `E`\>(`token`, `reactive`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\> -Defined in: [src/lib/effects.ts:445](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L445) +Defined in: [src/lib/effects.ts:445](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L445) Effect for toggling a CSS class token on an element. When the reactive value is true, the class is added; when false, it's removed. @@ -17,11 +17,11 @@ When the reactive value is true, the class is added; when false, it's removed. ### P -`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) +`P` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/functions/updateElement.md b/docs-src/pages/api/functions/updateElement.md index c35e4d16..f1bf405e 100644 --- a/docs-src/pages/api/functions/updateElement.md +++ b/docs-src/pages/api/functions/updateElement.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / updateElement +[@zeix/le-truc](../globals.md) / updateElement # Function: updateElement() > **updateElement**\<`P`, `T`, `E`\>(`reactive`, `updater`): [`Effect`](../type-aliases/Effect.md)\<`P`, `E`\> -Defined in: [src/lib/effects.ts:115](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L115) +Defined in: [src/lib/effects.ts:115](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L115) Core effect function for updating element properties based on reactive values. This function handles the lifecycle of reading, updating, and deleting element properties @@ -18,15 +18,15 @@ while providing proper error handling and debugging support. ### P -`P` *extends* [`ComponentProps`](../type-aliases/ComponentProps.md) +`P` _extends_ [`ComponentProps`](../type-aliases/ComponentProps.md) ### T -`T` *extends* `object` +`T` _extends_ `object` ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/globals.md b/docs-src/pages/api/globals.md index 3392c43b..36b39bb9 100644 --- a/docs-src/pages/api/globals.md +++ b/docs-src/pages/api/globals.md @@ -1,8 +1,8 @@ -[**@zeix/ui-element**](README.md) +[**@zeix/le-truc**](README.md) -*** +--- -# @zeix/ui-element +# @zeix/le-truc ## Classes @@ -61,11 +61,11 @@ ## Variables -- [DEV\_MODE](variables/DEV_MODE.md) -- [LOG\_DEBUG](variables/LOG_DEBUG.md) -- [LOG\_ERROR](variables/LOG_ERROR.md) -- [LOG\_INFO](variables/LOG_INFO.md) -- [LOG\_WARN](variables/LOG_WARN.md) +- [DEV_MODE](variables/DEV_MODE.md) +- [LOG_DEBUG](variables/LOG_DEBUG.md) +- [LOG_ERROR](variables/LOG_ERROR.md) +- [LOG_INFO](variables/LOG_INFO.md) +- [LOG_WARN](variables/LOG_WARN.md) - [RESET](variables/RESET.md) - [UNSET](variables/UNSET.md) diff --git a/docs-src/pages/api/type-aliases/Cleanup.md b/docs-src/pages/api/type-aliases/Cleanup.md index 200529a5..485e0425 100644 --- a/docs-src/pages/api/type-aliases/Cleanup.md +++ b/docs-src/pages/api/type-aliases/Cleanup.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / Cleanup +[@zeix/le-truc](../globals.md) / Cleanup # Type Alias: Cleanup() > **Cleanup** = () => `void` -Defined in: node\_modules/@zeix/cause-effect/src/scheduler.ts:3 +Defined in: node_modules/@zeix/cause-effect/src/scheduler.ts:3 ## Returns @@ -16,7 +16,7 @@ Defined in: node\_modules/@zeix/cause-effect/src/scheduler.ts:3 ## Name -UIElement +Le Truc ## Version diff --git a/docs-src/pages/api/type-aliases/Component.md b/docs-src/pages/api/type-aliases/Component.md index 564650cc..8f8fdbe0 100644 --- a/docs-src/pages/api/type-aliases/Component.md +++ b/docs-src/pages/api/type-aliases/Component.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / Component +[@zeix/le-truc](../globals.md) / Component # Type Alias: Component\ > **Component**\<`P`\> = `HTMLElement` & `P` & `object` -Defined in: [src/component.ts:59](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/component.ts#L59) +Defined in: [src/component.ts:59](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/component.ts#L59) ## Type declaration @@ -24,7 +24,7 @@ Defined in: [src/component.ts:59](https://github.com/zeixcom/ui-element/blob/a2e ##### K -`K` *extends* `string` +`K` _extends_ `string` #### Parameters @@ -52,7 +52,7 @@ Defined in: [src/component.ts:59](https://github.com/zeixcom/ui-element/blob/a2e ##### K -`K` *extends* `string` +`K` _extends_ `string` #### Parameters @@ -72,7 +72,7 @@ Defined in: [src/component.ts:59](https://github.com/zeixcom/ui-element/blob/a2e ##### K -`K` *extends* `string` +`K` _extends_ `string` #### Parameters @@ -92,4 +92,4 @@ Defined in: [src/component.ts:59](https://github.com/zeixcom/ui-element/blob/a2e ### P -`P` *extends* [`ComponentProps`](ComponentProps.md) +`P` _extends_ [`ComponentProps`](ComponentProps.md) diff --git a/docs-src/pages/api/type-aliases/ComponentProps.md b/docs-src/pages/api/type-aliases/ComponentProps.md index e73103d9..140ec3ce 100644 --- a/docs-src/pages/api/type-aliases/ComponentProps.md +++ b/docs-src/pages/api/type-aliases/ComponentProps.md @@ -1,11 +1,11 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / ComponentProps +[@zeix/le-truc](../globals.md) / ComponentProps # Type Alias: ComponentProps > **ComponentProps** = `{ [K in string as ValidPropertyKey]: unknown & {} }` -Defined in: [src/component.ts:57](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/component.ts#L57) +Defined in: [src/component.ts:57](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/component.ts#L57) diff --git a/docs-src/pages/api/type-aliases/Computed.md b/docs-src/pages/api/type-aliases/Computed.md index c3cda2a1..e30c6712 100644 --- a/docs-src/pages/api/type-aliases/Computed.md +++ b/docs-src/pages/api/type-aliases/Computed.md @@ -1,18 +1,18 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / Computed +[@zeix/le-truc](../globals.md) / Computed # Type Alias: Computed\ > **Computed**\<`T`\> = `object` -Defined in: node\_modules/@zeix/cause-effect/src/computed.ts:19 +Defined in: node_modules/@zeix/cause-effect/src/computed.ts:19 ## Name -UIElement +Le Truc ## Version @@ -26,7 +26,7 @@ Esther Brunner ### T -`T` *extends* `object` +`T` _extends_ `object` ## Properties @@ -34,7 +34,7 @@ Esther Brunner > **\[toStringTag\]**: `"Computed"` -Defined in: node\_modules/@zeix/cause-effect/src/computed.ts:20 +Defined in: node_modules/@zeix/cause-effect/src/computed.ts:20 ## Methods @@ -42,7 +42,7 @@ Defined in: node\_modules/@zeix/cause-effect/src/computed.ts:20 > **get**(): `T` -Defined in: node\_modules/@zeix/cause-effect/src/computed.ts:21 +Defined in: node_modules/@zeix/cause-effect/src/computed.ts:21 #### Returns diff --git a/docs-src/pages/api/type-aliases/ComputedCallback.md b/docs-src/pages/api/type-aliases/ComputedCallback.md index 2baa4f15..1b680365 100644 --- a/docs-src/pages/api/type-aliases/ComputedCallback.md +++ b/docs-src/pages/api/type-aliases/ComputedCallback.md @@ -1,24 +1,24 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / ComputedCallback +[@zeix/le-truc](../globals.md) / ComputedCallback # Type Alias: ComputedCallback\ > **ComputedCallback**\<`T`\> = (`abort`) => `Promise`\<`T`\> \| () => `T` -Defined in: node\_modules/@zeix/cause-effect/src/computed.ts:23 +Defined in: node_modules/@zeix/cause-effect/src/computed.ts:23 ## Type Parameters ### T -`T` *extends* `object` & `object` +`T` _extends_ `object` & `object` ## Name -UIElement +Le Truc ## Version diff --git a/docs-src/pages/api/type-aliases/Context.md b/docs-src/pages/api/type-aliases/Context.md index 2798c5f1..0f70414d 100644 --- a/docs-src/pages/api/type-aliases/Context.md +++ b/docs-src/pages/api/type-aliases/Context.md @@ -1,19 +1,19 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / Context +[@zeix/le-truc](../globals.md) / Context # Type Alias: Context\ > **Context**\<`K`, `V`\> = `K` & `object` -Defined in: [src/core/context.ts:22](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/context.ts#L22) +Defined in: [src/core/context.ts:22](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/context.ts#L22) A context key. A context key can be any type of object, including strings and symbols. The - Context type brands the key type with the `__context__` property that +Context type brands the key type with the `__context__` property that carries the type of the value the context references. ## Type declaration diff --git a/docs-src/pages/api/type-aliases/ContextType.md b/docs-src/pages/api/type-aliases/ContextType.md index 15527c14..2397f395 100644 --- a/docs-src/pages/api/type-aliases/ContextType.md +++ b/docs-src/pages/api/type-aliases/ContextType.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / ContextType +[@zeix/le-truc](../globals.md) / ContextType # Type Alias: ContextType\ -> **ContextType**\<`T`\> = `T` *extends* [`Context`](Context.md)\ ? `V` : `never` +> **ContextType**\<`T`\> = `T` _extends_ [`Context`](Context.md)\ ? `V` : `never` -Defined in: [src/core/context.ts:32](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/context.ts#L32) +Defined in: [src/core/context.ts:32](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/context.ts#L32) A helper type which can extract a Context value type from a Context type @@ -16,4 +16,4 @@ A helper type which can extract a Context value type from a Context type ### T -`T` *extends* [`UnknownContext`](UnknownContext.md) +`T` _extends_ [`UnknownContext`](UnknownContext.md) diff --git a/docs-src/pages/api/type-aliases/DangerouslySetInnerHTMLOptions.md b/docs-src/pages/api/type-aliases/DangerouslySetInnerHTMLOptions.md index 72550daf..603fd853 100644 --- a/docs-src/pages/api/type-aliases/DangerouslySetInnerHTMLOptions.md +++ b/docs-src/pages/api/type-aliases/DangerouslySetInnerHTMLOptions.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / DangerouslySetInnerHTMLOptions +[@zeix/le-truc](../globals.md) / DangerouslySetInnerHTMLOptions # Type Alias: DangerouslySetInnerHTMLOptions > **DangerouslySetInnerHTMLOptions** = `object` -Defined in: [src/lib/effects.ts:54](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L54) +Defined in: [src/lib/effects.ts:54](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L54) ## Properties @@ -16,12 +16,12 @@ Defined in: [src/lib/effects.ts:54](https://github.com/zeixcom/ui-element/blob/a > `optional` **allowScripts**: `boolean` -Defined in: [src/lib/effects.ts:56](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L56) +Defined in: [src/lib/effects.ts:56](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L56) -*** +--- ### shadowRootMode? > `optional` **shadowRootMode**: `ShadowRootMode` -Defined in: [src/lib/effects.ts:55](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L55) +Defined in: [src/lib/effects.ts:55](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L55) diff --git a/docs-src/pages/api/type-aliases/Effect.md b/docs-src/pages/api/type-aliases/Effect.md index 8efcb777..4d5a6c4f 100644 --- a/docs-src/pages/api/type-aliases/Effect.md +++ b/docs-src/pages/api/type-aliases/Effect.md @@ -1,24 +1,24 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / Effect +[@zeix/le-truc](../globals.md) / Effect # Type Alias: Effect()\ > **Effect**\<`P`, `E`\> = (`host`, `element`) => [`Cleanup`](Cleanup.md) \| `void` -Defined in: [src/core/reactive.ts:15](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/reactive.ts#L15) +Defined in: [src/core/reactive.ts:15](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/reactive.ts#L15) ## Type Parameters ### P -`P` *extends* [`ComponentProps`](ComponentProps.md) +`P` _extends_ [`ComponentProps`](ComponentProps.md) ### E -`E` *extends* `Element` +`E` _extends_ `Element` ## Parameters diff --git a/docs-src/pages/api/type-aliases/EffectMatcher.md b/docs-src/pages/api/type-aliases/EffectMatcher.md index abb15de2..d9ad5234 100644 --- a/docs-src/pages/api/type-aliases/EffectMatcher.md +++ b/docs-src/pages/api/type-aliases/EffectMatcher.md @@ -1,18 +1,18 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / EffectMatcher +[@zeix/le-truc](../globals.md) / EffectMatcher # Type Alias: EffectMatcher\ > **EffectMatcher**\<`S`\> = `object` -Defined in: node\_modules/@zeix/cause-effect/src/effect.ts:7 +Defined in: node_modules/@zeix/cause-effect/src/effect.ts:7 ## Name -UIElement +Le Truc ## Version @@ -26,7 +26,7 @@ Esther Brunner ### S -`S` *extends* [`Signal`](Signal.md)\<`unknown` & `object`\>[] +`S` _extends_ [`Signal`](Signal.md)\<`unknown` & `object`\>[] ## Properties @@ -34,7 +34,7 @@ Esther Brunner > `optional` **err**: (...`errors`) => [`Cleanup`](Cleanup.md) \| `undefined` -Defined in: node\_modules/@zeix/cause-effect/src/effect.ts:10 +Defined in: node_modules/@zeix/cause-effect/src/effect.ts:10 #### Parameters @@ -46,25 +46,25 @@ Defined in: node\_modules/@zeix/cause-effect/src/effect.ts:10 [`Cleanup`](Cleanup.md) \| `undefined` -*** +--- ### nil()? > `optional` **nil**: () => [`Cleanup`](Cleanup.md) \| `undefined` -Defined in: node\_modules/@zeix/cause-effect/src/effect.ts:11 +Defined in: node_modules/@zeix/cause-effect/src/effect.ts:11 #### Returns [`Cleanup`](Cleanup.md) \| `undefined` -*** +--- ### ok() > **ok**: (...`values`) => [`Cleanup`](Cleanup.md) \| `undefined` -Defined in: node\_modules/@zeix/cause-effect/src/effect.ts:9 +Defined in: node_modules/@zeix/cause-effect/src/effect.ts:9 #### Parameters @@ -76,10 +76,10 @@ Defined in: node\_modules/@zeix/cause-effect/src/effect.ts:9 [`Cleanup`](Cleanup.md) \| `undefined` -*** +--- ### signals > **signals**: `S` -Defined in: node\_modules/@zeix/cause-effect/src/effect.ts:8 +Defined in: node_modules/@zeix/cause-effect/src/effect.ts:8 diff --git a/docs-src/pages/api/type-aliases/Effects.md b/docs-src/pages/api/type-aliases/Effects.md index 43686cbf..d62e3116 100644 --- a/docs-src/pages/api/type-aliases/Effects.md +++ b/docs-src/pages/api/type-aliases/Effects.md @@ -1,21 +1,21 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / Effects +[@zeix/le-truc](../globals.md) / Effects # Type Alias: Effects\ > **Effects**\<`P`, `E`\> = [`Effect`](Effect.md)\<`P`, `E`\> \| [`Effect`](Effect.md)\<`P`, `E`\>[] \| `Promise`\<[`Effect`](Effect.md)\<`P`, `E`\>\> \| `Promise`\<[`Effect`](Effect.md)\<`P`, `E`\>[]\> -Defined in: [src/core/reactive.ts:20](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/reactive.ts#L20) +Defined in: [src/core/reactive.ts:20](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/reactive.ts#L20) ## Type Parameters ### P -`P` *extends* [`ComponentProps`](ComponentProps.md) +`P` _extends_ [`ComponentProps`](ComponentProps.md) ### E -`E` *extends* `Element` +`E` _extends_ `Element` diff --git a/docs-src/pages/api/type-aliases/ElementEffects.md b/docs-src/pages/api/type-aliases/ElementEffects.md index e9795300..edf21203 100644 --- a/docs-src/pages/api/type-aliases/ElementEffects.md +++ b/docs-src/pages/api/type-aliases/ElementEffects.md @@ -1,20 +1,20 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / ElementEffects +[@zeix/le-truc](../globals.md) / ElementEffects # Type Alias: ElementEffects()\ > **ElementEffects**\<`P`\> = \{\<`S`\>(`selector`, `effects`, `required?`): () => `void` \| [`Cleanup`](Cleanup.md); \<`E`\>(`selector`, `effects`, `required?`): () => `void` \| [`Cleanup`](Cleanup.md); \} -Defined in: [src/core/dom.ts:84](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L84) +Defined in: [src/core/dom.ts:84](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L84) ## Type Parameters ### P -`P` *extends* [`ComponentProps`](ComponentProps.md) +`P` _extends_ [`ComponentProps`](ComponentProps.md) ## Call Signature @@ -24,7 +24,7 @@ Defined in: [src/core/dom.ts:84](https://github.com/zeixcom/ui-element/blob/a2e3 #### S -`S` *extends* `string` +`S` _extends_ `string` ### Parameters @@ -56,7 +56,7 @@ Defined in: [src/core/dom.ts:84](https://github.com/zeixcom/ui-element/blob/a2e3 #### E -`E` *extends* `Element` +`E` _extends_ `Element` ### Parameters diff --git a/docs-src/pages/api/type-aliases/ElementFromSelector.md b/docs-src/pages/api/type-aliases/ElementFromSelector.md index 9724eb75..dcacc049 100644 --- a/docs-src/pages/api/type-aliases/ElementFromSelector.md +++ b/docs-src/pages/api/type-aliases/ElementFromSelector.md @@ -1,17 +1,17 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / ElementFromSelector +[@zeix/le-truc](../globals.md) / ElementFromSelector # Type Alias: ElementFromSelector\ -> **ElementFromSelector**\<`S`\> = [`KnownTag`](KnownTag.md)\<`S`\> *extends* `never` ? `HTMLElement` : [`KnownTag`](KnownTag.md)\<`S`\> *extends* keyof `HTMLElementTagNameMap` ? `HTMLElementTagNameMap`\[[`KnownTag`](KnownTag.md)\<`S`\>\] : [`KnownTag`](KnownTag.md)\<`S`\> *extends* keyof `SVGElementTagNameMap` ? `SVGElementTagNameMap`\[[`KnownTag`](KnownTag.md)\<`S`\>\] : [`KnownTag`](KnownTag.md)\<`S`\> *extends* keyof `MathMLElementTagNameMap` ? `MathMLElementTagNameMap`\[[`KnownTag`](KnownTag.md)\<`S`\>\] : `HTMLElement` +> **ElementFromSelector**\<`S`\> = [`KnownTag`](KnownTag.md)\<`S`\> _extends_ `never` ? `HTMLElement` : [`KnownTag`](KnownTag.md)\<`S`\> _extends_ keyof `HTMLElementTagNameMap` ? `HTMLElementTagNameMap`\[[`KnownTag`](KnownTag.md)\<`S`\>\] : [`KnownTag`](KnownTag.md)\<`S`\> _extends_ keyof `SVGElementTagNameMap` ? `SVGElementTagNameMap`\[[`KnownTag`](KnownTag.md)\<`S`\>\] : [`KnownTag`](KnownTag.md)\<`S`\> _extends_ keyof `MathMLElementTagNameMap` ? `MathMLElementTagNameMap`\[[`KnownTag`](KnownTag.md)\<`S`\>\] : `HTMLElement` -Defined in: [src/core/dom.ts:40](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L40) +Defined in: [src/core/dom.ts:40](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L40) ## Type Parameters ### S -`S` *extends* `string` +`S` _extends_ `string` diff --git a/docs-src/pages/api/type-aliases/ElementInserter.md b/docs-src/pages/api/type-aliases/ElementInserter.md index 3be818a9..a7f81b3b 100644 --- a/docs-src/pages/api/type-aliases/ElementInserter.md +++ b/docs-src/pages/api/type-aliases/ElementInserter.md @@ -1,20 +1,20 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / ElementInserter +[@zeix/le-truc](../globals.md) / ElementInserter # Type Alias: ElementInserter\ > **ElementInserter**\<`E`\> = `object` -Defined in: [src/lib/effects.ts:47](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L47) +Defined in: [src/lib/effects.ts:47](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L47) ## Type Parameters ### E -`E` *extends* `Element` +`E` _extends_ `Element` ## Properties @@ -22,7 +22,7 @@ Defined in: [src/lib/effects.ts:47](https://github.com/zeixcom/ui-element/blob/a > **create**: (`parent`) => `Element` \| `null` -Defined in: [src/lib/effects.ts:49](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L49) +Defined in: [src/lib/effects.ts:49](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L49) #### Parameters @@ -34,21 +34,21 @@ Defined in: [src/lib/effects.ts:49](https://github.com/zeixcom/ui-element/blob/a `Element` \| `null` -*** +--- ### position? > `optional` **position**: `InsertPosition` -Defined in: [src/lib/effects.ts:48](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L48) +Defined in: [src/lib/effects.ts:48](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L48) -*** +--- ### reject()? > `optional` **reject**: (`error`) => `void` -Defined in: [src/lib/effects.ts:51](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L51) +Defined in: [src/lib/effects.ts:51](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L51) #### Parameters @@ -60,13 +60,13 @@ Defined in: [src/lib/effects.ts:51](https://github.com/zeixcom/ui-element/blob/a `void` -*** +--- ### resolve()? > `optional` **resolve**: (`parent`) => `void` -Defined in: [src/lib/effects.ts:50](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L50) +Defined in: [src/lib/effects.ts:50](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L50) #### Parameters diff --git a/docs-src/pages/api/type-aliases/ElementUpdater.md b/docs-src/pages/api/type-aliases/ElementUpdater.md index a6388157..56e375a7 100644 --- a/docs-src/pages/api/type-aliases/ElementUpdater.md +++ b/docs-src/pages/api/type-aliases/ElementUpdater.md @@ -1,20 +1,20 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / ElementUpdater +[@zeix/le-truc](../globals.md) / ElementUpdater # Type Alias: ElementUpdater\ > **ElementUpdater**\<`E`, `T`\> = `object` -Defined in: [src/lib/effects.ts:37](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L37) +Defined in: [src/lib/effects.ts:37](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L37) ## Type Parameters ### E -`E` *extends* `Element` +`E` _extends_ `Element` ### T @@ -26,7 +26,7 @@ Defined in: [src/lib/effects.ts:37](https://github.com/zeixcom/ui-element/blob/a > `optional` **delete**: (`element`) => `void` -Defined in: [src/lib/effects.ts:42](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L42) +Defined in: [src/lib/effects.ts:42](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L42) #### Parameters @@ -38,29 +38,29 @@ Defined in: [src/lib/effects.ts:42](https://github.com/zeixcom/ui-element/blob/a `void` -*** +--- ### name? > `optional` **name**: `string` -Defined in: [src/lib/effects.ts:39](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L39) +Defined in: [src/lib/effects.ts:39](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L39) -*** +--- ### op > **op**: [`UpdateOperation`](UpdateOperation.md) -Defined in: [src/lib/effects.ts:38](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L38) +Defined in: [src/lib/effects.ts:38](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L38) -*** +--- ### read() > **read**: (`element`) => `T` \| `null` -Defined in: [src/lib/effects.ts:40](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L40) +Defined in: [src/lib/effects.ts:40](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L40) #### Parameters @@ -72,13 +72,13 @@ Defined in: [src/lib/effects.ts:40](https://github.com/zeixcom/ui-element/blob/a `T` \| `null` -*** +--- ### reject()? > `optional` **reject**: (`error`) => `void` -Defined in: [src/lib/effects.ts:44](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L44) +Defined in: [src/lib/effects.ts:44](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L44) #### Parameters @@ -90,13 +90,13 @@ Defined in: [src/lib/effects.ts:44](https://github.com/zeixcom/ui-element/blob/a `void` -*** +--- ### resolve()? > `optional` **resolve**: (`element`) => `void` -Defined in: [src/lib/effects.ts:43](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L43) +Defined in: [src/lib/effects.ts:43](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L43) #### Parameters @@ -108,13 +108,13 @@ Defined in: [src/lib/effects.ts:43](https://github.com/zeixcom/ui-element/blob/a `void` -*** +--- ### update() > **update**: (`element`, `value`) => `void` -Defined in: [src/lib/effects.ts:41](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L41) +Defined in: [src/lib/effects.ts:41](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L41) #### Parameters diff --git a/docs-src/pages/api/type-aliases/ElementUsage.md b/docs-src/pages/api/type-aliases/ElementUsage.md index 0cccd8f9..665adb1e 100644 --- a/docs-src/pages/api/type-aliases/ElementUsage.md +++ b/docs-src/pages/api/type-aliases/ElementUsage.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / ElementUsage +[@zeix/le-truc](../globals.md) / ElementUsage # Type Alias: ElementUsage() > **ElementUsage** = \{\<`S`\>(`selector`, `required`): [`ElementFromSelector`](ElementFromSelector.md)\<`S`\>; \<`S`\>(`selector`): `null` \| [`ElementFromSelector`](ElementFromSelector.md)\<`S`\>; \<`E`\>(`selector`, `required`): `E`; \<`E`\>(`selector`): `null` \| `E`; \} -Defined in: [src/core/dom.ts:72](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L72) +Defined in: [src/core/dom.ts:72](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L72) ## Call Signature @@ -18,7 +18,7 @@ Defined in: [src/core/dom.ts:72](https://github.com/zeixcom/ui-element/blob/a2e3 #### S -`S` *extends* `string` +`S` _extends_ `string` ### Parameters @@ -42,7 +42,7 @@ Defined in: [src/core/dom.ts:72](https://github.com/zeixcom/ui-element/blob/a2e3 #### S -`S` *extends* `string` +`S` _extends_ `string` ### Parameters @@ -62,7 +62,7 @@ Defined in: [src/core/dom.ts:72](https://github.com/zeixcom/ui-element/blob/a2e3 #### E -`E` *extends* `Element` +`E` _extends_ `Element` ### Parameters @@ -86,7 +86,7 @@ Defined in: [src/core/dom.ts:72](https://github.com/zeixcom/ui-element/blob/a2e3 #### E -`E` *extends* `Element` +`E` _extends_ `Element` ### Parameters diff --git a/docs-src/pages/api/type-aliases/ElementsUsage.md b/docs-src/pages/api/type-aliases/ElementsUsage.md index 27a5e408..e0aa550b 100644 --- a/docs-src/pages/api/type-aliases/ElementsUsage.md +++ b/docs-src/pages/api/type-aliases/ElementsUsage.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / ElementsUsage +[@zeix/le-truc](../globals.md) / ElementsUsage # Type Alias: ElementsUsage() > **ElementsUsage** = \{\<`S`\>(`selector`, `required?`): [`ElementFromSelector`](ElementFromSelector.md)\<`S`\>[]; \<`E`\>(`selector`, `required?`): `E`[]; \} -Defined in: [src/core/dom.ts:79](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L79) +Defined in: [src/core/dom.ts:79](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L79) ## Call Signature @@ -18,7 +18,7 @@ Defined in: [src/core/dom.ts:79](https://github.com/zeixcom/ui-element/blob/a2e3 #### S -`S` *extends* `string` +`S` _extends_ `string` ### Parameters @@ -42,7 +42,7 @@ Defined in: [src/core/dom.ts:79](https://github.com/zeixcom/ui-element/blob/a2e3 #### E -`E` *extends* `Element` +`E` _extends_ `Element` ### Parameters diff --git a/docs-src/pages/api/type-aliases/EventHandler.md b/docs-src/pages/api/type-aliases/EventHandler.md index 95f610be..704a0943 100644 --- a/docs-src/pages/api/type-aliases/EventHandler.md +++ b/docs-src/pages/api/type-aliases/EventHandler.md @@ -1,28 +1,28 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / EventHandler +[@zeix/le-truc](../globals.md) / EventHandler # Type Alias: EventHandler()\ > **EventHandler**\<`P`, `E`, `Evt`\> = (`context`) => `{ [K in keyof P]?: P[K] }` \| `void` -Defined in: [src/core/events.ts:44](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/events.ts#L44) +Defined in: [src/core/events.ts:44](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/events.ts#L44) ## Type Parameters ### P -`P` *extends* [`ComponentProps`](ComponentProps.md) +`P` _extends_ [`ComponentProps`](ComponentProps.md) ### E -`E` *extends* `Element` +`E` _extends_ `Element` ### Evt -`Evt` *extends* `Event` +`Evt` _extends_ `Event` ## Parameters diff --git a/docs-src/pages/api/type-aliases/EventTransformer.md b/docs-src/pages/api/type-aliases/EventTransformer.md index 40e27abc..880e5b2b 100644 --- a/docs-src/pages/api/type-aliases/EventTransformer.md +++ b/docs-src/pages/api/type-aliases/EventTransformer.md @@ -1,32 +1,32 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / EventTransformer +[@zeix/le-truc](../globals.md) / EventTransformer # Type Alias: EventTransformer()\ > **EventTransformer**\<`T`, `E`, `C`, `Evt`\> = (`context`) => `T` \| `void` -Defined in: [src/core/events.ts:29](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/events.ts#L29) +Defined in: [src/core/events.ts:29](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/events.ts#L29) ## Type Parameters ### T -`T` *extends* `object` +`T` _extends_ `object` ### E -`E` *extends* `Element` +`E` _extends_ `Element` ### C -`C` *extends* `HTMLElement` +`C` _extends_ `HTMLElement` ### Evt -`Evt` *extends* `Event` +`Evt` _extends_ `Event` ## Parameters diff --git a/docs-src/pages/api/type-aliases/EventTransformers.md b/docs-src/pages/api/type-aliases/EventTransformers.md index a494b39a..6d95430f 100644 --- a/docs-src/pages/api/type-aliases/EventTransformers.md +++ b/docs-src/pages/api/type-aliases/EventTransformers.md @@ -1,25 +1,25 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / EventTransformers +[@zeix/le-truc](../globals.md) / EventTransformers # Type Alias: EventTransformers\ > **EventTransformers**\<`T`, `E`, `C`\> = `{ [K in keyof HTMLElementEventMap]?: EventTransformer> }` -Defined in: [src/core/events.ts:36](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/events.ts#L36) +Defined in: [src/core/events.ts:36](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/events.ts#L36) ## Type Parameters ### T -`T` *extends* `object` +`T` _extends_ `object` ### E -`E` *extends* `Element` +`E` _extends_ `Element` ### C -`C` *extends* `HTMLElement` +`C` _extends_ `HTMLElement` diff --git a/docs-src/pages/api/type-aliases/EventType.md b/docs-src/pages/api/type-aliases/EventType.md index a77c27d3..4eadadaa 100644 --- a/docs-src/pages/api/type-aliases/EventType.md +++ b/docs-src/pages/api/type-aliases/EventType.md @@ -1,17 +1,17 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / EventType +[@zeix/le-truc](../globals.md) / EventType # Type Alias: EventType\ -> **EventType**\<`K`\> = `K` *extends* keyof `HTMLElementEventMap` ? `HTMLElementEventMap`\[`K`\] : `Event` +> **EventType**\<`K`\> = `K` _extends_ keyof `HTMLElementEventMap` ? `HTMLElementEventMap`\[`K`\] : `Event` -Defined in: [src/core/events.ts:25](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/events.ts#L25) +Defined in: [src/core/events.ts:25](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/events.ts#L25) ## Type Parameters ### K -`K` *extends* `string` +`K` _extends_ `string` diff --git a/docs-src/pages/api/type-aliases/ExtractTag.md b/docs-src/pages/api/type-aliases/ExtractTag.md index dd558fa9..35924a00 100644 --- a/docs-src/pages/api/type-aliases/ExtractTag.md +++ b/docs-src/pages/api/type-aliases/ExtractTag.md @@ -1,17 +1,17 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / ExtractTag +[@zeix/le-truc](../globals.md) / ExtractTag # Type Alias: ExtractTag\ -> **ExtractTag**\<`S`\> = `S` *extends* `` `${infer T}.${string}` `` ? `T` : `S` *extends* `` `${infer T}#${string}` `` ? `T` : `S` *extends* `` `${infer T}:${string}` `` ? `T` : `S` *extends* `` `${infer T}[${string}` `` ? `T` : `S` +> **ExtractTag**\<`S`\> = `S` _extends_ `` `${infer T}.${string}` `` ? `T` : `S` _extends_ `` `${infer T}#${string}` `` ? `T` : `S` _extends_ `` `${infer T}:${string}` `` ? `T` : `S` _extends_ `` `${infer T}[${string}` `` ? `T` : `S` -Defined in: [src/core/dom.ts:20](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L20) +Defined in: [src/core/dom.ts:20](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L20) ## Type Parameters ### S -`S` *extends* `string` +`S` _extends_ `string` diff --git a/docs-src/pages/api/type-aliases/Extractor.md b/docs-src/pages/api/type-aliases/Extractor.md index 6199f5fb..cbc6286f 100644 --- a/docs-src/pages/api/type-aliases/Extractor.md +++ b/docs-src/pages/api/type-aliases/Extractor.md @@ -1,24 +1,24 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / Extractor +[@zeix/le-truc](../globals.md) / Extractor # Type Alias: Extractor()\ > **Extractor**\<`T`, `E`\> = (`element`) => `T` -Defined in: [src/core/dom.ts:50](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L50) +Defined in: [src/core/dom.ts:50](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L50) ## Type Parameters ### T -`T` *extends* `object` +`T` _extends_ `object` ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/type-aliases/Fallback.md b/docs-src/pages/api/type-aliases/Fallback.md index 08109ad1..7530b36d 100644 --- a/docs-src/pages/api/type-aliases/Fallback.md +++ b/docs-src/pages/api/type-aliases/Fallback.md @@ -1,21 +1,21 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / Fallback +[@zeix/le-truc](../globals.md) / Fallback # Type Alias: Fallback\ > **Fallback**\<`T`, `E`\> = `T` \| [`Extractor`](Extractor.md)\<`T`, `E`\> -Defined in: [src/core/dom.ts:64](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L64) +Defined in: [src/core/dom.ts:64](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L64) ## Type Parameters ### T -`T` *extends* `object` +`T` _extends_ `object` ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` diff --git a/docs-src/pages/api/type-aliases/Helpers.md b/docs-src/pages/api/type-aliases/Helpers.md index 7d7aa376..ccff3501 100644 --- a/docs-src/pages/api/type-aliases/Helpers.md +++ b/docs-src/pages/api/type-aliases/Helpers.md @@ -1,20 +1,20 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / Helpers +[@zeix/le-truc](../globals.md) / Helpers # Type Alias: Helpers\ > **Helpers**\<`P`\> = `object` -Defined in: [src/core/dom.ts:97](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L97) +Defined in: [src/core/dom.ts:97](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L97) ## Type Parameters ### P -`P` *extends* [`ComponentProps`](ComponentProps.md) +`P` _extends_ [`ComponentProps`](ComponentProps.md) ## Properties @@ -22,28 +22,28 @@ Defined in: [src/core/dom.ts:97](https://github.com/zeixcom/ui-element/blob/a2e3 > **all**: [`ElementEffects`](ElementEffects.md)\<`P`\> -Defined in: [src/core/dom.ts:101](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L101) +Defined in: [src/core/dom.ts:101](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L101) -*** +--- ### first > **first**: [`ElementEffects`](ElementEffects.md)\<`P`\> -Defined in: [src/core/dom.ts:100](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L100) +Defined in: [src/core/dom.ts:100](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L100) -*** +--- ### useElement > **useElement**: [`ElementUsage`](ElementUsage.md) -Defined in: [src/core/dom.ts:98](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L98) +Defined in: [src/core/dom.ts:98](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L98) -*** +--- ### useElements > **useElements**: [`ElementsUsage`](ElementsUsage.md) -Defined in: [src/core/dom.ts:99](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L99) +Defined in: [src/core/dom.ts:99](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L99) diff --git a/docs-src/pages/api/type-aliases/Initializer.md b/docs-src/pages/api/type-aliases/Initializer.md index c66b71fc..82ad754c 100644 --- a/docs-src/pages/api/type-aliases/Initializer.md +++ b/docs-src/pages/api/type-aliases/Initializer.md @@ -1,21 +1,21 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / Initializer +[@zeix/le-truc](../globals.md) / Initializer # Type Alias: Initializer\ > **Initializer**\<`T`, `C`\> = `T` \| [`Parser`](Parser.md)\<`T`, `C`\> \| [`Extractor`](Extractor.md)\<[`MaybeSignal`](MaybeSignal.md)\<`T`\>, `C`\> \| (`host`) => `void` -Defined in: [src/component.ts:79](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/component.ts#L79) +Defined in: [src/component.ts:79](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/component.ts#L79) ## Type Parameters ### T -`T` *extends* `object` +`T` _extends_ `object` ### C -`C` *extends* `HTMLElement` +`C` _extends_ `HTMLElement` diff --git a/docs-src/pages/api/type-aliases/KnownTag.md b/docs-src/pages/api/type-aliases/KnownTag.md index 2f812e9b..ea2ce784 100644 --- a/docs-src/pages/api/type-aliases/KnownTag.md +++ b/docs-src/pages/api/type-aliases/KnownTag.md @@ -1,17 +1,17 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / KnownTag +[@zeix/le-truc](../globals.md) / KnownTag # Type Alias: KnownTag\ -> **KnownTag**\<`S`\> = `Lowercase`\<[`ExtractTag`](ExtractTag.md)\<`S`\>\> *extends* keyof `HTMLElementTagNameMap` \| keyof `SVGElementTagNameMap` \| keyof `MathMLElementTagNameMap` ? `Lowercase`\<[`ExtractTag`](ExtractTag.md)\<`S`\>\> : `never` +> **KnownTag**\<`S`\> = `Lowercase`\<[`ExtractTag`](ExtractTag.md)\<`S`\>\> _extends_ keyof `HTMLElementTagNameMap` \| keyof `SVGElementTagNameMap` \| keyof `MathMLElementTagNameMap` ? `Lowercase`\<[`ExtractTag`](ExtractTag.md)\<`S`\>\> : `never` -Defined in: [src/core/dom.ts:31](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L31) +Defined in: [src/core/dom.ts:31](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L31) ## Type Parameters ### S -`S` *extends* `string` +`S` _extends_ `string` diff --git a/docs-src/pages/api/type-aliases/LogLevel.md b/docs-src/pages/api/type-aliases/LogLevel.md index 21ca8a83..8ad1ff18 100644 --- a/docs-src/pages/api/type-aliases/LogLevel.md +++ b/docs-src/pages/api/type-aliases/LogLevel.md @@ -1,11 +1,11 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / LogLevel +[@zeix/le-truc](../globals.md) / LogLevel # Type Alias: LogLevel > **LogLevel** = `"debug"` \| `"info"` \| `"warn"` \| `"error"` -Defined in: [src/core/util.ts:5](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/util.ts#L5) +Defined in: [src/core/util.ts:5](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/util.ts#L5) diff --git a/docs-src/pages/api/type-aliases/LooseExtractor.md b/docs-src/pages/api/type-aliases/LooseExtractor.md index db80363e..fb5ca7c0 100644 --- a/docs-src/pages/api/type-aliases/LooseExtractor.md +++ b/docs-src/pages/api/type-aliases/LooseExtractor.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / LooseExtractor +[@zeix/le-truc](../globals.md) / LooseExtractor # Type Alias: LooseExtractor()\ > **LooseExtractor**\<`T`, `E`\> = (`element`) => `T` \| `null` \| `undefined` -Defined in: [src/core/dom.ts:54](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L54) +Defined in: [src/core/dom.ts:54](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L54) ## Type Parameters @@ -18,7 +18,7 @@ Defined in: [src/core/dom.ts:54](https://github.com/zeixcom/ui-element/blob/a2e3 ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` ## Parameters diff --git a/docs-src/pages/api/type-aliases/MaybeSignal.md b/docs-src/pages/api/type-aliases/MaybeSignal.md index d06c1824..65954854 100644 --- a/docs-src/pages/api/type-aliases/MaybeSignal.md +++ b/docs-src/pages/api/type-aliases/MaybeSignal.md @@ -1,24 +1,24 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / MaybeSignal +[@zeix/le-truc](../globals.md) / MaybeSignal # Type Alias: MaybeSignal\ > **MaybeSignal**\<`T`\> = `T` \| [`Signal`](Signal.md)\<`T`\> \| [`ComputedCallback`](ComputedCallback.md)\<`T`\> -Defined in: node\_modules/@zeix/cause-effect/src/signal.ts:14 +Defined in: node_modules/@zeix/cause-effect/src/signal.ts:14 ## Type Parameters ### T -`T` *extends* `object` +`T` _extends_ `object` ## Name -UIElement +Le Truc ## Version diff --git a/docs-src/pages/api/type-aliases/Parser.md b/docs-src/pages/api/type-aliases/Parser.md index fb3d5420..7d714212 100644 --- a/docs-src/pages/api/type-aliases/Parser.md +++ b/docs-src/pages/api/type-aliases/Parser.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) *** -[@zeix/ui-element](../globals.md) / Parser +[@zeix/le-truc](../globals.md) / Parser # Type Alias: Parser()\ > **Parser**\<`T`, `E`\> = (`element`, `value`, `old?`) => `T` -Defined in: [src/core/dom.ts:58](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L58) +Defined in: [src/core/dom.ts:58](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L58) ## Type Parameters diff --git a/docs-src/pages/api/type-aliases/ParserOrFallback.md b/docs-src/pages/api/type-aliases/ParserOrFallback.md index ca2393f4..090ec0c6 100644 --- a/docs-src/pages/api/type-aliases/ParserOrFallback.md +++ b/docs-src/pages/api/type-aliases/ParserOrFallback.md @@ -1,21 +1,21 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / ParserOrFallback +[@zeix/le-truc](../globals.md) / ParserOrFallback # Type Alias: ParserOrFallback\ > **ParserOrFallback**\<`T`, `E`\> = [`Parser`](Parser.md)\<`T`, `E`\> \| [`Fallback`](Fallback.md)\<`T`, `E`\> -Defined in: [src/core/dom.ts:68](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L68) +Defined in: [src/core/dom.ts:68](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/dom.ts#L68) ## Type Parameters ### T -`T` *extends* `object` +`T` _extends_ `object` ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` diff --git a/docs-src/pages/api/type-aliases/Reactive.md b/docs-src/pages/api/type-aliases/Reactive.md index 98a722f7..fa499862 100644 --- a/docs-src/pages/api/type-aliases/Reactive.md +++ b/docs-src/pages/api/type-aliases/Reactive.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / Reactive +[@zeix/le-truc](../globals.md) / Reactive # Type Alias: Reactive\ > **Reactive**\<`T`, `P`, `E`\> = keyof `P` \| [`Signal`](Signal.md)\<`NonNullable`\<`T`\>\> \| [`LooseExtractor`](LooseExtractor.md)\<`T` \| `null` \| `undefined`, `E`\> -Defined in: [src/core/reactive.ts:26](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/reactive.ts#L26) +Defined in: [src/core/reactive.ts:26](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/reactive.ts#L26) ## Type Parameters @@ -18,8 +18,8 @@ Defined in: [src/core/reactive.ts:26](https://github.com/zeixcom/ui-element/blob ### P -`P` *extends* [`ComponentProps`](ComponentProps.md) +`P` _extends_ [`ComponentProps`](ComponentProps.md) ### E -`E` *extends* `Element` = `HTMLElement` +`E` _extends_ `Element` = `HTMLElement` diff --git a/docs-src/pages/api/type-aliases/Reactives.md b/docs-src/pages/api/type-aliases/Reactives.md index a7d0caad..111d8ab8 100644 --- a/docs-src/pages/api/type-aliases/Reactives.md +++ b/docs-src/pages/api/type-aliases/Reactives.md @@ -1,21 +1,21 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / Reactives +[@zeix/le-truc](../globals.md) / Reactives # Type Alias: Reactives\ > **Reactives**\<`E`, `P`\> = `{ [K in keyof E]?: Reactive }` -Defined in: [src/lib/effects.ts:31](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L31) +Defined in: [src/lib/effects.ts:31](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L31) ## Type Parameters ### E -`E` *extends* `Element` +`E` _extends_ `Element` ### P -`P` *extends* [`ComponentProps`](ComponentProps.md) +`P` _extends_ [`ComponentProps`](ComponentProps.md) diff --git a/docs-src/pages/api/type-aliases/ReservedWords.md b/docs-src/pages/api/type-aliases/ReservedWords.md index 751bca7f..122203ae 100644 --- a/docs-src/pages/api/type-aliases/ReservedWords.md +++ b/docs-src/pages/api/type-aliases/ReservedWords.md @@ -1,11 +1,11 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / ReservedWords +[@zeix/le-truc](../globals.md) / ReservedWords # Type Alias: ReservedWords > **ReservedWords** = `"constructor"` \| `"prototype"` \| `"__proto__"` \| `"toString"` \| `"valueOf"` \| `"hasOwnProperty"` \| `"isPrototypeOf"` \| `"propertyIsEnumerable"` \| `"toLocaleString"` -Defined in: [src/component.ts:38](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/component.ts#L38) +Defined in: [src/component.ts:38](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/component.ts#L38) diff --git a/docs-src/pages/api/type-aliases/Setup.md b/docs-src/pages/api/type-aliases/Setup.md index 425c519e..9236a35e 100644 --- a/docs-src/pages/api/type-aliases/Setup.md +++ b/docs-src/pages/api/type-aliases/Setup.md @@ -1,20 +1,20 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / Setup +[@zeix/le-truc](../globals.md) / Setup # Type Alias: Setup()\ > **Setup**\<`P`\> = (`host`, `helpers`) => [`Effects`](Effects.md)\<`P`, [`Component`](Component.md)\<`P`\>\> -Defined in: [src/component.ts:85](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/component.ts#L85) +Defined in: [src/component.ts:85](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/component.ts#L85) ## Type Parameters ### P -`P` *extends* [`ComponentProps`](ComponentProps.md) +`P` _extends_ [`ComponentProps`](ComponentProps.md) ## Parameters diff --git a/docs-src/pages/api/type-aliases/Signal.md b/docs-src/pages/api/type-aliases/Signal.md index aa22a3e8..f12c0fc0 100644 --- a/docs-src/pages/api/type-aliases/Signal.md +++ b/docs-src/pages/api/type-aliases/Signal.md @@ -1,18 +1,18 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / Signal +[@zeix/le-truc](../globals.md) / Signal # Type Alias: Signal\ > **Signal**\<`T`\> = `object` -Defined in: node\_modules/@zeix/cause-effect/src/signal.ts:11 +Defined in: node_modules/@zeix/cause-effect/src/signal.ts:11 ## Name -UIElement +Le Truc ## Version @@ -26,7 +26,7 @@ Esther Brunner ### T -`T` *extends* `object` +`T` _extends_ `object` ## Methods @@ -34,7 +34,7 @@ Esther Brunner > **get**(): `T` -Defined in: node\_modules/@zeix/cause-effect/src/signal.ts:12 +Defined in: node_modules/@zeix/cause-effect/src/signal.ts:12 #### Returns diff --git a/docs-src/pages/api/type-aliases/State.md b/docs-src/pages/api/type-aliases/State.md index 2092ed44..62e65a69 100644 --- a/docs-src/pages/api/type-aliases/State.md +++ b/docs-src/pages/api/type-aliases/State.md @@ -1,18 +1,18 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / State +[@zeix/le-truc](../globals.md) / State # Type Alias: State\ > **State**\<`T`\> = `object` -Defined in: node\_modules/@zeix/cause-effect/src/state.ts:7 +Defined in: node_modules/@zeix/cause-effect/src/state.ts:7 ## Name -UIElement +Le Truc ## Version @@ -26,7 +26,7 @@ Esther Brunner ### T -`T` *extends* `object` +`T` _extends_ `object` ## Properties @@ -34,7 +34,7 @@ Esther Brunner > **\[toStringTag\]**: `"State"` -Defined in: node\_modules/@zeix/cause-effect/src/state.ts:8 +Defined in: node_modules/@zeix/cause-effect/src/state.ts:8 ## Methods @@ -42,19 +42,19 @@ Defined in: node\_modules/@zeix/cause-effect/src/state.ts:8 > **get**(): `T` -Defined in: node\_modules/@zeix/cause-effect/src/state.ts:9 +Defined in: node_modules/@zeix/cause-effect/src/state.ts:9 #### Returns `T` -*** +--- ### set() > **set**(`v`): `void` -Defined in: node\_modules/@zeix/cause-effect/src/state.ts:10 +Defined in: node_modules/@zeix/cause-effect/src/state.ts:10 #### Parameters @@ -66,13 +66,13 @@ Defined in: node\_modules/@zeix/cause-effect/src/state.ts:10 `void` -*** +--- ### update() > **update**(`fn`): `void` -Defined in: node\_modules/@zeix/cause-effect/src/state.ts:11 +Defined in: node_modules/@zeix/cause-effect/src/state.ts:11 #### Parameters diff --git a/docs-src/pages/api/type-aliases/UnknownContext.md b/docs-src/pages/api/type-aliases/UnknownContext.md index 31a8af40..5857b44e 100644 --- a/docs-src/pages/api/type-aliases/UnknownContext.md +++ b/docs-src/pages/api/type-aliases/UnknownContext.md @@ -1,13 +1,13 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / UnknownContext +[@zeix/le-truc](../globals.md) / UnknownContext # Type Alias: UnknownContext > **UnknownContext** = [`Context`](Context.md)\<`unknown`, `unknown`\> -Defined in: [src/core/context.ts:27](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/context.ts#L27) +Defined in: [src/core/context.ts:27](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/context.ts#L27) An unknown context type diff --git a/docs-src/pages/api/type-aliases/UpdateOperation.md b/docs-src/pages/api/type-aliases/UpdateOperation.md index 48234bcd..3ee17d7c 100644 --- a/docs-src/pages/api/type-aliases/UpdateOperation.md +++ b/docs-src/pages/api/type-aliases/UpdateOperation.md @@ -1,11 +1,11 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / UpdateOperation +[@zeix/le-truc](../globals.md) / UpdateOperation # Type Alias: UpdateOperation > **UpdateOperation** = `"a"` \| `"c"` \| `"d"` \| `"h"` \| `"m"` \| `"p"` \| `"s"` \| `"t"` -Defined in: [src/lib/effects.ts:35](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L35) +Defined in: [src/lib/effects.ts:35](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/lib/effects.ts#L35) diff --git a/docs-src/pages/api/type-aliases/ValidPropertyKey.md b/docs-src/pages/api/type-aliases/ValidPropertyKey.md index a99c23d9..0dcdd13f 100644 --- a/docs-src/pages/api/type-aliases/ValidPropertyKey.md +++ b/docs-src/pages/api/type-aliases/ValidPropertyKey.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / ValidPropertyKey +[@zeix/le-truc](../globals.md) / ValidPropertyKey # Type Alias: ValidPropertyKey\ -> **ValidPropertyKey**\<`T`\> = `T` *extends* keyof `HTMLElement` \| [`ReservedWords`](ReservedWords.md) ? `never` : `T` +> **ValidPropertyKey**\<`T`\> = `T` _extends_ keyof `HTMLElement` \| [`ReservedWords`](ReservedWords.md) ? `never` : `T` -Defined in: [src/component.ts:49](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/component.ts#L49) +Defined in: [src/component.ts:49](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/component.ts#L49) ## Type Parameters diff --git a/docs-src/pages/api/type-aliases/ValidateComponentProps.md b/docs-src/pages/api/type-aliases/ValidateComponentProps.md index adb3d9f5..1b224943 100644 --- a/docs-src/pages/api/type-aliases/ValidateComponentProps.md +++ b/docs-src/pages/api/type-aliases/ValidateComponentProps.md @@ -1,14 +1,14 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / ValidateComponentProps +[@zeix/le-truc](../globals.md) / ValidateComponentProps # Type Alias: ValidateComponentProps\ > **ValidateComponentProps**\<`P`\> = `{ [K in keyof P]: ValidPropertyKey extends never ? never : P[K] }` -Defined in: [src/component.ts:53](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/component.ts#L53) +Defined in: [src/component.ts:53](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/component.ts#L53) ## Type Parameters diff --git a/docs-src/pages/api/variables/DEV_MODE.md b/docs-src/pages/api/variables/DEV_MODE.md index f2745af0..58e52803 100644 --- a/docs-src/pages/api/variables/DEV_MODE.md +++ b/docs-src/pages/api/variables/DEV_MODE.md @@ -1,11 +1,11 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / DEV\_MODE +[@zeix/le-truc](../globals.md) / DEV_MODE -# Variable: DEV\_MODE +# Variable: DEV_MODE -> `const` **DEV\_MODE**: `undefined` \| `string` = `process.env.DEV_MODE` +> `const` **DEV_MODE**: `undefined` \| `string` = `process.env.DEV_MODE` -Defined in: [src/core/util.ts:9](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/util.ts#L9) +Defined in: [src/core/util.ts:9](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/util.ts#L9) diff --git a/docs-src/pages/api/variables/LOG_DEBUG.md b/docs-src/pages/api/variables/LOG_DEBUG.md index 18b7e6e8..cbd63b89 100644 --- a/docs-src/pages/api/variables/LOG_DEBUG.md +++ b/docs-src/pages/api/variables/LOG_DEBUG.md @@ -1,11 +1,11 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / LOG\_DEBUG +[@zeix/le-truc](../globals.md) / LOG_DEBUG -# Variable: LOG\_DEBUG +# Variable: LOG_DEBUG -> `const` **LOG\_DEBUG**: [`LogLevel`](../type-aliases/LogLevel.md) = `'debug'` +> `const` **LOG_DEBUG**: [`LogLevel`](../type-aliases/LogLevel.md) = `'debug'` -Defined in: [src/core/util.ts:11](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/util.ts#L11) +Defined in: [src/core/util.ts:11](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/util.ts#L11) diff --git a/docs-src/pages/api/variables/LOG_ERROR.md b/docs-src/pages/api/variables/LOG_ERROR.md index e09f4af5..f9e679c9 100644 --- a/docs-src/pages/api/variables/LOG_ERROR.md +++ b/docs-src/pages/api/variables/LOG_ERROR.md @@ -1,11 +1,11 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / LOG\_ERROR +[@zeix/le-truc](../globals.md) / LOG_ERROR -# Variable: LOG\_ERROR +# Variable: LOG_ERROR -> `const` **LOG\_ERROR**: [`LogLevel`](../type-aliases/LogLevel.md) = `'error'` +> `const` **LOG_ERROR**: [`LogLevel`](../type-aliases/LogLevel.md) = `'error'` -Defined in: [src/core/util.ts:14](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/util.ts#L14) +Defined in: [src/core/util.ts:14](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/util.ts#L14) diff --git a/docs-src/pages/api/variables/LOG_INFO.md b/docs-src/pages/api/variables/LOG_INFO.md index f0c8ec33..72fa044c 100644 --- a/docs-src/pages/api/variables/LOG_INFO.md +++ b/docs-src/pages/api/variables/LOG_INFO.md @@ -1,11 +1,11 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / LOG\_INFO +[@zeix/le-truc](../globals.md) / LOG_INFO -# Variable: LOG\_INFO +# Variable: LOG_INFO -> `const` **LOG\_INFO**: [`LogLevel`](../type-aliases/LogLevel.md) = `'info'` +> `const` **LOG_INFO**: [`LogLevel`](../type-aliases/LogLevel.md) = `'info'` -Defined in: [src/core/util.ts:12](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/util.ts#L12) +Defined in: [src/core/util.ts:12](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/util.ts#L12) diff --git a/docs-src/pages/api/variables/LOG_WARN.md b/docs-src/pages/api/variables/LOG_WARN.md index 3227fe33..74c8cf07 100644 --- a/docs-src/pages/api/variables/LOG_WARN.md +++ b/docs-src/pages/api/variables/LOG_WARN.md @@ -1,11 +1,11 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / LOG\_WARN +[@zeix/le-truc](../globals.md) / LOG_WARN -# Variable: LOG\_WARN +# Variable: LOG_WARN -> `const` **LOG\_WARN**: [`LogLevel`](../type-aliases/LogLevel.md) = `'warn'` +> `const` **LOG_WARN**: [`LogLevel`](../type-aliases/LogLevel.md) = `'warn'` -Defined in: [src/core/util.ts:13](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/util.ts#L13) +Defined in: [src/core/util.ts:13](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/util.ts#L13) diff --git a/docs-src/pages/api/variables/RESET.md b/docs-src/pages/api/variables/RESET.md index f4ce69cd..848f5a12 100644 --- a/docs-src/pages/api/variables/RESET.md +++ b/docs-src/pages/api/variables/RESET.md @@ -1,11 +1,11 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / RESET +[@zeix/le-truc](../globals.md) / RESET # Variable: RESET > `const` **RESET**: `any` -Defined in: [src/core/reactive.ts:34](https://github.com/zeixcom/ui-element/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/reactive.ts#L34) +Defined in: [src/core/reactive.ts:34](https://github.com/zeixcom/le-truc/blob/a2e3a5bb1b7ab9e964c80c41c9edbb895cf2ce79/src/core/reactive.ts#L34) diff --git a/docs-src/pages/api/variables/UNSET.md b/docs-src/pages/api/variables/UNSET.md index 7ad9d19c..f9c3d2fd 100644 --- a/docs-src/pages/api/variables/UNSET.md +++ b/docs-src/pages/api/variables/UNSET.md @@ -1,18 +1,18 @@ -[**@zeix/ui-element**](../README.md) +[**@zeix/le-truc**](../README.md) -*** +--- -[@zeix/ui-element](../globals.md) / UNSET +[@zeix/le-truc](../globals.md) / UNSET # Variable: UNSET > `const` **UNSET**: `any` -Defined in: node\_modules/@zeix/cause-effect/src/signal.ts:23 +Defined in: node_modules/@zeix/cause-effect/src/signal.ts:23 ## Name -UIElement +Le Truc ## Version diff --git a/docs-src/pages/blog.md b/docs-src/pages/blog.md index 1786498e..9481c4c6 100644 --- a/docs-src/pages/blog.md +++ b/docs-src/pages/blog.md @@ -15,7 +15,7 @@ description: 'Latest articles and updates'
-## Introducing UIElement +## Introducing Le Truc - [The Case for Components](./blog/the-case-for-components.md) - [Rethinking Reactivity](./blog/rethinking-reactivity.md) diff --git a/docs-src/pages/blog/rethinking-reactivity.md b/docs-src/pages/blog/rethinking-reactivity.md index 4d9ee4f3..f59e38c7 100644 --- a/docs-src/pages/blog/rethinking-reactivity.md +++ b/docs-src/pages/blog/rethinking-reactivity.md @@ -329,9 +329,9 @@ The native signals proposal focuses on the reactive primitives (`Signal.State` a ## A Thin Layer You Can Use Today -While native signals are still being standardized, you can use this model right now. Libraries like **Cause & Effect** (which powers UIElement) implement the same contract with near-zero overhead and an almost identical API. +While native signals are still being standardized, you can use this model right now. Libraries like **Cause & Effect** (which powers Le Truc) implement the same contract with near-zero overhead and an almost identical API. -In the next article, we'll dive into **how UIElement implements reactivity** – not with a big framework, but with a minimal toolkit that: +In the next article, we'll dive into **how Le Truc implements reactivity** – not with a big framework, but with a minimal toolkit that: - Tracks dependencies, - Updates only what changed, diff --git a/docs-src/pages/blog/the-case-for-components.md b/docs-src/pages/blog/the-case-for-components.md index 9f13535b..6cc26911 100644 --- a/docs-src/pages/blog/the-case-for-components.md +++ b/docs-src/pages/blog/the-case-for-components.md @@ -9,7 +9,7 @@ description: 'Components are a proven way to reduce complexity, encourage reuse, # The Case for Components
-

Components are a proven way to reduce complexity, encourage reuse, and allow teams to scale their work across independent user interface parts. But you don't need a framework to get these benefits. Let's explore how components help us build better interfaces – and how native Web Components and UIElement fit into that picture.

+

Components are a proven way to reduce complexity, encourage reuse, and allow teams to scale their work across independent user interface parts. But you don't need a framework to get these benefits. Let's explore how components help us build better interfaces – and how native Web Components and Le Truc fit into that picture.

{{ toc }}
@@ -95,7 +95,7 @@ Web Components are registered using `customElements.define()` and automatically ## A Solid Foundation -**UIElement** builds on the Web Platform rather than abstracting over it. We embrace semantic HTML as the foundation. Add CSS to your components however you like and make them look great. Use Web Components to add reusable behavior. +**Le Truc** builds on the Web Platform rather than abstracting over it. We embrace semantic HTML as the foundation. Add CSS to your components however you like and make them look great. Use Web Components to add reusable behavior. While native Web Components are powerful, they require you to wire things together manually – querying elements, adding event listeners, and managing updates. This works great for simple interactions, but what if we want other components or JavaScript code to control our component's state? Let's add a public API. @@ -144,16 +144,16 @@ const helloWorld = document.querySelector('hello-world') helloWorld.name = 'Betty' ``` -This manual wiring works, but notice how much boilerplate we needed for a simple reactive property. As components grow more complex, this pattern becomes harder to maintain. This is where **UIElement** shines – it provides the reactivity patterns you need while staying close to the platform. +This manual wiring works, but notice how much boilerplate we needed for a simple reactive property. As components grow more complex, this pattern becomes harder to maintain. This is where **Le Truc** shines – it provides the reactivity patterns you need while staying close to the platform. -Here's the same component rewritten using UIElement. Notice how the concerns are cleanly separated: +Here's the same component rewritten using Le Truc. Notice how the concerns are cleanly separated: - **State declaration**: `name: asString()` defines our component's reactive state - **Input handling**: The `on('input', ...)` handler updates state declaratively - **DOM updates**: `setText('name')` automatically keeps the display in sync ```js -import { component, asString, on, setText } from '@zeix/ui-element' +import { component, asString, on, setText } from '@zeix/le-truc' component( 'hello-world', @@ -182,7 +182,7 @@ The functions we use: - `on()` adds an event listener to an element and removes it when the component is disconnected. - `setText()` updates the text content of an element when a state change occurs. -Components in UIElement are still standard Web Components that can be used everywhere. Other components need to know nothing more about UIElement components other than they are standard HTML elements with a few reactive properties according to a clearly defined contract – its public interface. +Components in Le Truc are still standard Web Components that can be used everywhere. Other components need to know nothing more about Le Truc components other than they are standard HTML elements with a few reactive properties according to a clearly defined contract – its public interface.
@@ -194,7 +194,7 @@ Here's what we've seen: - **Components** help you organize frontend code in ways that scale – conceptually and organizationally. - **Web Components** offer a native way to build encapsulated, reusable user interfaces without needing a framework. -- **UIElement** builds on this foundation, simplifying common tasks like wiring inputs and syncing state to the DOM. +- **Le Truc** builds on this foundation, simplifying common tasks like wiring inputs and syncing state to the DOM. In short: you don't need a framework to build with components. You just need a few functions that stay close to the platform, while smoothing over the rough edges. @@ -206,7 +206,7 @@ In short: you don't need a framework to build with components. You just need a f In the next post, we'll revisit similar components and explore how reactivity can make more complex relationships easier to manage – like derived values, async state, and multiple sources of truth. -We'll look at the pitfalls of imperative state wiring as logic grows, and how UIElement's signal graph provides a robust and minimal foundation for keeping your user interface in sync. +We'll look at the pitfalls of imperative state wiring as logic grows, and how Le Truc's signal graph provides a robust and minimal foundation for keeping your user interface in sync. Stay tuned! diff --git a/docs-src/pages/components.md b/docs-src/pages/components.md index 45bc1647..e41882bb 100644 --- a/docs-src/pages/components.md +++ b/docs-src/pages/components.md @@ -9,7 +9,7 @@ description: 'Anatomy, lifecycle, signals, effects' # 🏗️ Components
-

Create lightweight, self-contained Web Components with built-in reactivity. UIElement lets you define custom elements that manage state efficiently, update the DOM automatically, and enhance server-rendered pages without an SPA framework.

+

Create lightweight, self-contained Web Components with built-in reactivity. Le Truc lets you define custom elements that manage state efficiently, update the DOM automatically, and enhance server-rendered pages without an SPA framework.

{{ toc }}
@@ -18,9 +18,9 @@ description: 'Anatomy, lifecycle, signals, effects' ## Defining a Component -UIElement builds on **Web Components**, extending `HTMLElement` to provide **built-in state management and reactive updates**. +Le Truc builds on **Web Components**, extending `HTMLElement` to provide **built-in state management and reactive updates**. -UIElement creates components using the `component()` function: +Le Truc creates components using the `component()` function: ```js component('my-component', {}, () => [ @@ -28,7 +28,7 @@ component('my-component', {}, () => [ ]) ``` -Every UIElement component must be registered with a valid custom element tag name (two or more words joined with `-`) as the first parameter. +Every Le Truc component must be registered with a valid custom element tag name (two or more words joined with `-`) as the first parameter. ### Using the Custom Element in HTML @@ -40,7 +40,7 @@ Once registered, the component can be used like any native HTML element: ### Anatomy of a Component -Let's examine a complete component example to understand how UIElement works: +Let's examine a complete component example to understand how Le Truc works: ```js component( @@ -74,7 +74,7 @@ This creates a reactive property called `name`: - `asString()` observes the attribute `name` and assigns its value as a string to the `name` property - `el => ...` is an instruction how to get the fallback value in the DOM if there is no name attribute -- UIElement automatically reads "World" from the `` element as the initial value +- Le Truc automatically reads "World" from the `` element as the initial value - When `name` changes, any effects that depend on it automatically update #### Setup Function @@ -121,7 +121,7 @@ Characteristics of Effects: ## Component Lifecycle -UIElement manages the **Web Component lifecycle** from creation to removal. Here's what happens. +Le Truc manages the **Web Component lifecycle** from creation to removal. Here's what happens. ### Component Creation @@ -169,7 +169,7 @@ The setup function has two arguments: 1. `el`: The component element instance. 2. `{ all, first }`: An object containing two functions, `all` and `first`, which can be used to select elements within the component. See [Accessing Sub-elements](#accessing-sub-elements). -UIElement expects you to return an array of partially applied functions to be executed during the setup phase. The order doesn't matter, as each function targets a specific element or event. So feel free to organize your code in a way that makes sense to you. +Le Truc expects you to return an array of partially applied functions to be executed during the setup phase. The order doesn't matter, as each function targets a specific element or event. So feel free to organize your code in a way that makes sense to you. Each of these functions will return a cleanup function that will be executed during the `disconnectedCallback()` lifecycle method. @@ -198,7 +198,7 @@ component( ### Removed from the DOM -Runs when the component is removed (`disconnectedCallback()`). UIElement will run all cleanup functions returned by event listeners and effects during the setup phase (`connectedCallback()`). This will unsubscribe all signals the component is subscribed to, so you don't need to worry about memory leaks. +Runs when the component is removed (`disconnectedCallback()`). Le Truc will run all cleanup functions returned by event listeners and effects during the setup phase (`connectedCallback()`). This will unsubscribe all signals the component is subscribed to, so you don't need to worry about memory leaks. If you added **event listeners** outside the scope of your component or **subscribed manually to external APIs**, you need to return a cleanup function: @@ -219,7 +219,7 @@ component('my-component', {}, el => [ ### Observed Attributes -UIElement automatically observes and converts attributes with an associated **parser function** in the init block and updates them whenever the attribute changes (`attributeChangedCallback()`). +Le Truc automatically observes and converts attributes with an associated **parser function** in the init block and updates them whenever the attribute changes (`attributeChangedCallback()`). @@ -227,7 +227,7 @@ UIElement automatically observes and converts attributes with an associated **pa ## Managing State with Signals -UIElement manages state using **signals**, which are atomic reactive states that trigger updates when they change. We use regular properties to access or update them: +Le Truc manages state using **signals**, which are atomic reactive states that trigger updates when they change. We use regular properties to access or update them: ```js console.log('count' in el) // Check if the signal exists @@ -237,19 +237,19 @@ el.count = 42 // Update the signal value ### Characteristics and Special Values -Signals in UIElement are of a **static type** and **non-nullable**. This allows to **simplify the logic** as you will never have to check the type or perform null-checks. +Signals in Le Truc are of a **static type** and **non-nullable**. This allows to **simplify the logic** as you will never have to check the type or perform null-checks. - If you use **TypeScript** (recommended), **you will be warned** that `null` or `undefined` cannot be assigned to a signal or if you try to assign a value of a wrong type. - If you use vanilla **JavaScript** without a build step, setting a signal to `null` or `undefined` **will log an error to the console and abort**. However, strict type checking is not enforced at runtime. -Because of the **non-nullable nature of signals** in UIElement, we need two special values that can be assigned to any signal type: +Because of the **non-nullable nature of signals** in Le Truc, we need two special values that can be assigned to any signal type: -- **`RESET`**: Will **reset to the server-rendered version** that was there before UIElement took control. This is what you want to do most of the times when a signal lacks a specific value. +- **`RESET`**: Will **reset to the server-rendered version** that was there before Le Truc took control. This is what you want to do most of the times when a signal lacks a specific value. - **`UNSET`**: Will **delete the signal**, **unsubscribe its watchers** and also **delete related attributes or style properties** in effects. Use this with special care! ### Initializing State from Attributes -The standard way to set initial state in UIElement is via **server-rendered attributes** on the component that needs it. No props drilling as in other frameworks. UIElements provides some bundled attribute parsers to convert attribute values to the desired type. And you can also define your own custom parsers. +The standard way to set initial state in Le Truc is via **server-rendered attributes** on the component that needs it. No props drilling as in other frameworks. Le Trucs provides some bundled attribute parsers to convert attribute values to the desired type. And you can also define your own custom parsers. ```js component( @@ -266,7 +266,7 @@ component( -**Careful**: Attributes **may not be present** on the element or **parsing to the desired type may fail**. To ensure **non-nullability** of signals, UIElement falls back to neutral defaults: +**Careful**: Attributes **may not be present** on the element or **parsing to the desired type may fail**. To ensure **non-nullability** of signals, Le Truc falls back to neutral defaults: - `""` (empty string) for `string` - `0` for `number` @@ -276,7 +276,7 @@ component( ### Bundled Attribute Parsers -UIElement provides several built-in parsers for common attribute types. See the [Parsers section](api.html#parsers) in the API reference for detailed descriptions and usage examples. +Le Truc provides several built-in parsers for common attribute types. See the [Parsers section](api.html#parsers) in the API reference for detailed descriptions and usage examples. @@ -345,7 +345,7 @@ component( The `first()` function expects the matched element to be present at connection time. If not, it will silently ignore the call. -On the other hand, the `all()` function creates a dynamic array of elements that will be updated whenever the matching elements are added or removed from the component's DOM branch. UIElement will apply the given setup functions to added elements and run the cleanup functions on removed elements. +On the other hand, the `all()` function creates a dynamic array of elements that will be updated whenever the matching elements are added or removed from the component's DOM branch. Le Truc will apply the given setup functions to added elements and run the cleanup functions on removed elements. @@ -412,7 +412,7 @@ Again, the order of effects is not important. Feel free to apply them in any ord ### Bundled Effects -UIElement provides many built-in effects for common DOM operations. See the [Effects section](api.html#effects) in the API reference for detailed descriptions and usage examples. +Le Truc provides many built-in effects for common DOM operations. See the [Effects section](api.html#effects) in the API reference for detailed descriptions and usage examples. ### Simplifying Effect Notation @@ -478,9 +478,9 @@ Ad-hoc derived state is more efficient than the overhead of a memoized computed ### Efficient & Fine-Grained Updates -Unlike some frameworks that **re-render entire components**, UIElement updates only what changes: +Unlike some frameworks that **re-render entire components**, Le Truc updates only what changes: -- **No virtual DOM** – UIElement modifies the DOM directly. +- **No virtual DOM** – Le Truc modifies the DOM directly. - **Signals propagate automatically** – no need to track dependencies manually. - **Optimized with a scheduler** – multiple updates are batched efficiently. diff --git a/docs-src/pages/data-flow.md b/docs-src/pages/data-flow.md index d2379b6d..25846ed2 100644 --- a/docs-src/pages/data-flow.md +++ b/docs-src/pages/data-flow.md @@ -9,7 +9,7 @@ description: 'Passing state, events, context' # 🔄 Data Flow
-

Learn how UIElement components can work together seamlessly. Start with simple parent-child relationships, then explore advanced patterns like custom events and shared state. Build modular, loosely coupled components that communicate efficiently.

+

Learn how Le Truc components can work together seamlessly. Start with simple parent-child relationships, then explore advanced patterns like custom events and shared state. Build modular, loosely coupled components that communicate efficiently.

{{ toc }}
@@ -54,7 +54,7 @@ component( The `fromDescendants()` function returns a signal of the reduced array of all matching elements. In contrast to a static `querySelectorAll()` call, the `fromDescendants()` function is reactive and updates whenever new elements are added or removed from the DOM. -Then, we need to convert the total of all product quantities to a string and pass it on to the `BasicButton` component. In UIElement we use the `pass()` function to share state across components: +Then, we need to convert the total of all product quantities to a string and pass it on to the `BasicButton` component. In Le Truc we use the `pass()` function to share state across components: ```js (module-catalog.js) component( @@ -306,7 +306,7 @@ declare global { } ``` -This enables full type checking, autocompletion, and access to UIElement component methods like `.getSignal()` and `.setSignal()`. +This enables full type checking, autocompletion, and access to Le Truc component methods like `.getSignal()` and `.setSignal()`. ### Example: Shopping Cart Events @@ -350,7 +350,7 @@ component( 'itemAdded', ({ event, source, value }) => { // TypeScript knows 'source' is Component - // Can access UIElement methods like source.getSignal('quantity') + // Can access Le Truc methods like source.getSignal('quantity') const newItem = { id: event.detail.id, quantity: event.detail.quantity, @@ -397,7 +397,7 @@ declare global { ### Component Type Safety Best Practices -Each UIElement component should declare its own `HTMLElementTagNameMap` extension: +Each Le Truc component should declare its own `HTMLElementTagNameMap` extension: ```ts // In my-component.ts @@ -424,7 +424,7 @@ declare global { This enables: - **Full type safety** when using signal producers like `fromDescendants('my-component', ...)` -- **Access to UIElement methods** like `.getSignal()` and `.setSignal()` +- **Access to Le Truc methods** like `.getSignal()` and `.setSignal()` - **IntelliSense** for component properties and methods - **Compile-time validation** of component interactions diff --git a/docs-src/pages/examples.md b/docs-src/pages/examples.md index e5231383..26a30cd9 100644 --- a/docs-src/pages/examples.md +++ b/docs-src/pages/examples.md @@ -9,7 +9,7 @@ description: 'Common use cases and demos' # 🍽️ Examples & Recipes
-

Discover practical examples and patterns for building reactive, modular components with UIElement. Each example focuses on showcasing a specific feature or best practice, guiding you through real-world use cases.

+

Discover practical examples and patterns for building reactive, modular components with Le Truc. Each example focuses on showcasing a specific feature or best practice, guiding you through real-world use cases.

{{ toc }}
diff --git a/docs-src/pages/getting-started.md b/docs-src/pages/getting-started.md index 24bfc946..79a21164 100644 --- a/docs-src/pages/getting-started.md +++ b/docs-src/pages/getting-started.md @@ -9,39 +9,39 @@ description: 'Installation, setup, and first steps' # 🚀 Getting Started
-

Set up UIElement in minutes – no build tools required. Or use any package manager and bundler to take advantage of TypeScript support and optimize frontend assets.

+

Set up Le Truc in minutes – no build tools required. Or use any package manager and bundler to take advantage of TypeScript support and optimize frontend assets.

{{ toc }}
-## How to Install UIElement +## How to Install Le Truc -UIElement works **without build tools** but also supports **package managers and bundlers** for larger projects. Choose the option that best fits your needs. +Le Truc works **without build tools** but also supports **package managers and bundlers** for larger projects. Choose the option that best fits your needs. ### Using a CDN -For the easiest setup, include UIElement via a CDN. This is ideal for **testing or quick projects** where you want lightweight interactivity without additional tooling. +For the easiest setup, include Le Truc via a CDN. This is ideal for **testing or quick projects** where you want lightweight interactivity without additional tooling. ```html (page.html) - + ```
-### Self-Hosting UIElement +### Self-Hosting Le Truc -For production use, you may want to **self-host UIElement** to avoid relying on a CDN. You can download the latest version from: +For production use, you may want to **self-host Le Truc** to avoid relying on a CDN. You can download the latest version from: -Github Repository +Github Repository Simply host the file on your server and include it like this: ```html (page.html) - + ``` **Why self-host?** @@ -57,7 +57,7 @@ Remember to keep the hosted file updated to use the latest features and bug fixe ### Installing via Package Managers -If you're using a **bundler** like **Vite, Webpack, or Rollup**, install UIElement via NPM or Bun: +If you're using a **bundler** like **Vite, Webpack, or Rollup**, install Le Truc via NPM or Bun:
@@ -67,14 +67,14 @@ If you're using a **bundler** like **Vite, Webpack, or Rollup**, install UIEleme
```sh ($) -npm install @zeix/ui-element +npm install @zeix/le-truc ```
```sh ($) -bun add @zeix/ui-element +bun add @zeix/le-truc ```
@@ -83,7 +83,7 @@ bun add @zeix/ui-element Then import the needed functions in your JavaScript: ```js (main.js) -import { asString, component, on, setText } from '@zeix/ui-element' +import { asString, component, on, setText } from '@zeix/le-truc' ```
@@ -124,7 +124,7 @@ Save the following inside a ` + + + + @@ -30,237 +20,420 @@ Skip to main content

- UIElement Docs Version 0.14.0 + Le Truc Docs Version 0.14.0

- - - + -
- -

- - 🔗 - 🤝 About - -

-
-

Join the UIElement community! This page covers the people behind UIElement, how you can contribute, versioning details, and licensing. Whether you’re a developer, designer, or sponsor, there are many ways to get involved.

- - - - -
- - -
- -

- - 🔗 - Who's Behind UIElement? - -

-

UIElement is an open-source project, actively developed by Zeix AG, a Switzerland-based agency for User-Centered Design, committed to enhancing accessibility and usability in web technologies.

-

- - 🔗 - Core Team & Contributors - -

- -

- - 🔗 - Sponsors - -

- - -

Become a Sponsor

-

UIElement is free and open-source. If your organization finds it valuable, consider sponsoring its development to help make web development lightweight, accessible, and fun again!

- - -
- -
- -

- - 🔗 - License - -

-

This project is licensed under the MIT License, which means you can use, modify, and distribute it freely – even in commercial projects.

-

A copy of the license can be found in the LICENSE file of the repository.

-
+
+ +

+ + 🔗 + 🤝 About + +

+
+

+ Join the Le Truc community! This + page covers the people behind Le Truc, how you can + contribute, versioning details, and licensing. + Whether you’re a developer, designer, or sponsor, + there are many ways to get involved. +

-
+ + + +
+ -

- - 🔗 - Version History - -

-

- - 🔗 - Current Version: 0.14.0 - -

- +
+

+ + 🔗 + Who's Behind Le Truc? + +

+

+ Le Truc is an open-source project, + actively developed by + Zeix AG, a + Switzerland-based agency for User-Centered Design, + committed to enhancing accessibility and usability in + web technologies. +

+

+ + 🔗 + Core Team & Contributors + +

+
    +
  • + Zeix AG: + @zeixcom – + Maintainers and primary developers +
    • +
  • + Esther Brunner: + @estherbrunner + – Lead developer +
    • +
  • + Fabian Haefliger: + @fabianhaef + – Core team +
    • +
+

+ + 🔗 + Sponsors + +

+ +

Become a Sponsor

+

+ Le Truc is free and open-source. If your + organization finds it valuable, consider + sponsoring its development + to help make web development + lightweight, accessible, and fun + again! +

+ +
-

Release candidate

-

This version is a pre-release of UIElement, meaning breaking changes may still occur before the official release of version 1.0. Please check the release notes before updating.

- +
+

+ + 🔗 + License + +

+

+ This project is licensed under the + MIT License, which means you can + use, modify, and distribute it freely – + even in commercial projects. +

+

+ A copy of the license can be found in the + LICENSE + file of the repository. +

+
-

- - 🔗 - Versioning Scheme - -

-

UIElement follows Semantic Versioning (SemVer), which is structured as MAJOR.MINOR.PATCH.

-
    -
  • MAJOR: Breaking changes that require migrations.
    • -
  • MINOR: New features that are backwards compatible.
    • -
  • PATCH: Bug fixes and performance improvements.
    • -
-

- - 🔗 - Previous Pre-Releases - -

-

View all releases and associated notes on Github Releases.

- +
+

+ + 🔗 + Version History + +

+

+ + 🔗 + Current Version: 0.14.0 + +

+ +

Release candidate

+

+ This version is a pre-release of Le + Truc, meaning breaking changes may + still occur before the official release of version + 1.0. Please check the + release notes + before updating. +

+ -
+

+ + 🔗 + Versioning Scheme + +

+

+ Le Truc follows + Semantic Versioning + (SemVer), which is structured as + MAJOR.MINOR.PATCH. +

+
    +
  • + MAJOR: Breaking changes that + require migrations. +
    • +
  • + MINOR: New features that are + backwards compatible. +
    • +
  • + PATCH: Bug fixes and performance + improvements. +
    • +
+

+ + 🔗 + Previous Pre-Releases + +

+

+ View all releases and associated notes on + Github Releases. +

+
-

- - 🔗 - Getting Involved - -

-

UIElement is an open-source project, and contributions are always welcome! Whether you’re reporting bugs, improving documentation, or suggesting features, here's how you can help:

-
    -
  • Open an Issue – Report bugs or suggest features.
    • -
  • Submit a Pull Request – Help improve UIElement by fixing issues or adding new features.
    • -
  • Join the Discussion – Share ideas and get feedback from the community.
    • -
-

- - 🔗 - Contributing Code - -

-
    -
  • Fork the repository, create a new branch, and submit a pull request.
    • -
  • Read the Contributing Guidelines for setting up a development environment and best practices.
    • -
-

- - 🔗 - Community Guidelines - -

-

We strive for a welcoming and inclusive environment. Please follow our Code of Conduct when contributing.

-
-
+
+

+ + 🔗 + Getting Involved + +

+

+ Le Truc is an open-source project, and + contributions are always welcome! Whether you’re + reporting bugs, improving documentation, or + suggesting features, here's how you can help: +

+
    +
  • + Open an Issue + – Report bugs or suggest features. +
    • +
  • + Submit a Pull Request + – Help improve Le Truc by fixing issues or adding + new features. +
    • +
  • + Join the Discussion – Share ideas and get feedback + from the community. +
    • +
+

+ + 🔗 + Contributing Code + +

+
    +
  • + Fork the repository, create a new branch, and submit + a pull request. +
    • +
  • + Read the + Contributing Guidelines + for setting up a development environment and best + practices. +
    • +
+

+ + 🔗 + Community Guidelines + +

+

+ We strive for a welcoming and inclusive environment. + Please follow our + Code of Conduct + when contributing. +

+
+