Skip to content

Commit

Permalink
Add note about Yields else to README
Browse files Browse the repository at this point in the history
  • Loading branch information
wagenet committed Apr 20, 2021
1 parent 1926aff commit 3d1f097
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ While GlimmerX components accept `Args` as a type parameter, the Glint version a
The `Element` field declares what type of element(s), if any, the component applies its passed `...attributes` to. This is often the component's root element. Tracking this type ensures any modifiers used on your component will be compatible with the DOM element(s) they're ultimately attached to. If no `Element` is specified, it will be a type error to set any HTML attributes when invoking your component.

The `Yields` field specifies the names of any blocks the component yields to, as well as the type of any parameter(s) they'll receive. See the [Yieldable Named Blocks RFC] for further details.
(Note that the `inverse` block is an alias for `else`. These should be defined in `Yields` as `else`, though `{{yield to="inverse"}}` will continue to work.)

```ts
import Component from '@glint/environment-glimmerx/component';
Expand Down

0 comments on commit 3d1f097

Please sign in to comment.