Problem/Motivation

Now that Claro has been added to Drupal core in #3079738: Add Claro administration theme to core, we can make it the default admin theme in the Umami demo profile.

Proposed resolution

I think that the only changes needed will be in the directory core/profiles/demo_umami/config/install/. There seem to be nine files in this directory that include "seven": check with grep -il seven *.yml. There are eight files block.block.seven_*.yml and system.theme.yml.
You also need to update demo_umami.info.yml which is in the root of the demo_umami directory, and replace "seven" with "claro" in the themes key.

You can try editing and renaming these files, replacing "seven" with "claro". Then import the configuration, or re-install Drupal with the modified Umami profile. It might be safer, and perhaps easier, to

  1. Install Drupal with the Umami demo profile.
  2. Export the configuration. Stage and perhaps commit the changes to git.
  3. Enable Claro and set it as the admin theme.
  4. Export the configuration. See what has changed.
  5. Copy any new and changed files to core/profiles/demo_umami/config/install/.
  6. Remove the UUID and _core.default_config_hash lines from the new and changed files.

Remaining tasks

User interface changes

When using the Umami demo profile, admin users will see the Claro theme instead of Seven:

Screenshot showing a Recipe page being edited with the Claro admin theme

API changes

None

Data model changes

None

Comments

benjifisher created an issue. See original summary.

benjifisher’s picture

Issue tags: +Novice
markdorison’s picture

Status: Active » Needs work
StatusFileSize
new6.18 KB

I took a first pass at this but am getting an error during site configuration.

The website encountered an unexpected error. Please try again later.
Drupal\Core\Config\UnmetDependenciesException: Configuration objects provided by <em class="placeholder">demo_umami</em> have unmet dependencies: <em class="placeholder">block.block.claro_breadcrumbs (claro)</em> in Drupal\Core\Config\UnmetDependenciesException::create() (line 98 of core/lib/Drupal/Core/Config/UnmetDependenciesException.php).
Drupal\Core\Config\UnmetDependenciesException::create('demo_umami', Array) (Line: 509)
Drupal\Core\Config\ConfigInstaller->checkConfigurationToInstall('module', 'demo_umami') (Line: 132)
Drupal\Core\ProxyClass\Config\ConfigInstaller->checkConfigurationToInstall('module', 'demo_umami') (Line: 161)
Drupal\Core\Extension\ModuleInstaller->install(Array, ) (Line: 83)
Drupal\Core\ProxyClass\Extension\ModuleInstaller->install(Array, ) (Line: 1645)
install_install_profile(Array) (Line: 703)
install_run_task(Array, Array) (Line: 578)
install_run_tasks(Array, NULL) (Line: 117)
install_drupal(Object) (Line: 44)
johnwebdev’s picture

#3

You also need to update demo_umami.info.yml and replace

themes:
  - seven
  - umami

seven with claro.

And then you need to update: system.theme.yml.

benjifisher’s picture

@markdorison, what did you do that led to those errors? Did you try editing the YAML files directly or did you follow the steps 1-5 in the issue description?

@johndevman, can you update the issue description to mention the .info.yml file?

johnwebdev’s picture

Issue summary: View changes
johnwebdev’s picture

Issue summary: View changes
shaal’s picture

Thank you for doing this work. Please let me know if I can help you with it. I would use the instructions @benjifisher, and add step 6, to delete the 3 lines that are coming from config-export, but are not needed in the install process (UUID).

One thing to note, according to OOTB Umami's current "rules", Claro will not be enabled by default until Claro becomes stable in core, but it will be great to have a patch for whenever it's ready.

markdorison’s picture

Status: Needs work » Needs review
StatusFileSize
new7.03 KB
new1.34 KB

@johndevman Thanks for the additional tips.

New patch installs Unami with Claro as expected in my testing.

benjifisher’s picture

Issue summary: View changes
Status: Needs review » Needs work

Thanks to everyone for jumping on this! And thanks to @shaal for pointing out that we will have to wait for Claro to be stable before this issue is committed. I will add Step 6 to the issue description, as suggested in #8.

Looking at the patch, I see one thing that look suspicious.

--- /dev/null
+++ b/core/profiles/demo_umami/config/install/claro.settings.yml
@@ -0,0 +1,3 @@
+third_party_settings:
+  shortcut:
+    module_link: true

I guess that file gets added when you export configuration. I think we do not want it as part of this issue, unless something breaks when we remove it.

shaal’s picture

Status: Needs work » Reviewed & tested by the community
StatusFileSize
new307 KB

@benjifisher if we won't add that claro.settings.yml I am afraid Drupal CI tests will fail, because it seems to be comparing Umami's install configuration with the exported config of Umami installation.

Patch #9 works great!
RTBC :)

shaal’s picture

Status: Reviewed & tested by the community » Postponed

As I mentioned earlier, unfortunately, this patch will have to wait as "Postponed", until Claro becomes stable in core.

Thank you for the great work!!

benjifisher’s picture

Issue summary: View changes

@shaal, +1 for the RTBC/Postponed status.

if we won't add that claro.settings.yml I am afraid Drupal CI tests will fail

Do you know which test fails? That file has nothing to do with Seven vs. Claro as the admin theme, so I do not know why the test would pass without this issue and fail after applying the patch (if we remove that file).

Thanks for the screenshot. I will add it to the issue summary.

mradcliffe’s picture

Issue tags: -Novice

Removes the novice tag until unpostponed.

webchick’s picture

Version: 8.9.x-dev » 9.0.x-dev

A thought (which, credit to @lauriii on the thought). WHAT IF we were to make this the one and only UI change between Drupal 8.9 and Drupal 9.0?

Pros:

  • At least one strong visual change between 8 and 9 (ooh, la la!)
  • Makes our "best foot forward" install profile look even slicker
  • Shows evaluators the "vision" of where we plan to go with the admin experience

Cons:

  • Claro is still only beta stability, and there was previous agreement among Umami maintainers to not put beta stuff in the profile so as not to mislead people what they could run on production (then again, this is "only" look and feel vs. something fundamentally different UX-wise like image vs. media... not sure this makes a difference tho)
  • Claro might not be ready for that level of showing off yet? (I don't know this for sure and would need to play around with it some)

Thoughts? :)

xjm’s picture

From a maintenance perspective, I'm not sure if diverging 8.9 and 9.0 in this way is a good idea. I think what we actually want is a visual change between 8.8 and 9.0, and 8.9 is a maintenance implementation detail.

That said, I do think using Claro in 9.0 (and 8.9) is worth considering, since there's no data upgrade paths or APIs to worry about. Claro (like all user-facing core themes) is internal even once it's stable.

shaal’s picture

I rerolled patch #9
(no interdiff)

webchick’s picture

Status: Postponed » Needs review

Bumping this up to needs review since there is something to review.

effulgentsia’s picture

I think a good next step here would be to review the list of unfinished items from #3066007: Roadmap to stabilize Claro and decide which of those we would want to have done before making it Umami's admin theme. For example:

  • Does Umami include interacting with the Media Library in the admin theme? If so, then we might want #3062751: Media and media library to be a requirement to get done first.
  • Do we consider accessibility in Umami to be critical? In which case, some of those accessibility issues might need to be requirements as well.
  • ...

However, I like the idea that we don't necessarily need all of #3066007: Roadmap to stabilize Claro completed before making it Umami's admin theme.

webchick’s picture

Well, I think one of the very first steps before that might be to convince the Umami maintainers that this is a good idea to do in the first place. :)

Traditionally, the stance has been "stable features only" because we don't want to create a semblance of false advertising/"smoke and mirrors" with our demo. ("Look at all this WONDERFUL stuff... which you CAN'T actually use yet in the real world! MWAHAHAHAHA!")

For an experimental module, there are also possible upgrade path implications, significant workflow changes between what's possible and not possible with production-level software (e.g. imagefields vs. media + media library, boring blocks vs. layout builder), and so on. All good reasons to take the stance "not until stable" for modules.

For a theme, however, it's visual changes on top of existing functionality only. There's no upgrade path, no external-facing API. The risk therefore seems much lower. IMO it's worth at least talking about whether or not to treat those two things differently...

xjm’s picture

This is still a possibility for 9.0 given Umami's "ever-experimental" status under policy, but I do see the case for postponing it until Claro is stable.

markconroy’s picture

From a visual point of view, having gone through the Umami website using Claro as the admin theme, it looks stable enough to me that we could add it to Umami. I like @webchick's point:

For a theme, however, it's visual changes on top of existing functionality only

However, there are a number of a11y issues that need to be fixed for Claro to become stable and I'm quite nervous about the idea that we might have a theme set in our profile that is less accessible than what we currently have (albeit only temporarily while those issues get fixed).

Because of this, I think we should also ask the a11y team if they think Claro is "good enough" for Umami or if we need to wait until some more of the a11y issues are fixed, and not have it as an Umami maintainers-only issue.

benjifisher’s picture

@markconroy:

Have you brought this up with the a11y team (e.g., by mentioning it on the #accessibility channel)?

I am adding the issue tag in the hope of getting some attention.

markconroy’s picture

Thanks for adding that tag @benjifisher

It'd be nice to see this issue moving along towards getting committed.

Ruchi Joshi’s picture

StatusFileSize
new242.14 KB
new48.83 KB

@benjifisher- Tested for Drupal 9.1 with patch#17. Claro is enabled as default admin theme. This can be moved to "Reviewed & Tested by Community".

markconroy’s picture

Hi @Ruchi Joshi

Thanks for testing this. However, this cannot be marked as RTBC unless the accessibility team are happy to sign off while there are still some open accessibility issues.

See comment #22 for details.

webchick’s picture

Are we certain that Claro as it currently stands, accessibility issues and all, is actually less accessible than Seven? I have my doubts. The Claro team has done a tremendous job from what I've seen ensuring things like focus styles, colour contrast, etc. are cared for.

effulgentsia’s picture

Assigned: Unassigned » dyannenova

@DyanneNova has been recently reviewing Claro's accessibility and I think has encountered some accessibility issues in Claro that are worse than in Seven. Assigning this to her to get that list posted here.

dyannenova’s picture

Assigned: dyannenova » Unassigned

I did find cases where Seven is more accessible than Claro in Windows High Contrast mode. There are child issues for all of the discovered High Contrast issues here: #3080100: Assess accessibility of Claro in High Contrast AKA forced colors mode

markconroy’s picture

Hi @DyanneNova

Thanks for the comment. Based on it, do you have an opinion on whether we could/should start using Claro as our base theme? Are the issues where Seven is more accessible than Claro only affecting users in Windows High Contrast mode, or are the other issues where we think Seven is outdoing Claro to such a degree that it would not be beneficial to add Claro as our admin theme for Umami just yet?

Thanks again.

Version: 9.0.x-dev » 9.1.x-dev

Drupal 9.0.10 was released on December 3, 2020 and is the final full bugfix release for the Drupal 9.0.x series. Drupal 9.0.x will not receive any further development aside from security fixes. Sites should update to Drupal 9.1.0 to continue receiving regular bugfixes.

Drupal-9-only bug reports should be targeted for the 9.1.x-dev branch from now on, and new development or disruptive changes should be targeted for the 9.2.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

markconroy’s picture

From looking at the remaining issues in Claro, which seem relatively small, I think at this stage I'd support enabling Claro as the admin theme for Umami. I certainly don't think the experience of using Claro's would be any less enjoyable than the experience of using Seven.

Anyone got any strong opinion for or against this idea?

benjifisher’s picture

In #29, @DyanneNovareferenced the meta issue #3080100: Assess accessibility of Claro in High Contrast AKA forced colors mode. I just checked, and that issue has 6 children: is is fixed, and the others are NR. A couple have been waiting for review since October.

Personally, I would like to see this issue go in, but I do not think we should do it until the a11y are addressed. I am not sure I am qualified to review those child issues. Maybe you can help with that, @markconroy.

I am adding the meta issue as related to this one.

shaal’s picture

My 2 cents - Claro includes SO many improvements over Seven.
It might have a few edge cases that need to be fixed, but AFAIK there are only a few issues like that.

markconroy’s picture

Does Seven do _anything_ for Windows High Contrast mode? If not, and Claro does (even if not perfect yet), then I'd see that as another push for Claro.

I agree with @shaal - it's a huge improvement on Seven and what we currently have, and the issues it still has are much more edge cases than "OMG this site is unusable" cases.

markconroy’s picture

Status: Needs review » Reviewed & tested by the community

I"m going to mark this as RTBC. I think Claro is a great theme, much better than what we have with Seven, and the small few outstanding issues are less concerning the the outstanding issues of Seven.

That and the fact that the OOTB maintainers all seem to agree we would like Claro enabled, and there doesn't seem to be much disagreement from the a11y team.

effulgentsia’s picture

I'm not an accessibility expert, but just by reading what's in the issue summaries of the child issues of #3080100: Assess accessibility of Claro in High Contrast AKA forced colors mode, I think #3171726: Claro Shortcuts star fails WCAG Use of Color and Non-text contrast is an actual accessibility regression as compared to Seven, and #3194669: Misuse of explicit colour for active pager item in -ms-high-contrast media query might be too, though I'm less confident about that. The other child issues of #3080100: Assess accessibility of Claro in High Contrast AKA forced colors mode just say "needs improvement" in their title, so either aren't regressions relative to Seven or just have meek issue titles.

I'm not necessarily recommending that we hold up an Umami improvement on 1 or 2 or 6 regressions for people using High Contrast, especially when Claro improves on accessibility relative to Seven in other areas, so leaving this RTBC.

catch’s picture

Seems like webchick was broadly in favour of this before, but tagging for product review too.

markconroy’s picture

Thanks @effulgentsia. The only issue there that looks like an actual regression is the shortcut star not having as high a contrast ratio as we currently have (though it's very close). I'd hate to hold this up on something so small, given all the other benefits Claro brings.

webchick’s picture

From a Product Management POV, this is a slam dunk. It improves the admin theme far beyond the current status quo, it gets the theme out in front of more people which hopefully leads to more steam behind closing the remaining issues (and/or finding ones we missed), but it does so in a way that does not impact the default Drupal experience or any existing sites. With only one a11y regression compared to Seven, it feels like this would be a net improvement in accessibility, vs. a detraction.

However, I'm not an expert in these matters. So I pinged in #accessibility to ask some folks to chime in here. https://drupal.slack.com/archives/C2ANFUGGG/p1621009480123300

lauriii’s picture

Status: Reviewed & tested by the community » Needs review

Moving to needs review since this needs input from the accessibility maintainers.

Version: 9.1.x-dev » 9.3.x-dev

Drupal 9.1.10 (June 4, 2021) and Drupal 9.2.10 (November 24, 2021) were the last bugfix releases of those minor version series. Drupal 9 bug reports should be targeted for the 9.3.x-dev branch from now on, and new development or disruptive changes should be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

benjifisher’s picture

Version: 9.3.x-dev » 9.4.x-dev
Status: Needs review » Reviewed & tested by the community

Now that #3277053: Mark Claro as Stable has landed, there is no reason to put off this issue. RTBC

I just installed 9.4.x with the patch from #17, and it works as expected. I exported configuration and compared to the original, and the only changes were core hashes and UUIDs.

The testbot will do a more thorough job.

ckrina’s picture

Removing the Needs Accessibility tag because Claro is stable now.

  • ckrina committed 759f9c5 on 10.0.x
    Issue #3087701 by markdorison, shaal, Ruchi Joshi, benjifisher,...

  • ckrina committed 9641844 on 9.4.x
    Issue #3087701 by markdorison, shaal, Ruchi Joshi, benjifisher,...
ckrina’s picture

Status: Reviewed & tested by the community » Fixed

Committed 759f9c5 and pushed to 10.0.x and 9.4.x. Thanks everybody! 🎉

gábor hojtsy’s picture

Issue tags: +Portland2022
xjm’s picture

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.