Skip to content

Commit

Permalink
chore: adds lion-select docs about the repeat directive
Browse files Browse the repository at this point in the history
  • Loading branch information
thatdudemanguy authored and tlouisse committed Nov 6, 2024
1 parent cc2a646 commit 1d2ab38
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions docs/components/select/use-cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,63 @@ Or by setting the `disabled` attribute on the entire `lion-select` field.
## Validation

A validator can be used to make it e.g. `required`. If you want to know how to do that, please take a look at our [validation examples](../../fundamentals/systems/form/validate.md).

## Rendering and updating select options

A very common pattern is to keep the options in an array, and render them through a repeating template.

```js
import { html, LitElement } from 'lit';

class MyOptions extends LitElement {
static properties = {
colours: Array,
};

constructor() {
super();

this.colours = ['red', 'hotpink', 'teal'];
}

render() {
return html`
<lion-select name="favoriteColor" label="Favorite color" disabled>
<select slot="input">
<option selected hidden value>Please select</option>
${this.colours.map(colour => html`<option value="${colour}">${colour}</option>`)}
</select>
</lion-select>
`;
}
}
```

Using the above method to build repeating templates is usually efficient. However, there are cases where you might want to update the list of options after an option has already been selected.

For example, if we add a button to sort the array alphabetically, pressing it would update the list. However, the selected state and index would not reset or update accordingly.

Lit is intelligent and updates the DOM with minimal effort. During a rerender, it only updates the values inside the template and doesn't check state values outside the template, such as the selected item from the parent element.

So, if the first option was selected, the newly selected option would be whatever ends up in that position after sorting. This creates a confusing user experience where a seemingly random value is selected.

The Lit `repeat` directive fixes this problem by attaching a unique ID to each DOM element using an item as the identifier, `colour` in our example. Any changes will then result in a complete rerender or reordering of the DOM nodes, rather than just changing the values of those nodes.

```js
import { repeat } from 'lit/directives/repeat.js';

render() {
return html`
<lion-select name="favoriteColor" label="Favorite color" disabled>
<select slot="input">
<option selected hidden value>Please select</option>
${repeat(
this.colours,
(colour) => colour,
(colour, index) => html`<option value="${colour}">${colour}</option>`
)}
</select>
</lion-select>
`;
}
```

0 comments on commit 1d2ab38

Please sign in to comment.