ember-page-title
This addon provides a helper for changing the title of the page you're on.
Installing via ember-cli
ember install ember-page-title
Compatibility
- Ember.js v3.16 or above
- Ember CLI v2.13 or above
- Node.js v10 or above
Fastboot vs Non-Fastboot Notes
Post Install Setup Notes
As of v3.0.0 this addon maintains the page title by using the <title>
tag in your document's <head>
. This is necessary for FastBoot compatibility.
Non-fastboot apps should keep the <title>
tag in index.html to ensure that the initial page is valid HTML. The title will be removed and replaced when your app boots.
Fastboot apps MUST remove the <title>
tag from index.html. As of v6.0.0 this is done automatically if you use ember install ember-page-title
to install this addon. Can also be run manually using ember g ember-page-title
to update the title if FastBoot is installed.
Digging in
Visit the Docs site
API
{{page-title}}
Helper
attribute | type | default | description |
---|
separator | string | " | " | Which separator should be displayed after this instance of {{page-title}} |
prepend | boolean | true | If the token should be prepended or appended to the list of tokens |
replace | boolean | false | Replace all previous elements with the active |
front | boolean | false | If the token should always be in the beginning of the resulting title. |
These defaults are configurable in config/environment.js
:
module.exports = function (environment) {
let ENV = {
pageTitle: {
replace: true,
},
};
return ENV;
};
Deprecations
- Since v5.2.2: The
{{title}}
helper has been deprecated, use {{page-title}}
instead, it has the same API. The
{{title}}
helper was an AST transform and was removed in v6.0.0.
Upgrading notes for 5.x to 6.x
ember-page-title
no longer requires the usage of ember-cli-head
.
Please remove {{head-layout}}
from your application's application.hbs
route template.{{title}}
has been removed, please rename to {{page-title}}
.
Upgrading notes for 3.x to 4.x
From 4.x onward, you need to have {{head-layout}}
within your application's application.hbs
template. Without this, you will not see a page title appear.
See the 4.0.0 release notes for more detail.
Contributing
Contributors are welcome! Please provide a reproducible test case. Details will be worked out on a case-per-case basis. Maintainers will get in touch when they can, so delays are possible. For contribution guidelines, see the code of conduct.
Publishing Documentation
To publish documentation, run the following command:
ember github-pages:commit --message "update documentation"
git push origin gh-pages:gh-pages