Skip to content

Update template-tag-format.md to include info about the JS representation of the runtime compiler #2123

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
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
40 changes: 40 additions & 0 deletions guides/release/components/template-tag-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,46 @@ export default CustomSelect;

This can be a powerful refactoring technique to break up large components into smaller ones. (where it makes sense!)

## Low-level format

All of template-tag format can be represented in it's pure-javascript form using `template` from either `@ember/template-compiler` or `@ember/template-compiler/runtime`.

Creating a template-only component via the runtime compiler:

```gjs
import { template } from '@ember/template-compiler/runtime';

const hello = 'Greetings';

export default template(`{{hello}}`, {
scope: () => ({ hello }),
});
```

And a class-component:

```gjs
import { template } from "@ember/template-compiler";

const message = "Hello there";

class Example extends Component {
static {
template(
"Hello {{message}}",
{
component: this,
scope: () => ({ message }),
},
);
}

}
```

If in an environment with compilation, omitting the `/runtime` at the end of the import allows ahead-of-time compilation to occur on components created with `template()` for better runtime performance.


## Testing

Historically, Ember's integration tests have been written using the `hbs` tagged template literal. This is no longer necessary with the template tag format. Instead, use the `<template>` tag to define a template to render.
Expand Down
Loading