Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes various minor issues around the documentation #916

Merged
merged 2 commits into from
Nov 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -982,7 +982,7 @@ class Combobox<E : HTMLElement, T>(tag: Tag<E>, id: String?) : Tag<E> by tag, Op
*
* val results: Flow<QueryResult.ItemList<T>>
*
* // state.render {
* // results.render {
* // for each QueryResult.ItemList<T>.Item<T> {
* comboboxItem(Item<T>) { }
* // }
Expand All @@ -994,7 +994,7 @@ class Combobox<E : HTMLElement, T>(tag: Tag<E>, id: String?) : Tag<E> 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 <E : HTMLElement, T> RenderContext.combobox(
classes: String? = null,
Expand Down Expand Up @@ -1054,7 +1054,7 @@ fun <E : HTMLElement, T> RenderContext.combobox(
*
* val results: Flow<QueryResult.ItemList<T>>
*
* // state.render {
* // results.render {
* // for each QueryResult.ItemList<T>.Item<T> {
* comboboxItem(Item<T>) { }
* // }
Expand All @@ -1066,7 +1066,7 @@ fun <E : HTMLElement, T> 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 <T> RenderContext.combobox(
classes: String? = null,
Expand Down
4 changes: 2 additions & 2 deletions www/src/pages/docs/30_Render HTML.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|-----------------------------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------|-------------|
Expand Down Expand Up @@ -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.
Expand Down
18 changes: 9 additions & 9 deletions www/src/pages/headless/combobox.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -406,7 +406,7 @@ combobox<T> {

val results: Flow<QueryResult.ItemList<T>>

// state.render {
// results.render {
// for each QueryResult.ItemList<T>.Item<T> {
comboboxItem(Item<T>) { }
// }
Expand Down Expand Up @@ -463,7 +463,7 @@ Parameters: `classes`, `scope`, `tag`, `initialize`

Default-Tag: `label`

### listboxValidationMessages
### comboboxValidationMessages

Available in the scope of: `combobox`, `comboboxPanelReference`

Expand Down
Loading