Skip to content

Fix missing macroGetOwnConfig description #622

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

Merged
ef4 merged 1 commit into from
May 8, 2020
Merged

Fix missing macroGetOwnConfig description #622

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
23 changes: 21 additions & 2 deletions text/0000-embroider-v2-package-format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -632,6 +632,25 @@ If you don't pass any arguments, you can get the whole thing (although this make
<SomeComponent @config={{hash items=(array (hash score=42))}} />
```

### Handlebars Macro: macroGetConfig

The equivalent of the `getConfig` JS macro as a Handlebars helper. Given a dependency `ember-score` exposes this config:

```json
{
"items": [{ "score": 42 }]
}
```

Then:

```hbs
<SomeComponent @score={{macroGetConfig "ember-score" "items" 0 "score" }} />
{{! ⬆️compiles to ⬇️ }}
<SomeComponent @score={{42}} />
```


### Handlebars Macro: macroCondition

Used as a helper within a block `{{#if}}` or inline `{{if}}`. Just like the JS `macroCondition`, it ensures that branch elimination will happen.
Expand Down Expand Up @@ -668,7 +687,7 @@ There is one place where `{{#if}}` doesn't work: within "element space". If you
`macroMaybeAttrs` exists to conditionally compile away attributes and arguments out of element space:

```hbs
<div {{macroMaybeAttrs (getConfig "ember-test-selectors" "enabled") data-test-target=@id }} />
<div {{macroMaybeAttrs (macroGetConfig "ember-test-selectors" "enabled") data-test-target=@id }} />
```

It can be placed on both HTML elements and angle bracket component invocations.
Expand All @@ -678,7 +697,7 @@ It can be placed on both HTML elements and angle bracket component invocations.
Like the JS `failBuild` macro.

```hbs
{{#if (macroCondition (dependencySatisfies "some-peer-dep" "^3.0.0")) }}
{{#if (macroCondition (macroDependencySatisfies "some-peer-dep" "^3.0.0")) }}
<UseTheThing />
{{else}}
{{macroFailBuild "You tried to use <MyFancyComponent/> but it requires some-peer-dep ^3.0.0"}}
Expand Down