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 [
    {
        id: 'foo',
        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, id, params, queryParams }) => {
        if (outlet === 'dynamic-title-outlet') {
            return `${id}-${params.id}-${queryParams.bar}`;
        }
        return title;
    }
});

Currently the options interface for the setDocumentTitle look like:

export interface DocumentTitleOptions {
	title?: string;
	id: 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 07bae60:

Sandbox	Source
runtime-grass-kxg1s	Configuration

[codecov]

Codecov Report

Merging #725 into master will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master     #725   +/-   ##
=======================================
  Coverage   97.78%   97.78%           
=======================================
  Files         121      121           
  Lines        7052     7058    +6     
  Branches     1603     1606    +3     
=======================================
+ Hits         6896     6902    +6     
  Misses        156      156           

Impacted Files	Coverage Δ
src/routing/Router.ts	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 74e5e4e...07bae60. Read the comment docs.