This repository has been archived by the owner on May 4, 2022. It is now read-only.
Reflect page title in document title #679
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Splits single variable to one for building up the eventual window title and the other for the name of the portal, which may be a subset of the eventual window title.
setTitle() doesn't need to consider whether isWeb, all that matters is whether the app title is redundant with the name of the portal from the theme.
Arguably since the true branch here is the exception rather than the rule it should be second in the conditional, but seems more important to remove the ! in the condition to reduce cognitive load in understanding the condition.
setTitle() doesn't just need there to be an active theme, it needs that theme to have a .title
Fall back on local name of app as entire window title.
Edit for brevity. Prefer "for example" over "e.g.".
Makes setTitle() more clearly read as the algorithm it is implementing.
components/portal/main/services.js
Outdated
| } | ||
|
|
||
| // if there's a page name not redundant with the app name, prepend it. | ||
| if (pageTitle && pageTitle !== '' && pageTitle !== appTitle) { |
There was a problem hiding this comment.
if (pageTitle && pageTitle !== appTitle) { Should be enough, check the If() tab here: https://dorey.github.io/JavaScript-Equality-Table/
components/portal/main/services.js
Outdated
| var appTitle = ''; // the name of the app | ||
|
|
||
| if ($rootScope.portal && $rootScope.portal.theme && | ||
| $rootScope.portal.theme.title) { |
There was a problem hiding this comment.
if we want to do something with the theme title, we should pass it in via parameters. $rootScope or even $scope shouldn't bleed out to services
Order the tests in the mainService setTitle spec to match the order of examples in the setTitle function doc
Use test description to document the bigger picture of each test rather than literally how it tests it.
Match more literally what the test cases test with the examples given in the function doc.
Actually touch the document.title (view) from Controller. Compute the desired title (implement the rule) in the Service.
Hacky "solution", with a no-content div using evaluation of the value of a made-up attribute to call the AppHeaderOptionsController to set the title.
vertein
reviewed
Jan 30, 2018
| @@ -33,6 +33,26 @@ define(['angular', 'require'], function(angular, require) { | |||
| layoutMode: 'list', // other option is 'widgets | |||
| }; | |||
|
|
|||
| /** | |||
| * Set Document title. | |||
| */ | |||
There was a problem hiding this comment.
I see that we call updateTitle with no param later in this file. Maybe a comment on what happens when no param is called? What happens with the parameter?
vertein
approved these changes
Feb 1, 2018
ChristianMurphy
approved these changes
Feb 1, 2018
| * Set Document title. | ||
| * Asks mainService what the document title ought to be and | ||
| * sets the document title to that value. | ||
| * @param {string} pageTitle - Optional, name of specific page viewed. |
There was a problem hiding this comment.
🎨 jsDoc syntax for optional is
/** @param {string} [pageTitle] - name of specific page viewedreference: http://usejsdoc.org/tags-param.html#optional-parameters-and-default-values
thevoiceofzeke
approved these changes
Feb 1, 2018
ChristianMurphy
approved these changes
Feb 1, 2018
|
This framework change seems to have worked out well in
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose:
uPortal-app-frameworkapplication as the user navigates within the application, thereby enabling improving usability generally and fulfillingWCAG2: 2.4.2specifically (Page Titled: Web pages have titles that describe topic or purpose. (Level A)).Done:
mainService, implementing our (goofy?) "rule" about page naming, e.g.PageName | AppName | PortalName, with oodles of failing gracefully, and unit testing.PortalMainController, relying uponmainServiceto compute the title and only gathering the inputs and doing the view (Document) modification in the controller layer. This continues to mutate document title on theme change, since theme change can mean a change in portal name. Unit tests the initial document title setting.AppHeaderOptionsController, with unit test.app-headerdirective calls the title setting inAppHeaderOptionsControllerto set the document title reflecting the title in the app header, which in some contexts corresponds to what the user would regard as the "page title" (and failing that, at least reflects the name of the app).Deferred:
PortalMainControllerreacting to theme change by resetting document title. (This changeset didn't introduce this feature and hasn't so far as I can tell broken it.)app-headerdirective (didn't get to figuring out how to test directives and that directive is moribund.)app-headerdirective ( WIP: Remove app header #682 ). Will have to face down what that bigger change means for setting the Document title in the course of that bigger change.Resolves #654 .
Contributor License Agreement adherence: