WIP: Set document title on route change

[agubler]

Type: feature

The following has been addressed in the PR:

• There is a related issue
• All code has been formatted with prettier as per the readme code style guidelines
• Unit or Functional tests are included in the PR

Description:

Adds support for setting the document.title on route change. This can be done either statically in the route configuration, a callback passed to the router to dynamically set the title or a combination of the two.

Statically:

routes.ts

export default [
    {
        path: 'foo/{param}?{queryParam}'
        outlet: 'foo',
        title: 'Foo Title'
    }
];

Dynamically on Router initialisation using the setDocumentTitle callback (using the injector registration as an example, but the same can be passed when instantiating a new Router directly):

registerRouterInjector(routes, registry, {
    setDocumentTitle: ({ title, outlet, params, queryParams }) => {
        if (outlet === 'dynamic-title-outlet') {
            return `${outlet}-${params.id}-${queryParams.bar}`;
        }
        return title;
    }
});

Currently the options interface for the setDocumentTitle look like:

export interface DocumentTitleOptions {
	title?: string;
	outlet: string;
	params: Params;
	queryParams: Params;
}

Resolves #601

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 9a0eb5a:

Sandbox	Source
lingering-currying-duxxt	Configuration

[agubler]

superseded by #725