/ember-page-title

Page title management for Ember.js Apps

Primary LanguageJavaScriptMIT LicenseMIT

{{title}} Ember Observer Score Build Status Code Climate Test Coverage

This addon provides a helper for changing the title of the page you're on.

Installing via ember-cli

ember install ember-page-title

Post Install Cleanup

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.

Digging in

Visit the Docs site

Fastboot

When working with other addons that use ember-cli-head, you'll need to create a custom head.hbs file that exposes the <title> tag properly:

<title>{{model.title}}</title>

This file is added automatically if you use ember install. This is for all the folks using ember-cli-head addons like ember-cli-meta-tags.

API

attribute type default description
separator string " | " Which separator should be displayed after this instance of {{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:

// config/environment.js
/* jshint node: true */

module.exports = function(environment) {
  var ENV = {
    pageTitle: {
      replace: true
    }
  };

  return ENV;
};

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