From b25f63049e70fcdc061dec24a2078aca67881dc1 Mon Sep 17 00:00:00 2001 From: Hauke Sommerfeld Date: Tue, 12 Nov 2024 09:59:57 +0100 Subject: [PATCH 1/2] Documentation: Fixes broken link in the 'Render HTML' section Closes #905 --- www/src/pages/docs/30_Render HTML.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/www/src/pages/docs/30_Render HTML.md b/www/src/pages/docs/30_Render HTML.md index 95a88a9cb..9b53d1ba1 100644 --- a/www/src/pages/docs/30_Render HTML.md +++ b/www/src/pages/docs/30_Render HTML.md @@ -271,7 +271,7 @@ Based upon the `data`-property, which provides a `Flow` of the store's generic d There is one more `renderEach` variant which is defined as an extension to a `Store` instead of a `Flow`. This special variant and its application are described in the -[chapter about store mapping](/docs/storemapping/#reactive-rendering-of-lists-of-entities-with-automatically-mapped-element-store). +[chapter about store mapping](/docs/storemapping/#reactive-rendering-of-entity-lists-with-auto-mapped-element-store). | Render-Function | Additional parameters | Description | Default Tag | |-----------------------------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------|-------------| @@ -536,7 +536,7 @@ As the identity is stable, the following properties hold for the rendered items: The latter is an important aspect to consider before the use of `renderEach` for entities. If you still need to reflect changes to the data within an entity and want to apply precise rendering, use this application of `renderEach`, but add additional mount-points inside the elements subtrees. You will learn about those in the -[chapter about store mapping](/docs/storemapping/#reactive-rendering-of-lists-of-entities-with-automatically-mapped-element-store). +[chapter about store mapping](/docs/storemapping/#reactive-rendering-of-entity-lists-with-auto-mapped-element-store). Otherwise, it might be a better choice to stick to the default `renderEach` application relying on equality. Have a look at its application in our [todomvc](/examples/todomvc/) example. From 396d14fda0867b617ca1eb7a9e8019caa6564b3c Mon Sep 17 00:00:00 2001 From: Hauke Sommerfeld Date: Tue, 12 Nov 2024 10:10:33 +0100 Subject: [PATCH 2/2] Fixes various documentation errors around the combobox Things that are fixed: - API-sketch (was out of sync with the actual code) - broken links - brick names in the actual documentation Closes #904 --- .../dev/fritz2/headless/components/combobox.kt | 8 ++++---- www/src/pages/headless/combobox.md | 18 +++++++++--------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/headless/src/jsMain/kotlin/dev/fritz2/headless/components/combobox.kt b/headless/src/jsMain/kotlin/dev/fritz2/headless/components/combobox.kt index 2b26047ef..1fcd8f0a5 100644 --- a/headless/src/jsMain/kotlin/dev/fritz2/headless/components/combobox.kt +++ b/headless/src/jsMain/kotlin/dev/fritz2/headless/components/combobox.kt @@ -982,7 +982,7 @@ class Combobox(tag: Tag, id: String?) : Tag by tag, Op * * val results: Flow> * - * // state.render { + * // results.render { * // for each QueryResult.ItemList.Item { * comboboxItem(Item) { } * // } @@ -994,7 +994,7 @@ class Combobox(tag: Tag, id: String?) : Tag by tag, Op * } * ``` * - * For more information refer to the [official documentation](https://www.fritz2.dev/headless/listbox/#listbox) + * For more information refer to the [official documentation](https://www.fritz2.dev/headless/combobox/) */ fun RenderContext.combobox( classes: String? = null, @@ -1054,7 +1054,7 @@ fun RenderContext.combobox( * * val results: Flow> * - * // state.render { + * // results.render { * // for each QueryResult.ItemList.Item { * comboboxItem(Item) { } * // } @@ -1066,7 +1066,7 @@ fun RenderContext.combobox( * } * ``` * - * For more information refer to the [official documentation](https://www.fritz2.dev/headless/listbox/#listbox) + * For more information refer to the [official documentation](https://www.fritz2.dev/headless/combobox/) */ fun RenderContext.combobox( classes: String? = null, diff --git a/www/src/pages/headless/combobox.md b/www/src/pages/headless/combobox.md index 3cb8b99d1..21cbe020b 100644 --- a/www/src/pages/headless/combobox.md +++ b/www/src/pages/headless/combobox.md @@ -259,7 +259,7 @@ comboboxItems { ## Positioning `comboboxItems` is a [`PopUpPanel`](#floating-content---popuppanel) and therefore provides a set of -configuration options to control the position or distance of the list box from the `listboxButton` +configuration options to control the position or distance of the list box from the `comboboxButton` as a reference element: ```kotlin @@ -322,12 +322,12 @@ Clicking on an item when the list is open selects it and closes the list. ## Keyboard Interaction -| Command | Description | -|:----------------------------------------------|:-------------------------------| -| [[⬆]] [[⬇]] when listbox is open | Activates previous / next item | -| [[Home]] [[End]] when listbox is open | Activates first / last item | -| [[Esc]] when listbox is open | Closes the combobox | -| [[Enter]] [[Space]] when the combobox is open | Selects the active item | +| Command | Description | +|:-------------------------------------------------|:-------------------------------| +| [[⬆]] [[⬇]] when the combobox is open | Activates previous / next item | +| [[Home]] [[End]] when the combobox is open | Activates first / last item | +| [[Esc]] when the combobox is open | Closes the combobox | +| [[Enter]] [[Space]] when the combobox is open | Selects the active item | ## Performance @@ -406,7 +406,7 @@ combobox { val results: Flow> - // state.render { + // results.render { // for each QueryResult.ItemList.Item { comboboxItem(Item) { } // } @@ -463,7 +463,7 @@ Parameters: `classes`, `scope`, `tag`, `initialize` Default-Tag: `label` -### listboxValidationMessages +### comboboxValidationMessages Available in the scope of: `combobox`, `comboboxPanelReference`