Skip to content

[docs] Update when directive docs to reflect v3 API #1483

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.

Sign up for GitHub

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

Open
julienw wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[docs] Update when directive docs to reflect v3 API #1483

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions packages/lit-dev-content/site/docs/v3/templates/directives.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -474,11 +474,11 @@ import {when} from 'lit/directives/when.js';
<td class="wide-cell">

```ts
when<T, F>(
condition: boolean,
trueCase: () => T,
falseCase?: () => F
)
when<C, T, F = undefined>(
condition: C,
trueCase: (c: Exclude<C, Falsy>) => T,
falseCase?: (c: Extract<C, Falsy>) => F
): C extends Falsy ? F : T
```
</td>
</tr>
Expand All @@ -493,7 +493,7 @@ Any
</tbody>
</table>

When `condition` is true, returns the result of calling `trueCase()`, else returns the result of calling `falseCase()` if `falseCase` is defined.
When `condition` is truthy, returns the result of calling `trueCase()`, else returns the result of calling `falseCase()` if `falseCase` is defined. The (type-narrowed) `condition` value is passed to both case functions.

This is a convenience wrapper around a ternary expression that makes it a
little nicer to write an inline conditional without an else.
Expand All @@ -502,7 +502,7 @@ little nicer to write an inline conditional without an else.
class MyElement extends LitElement {
render() {
return html`
${when(this.user, () => html`User: ${this.user.username}`, () => html`Sign In...`)}
${when(this.user, (user) => html`User: ${user.username}`, () => html`Sign In...`)}
`;
}
}
Expand Down
Loading