-
Notifications
You must be signed in to change notification settings - Fork 56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: hide unimplemented dark mode for v5.3.0 #2044
Conversation
✅ Deploy Preview for boosted ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Kudos, SonarCloud Quality Gate passed! 0 Bugs No Coverage information |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we remove all the references to data-bs-theme="*"
and color mode
in the doc ? (https://deploy-preview-2044--boosted.netlify.app/docs/5.3/components/navbar/#external-content, https://deploy-preview-2044--boosted.netlify.app/docs/5.3/components/navbar/#color-schemes, https://deploy-preview-2044--boosted.netlify.app/docs/5.3/migration/). Imo it could be a bit weird to reference something that people can't use.
Should we really keep the import of variables-dark.scss
? Imo it could be hidden in the doc since we disable it via $enable-dark-mode: false
ass you mention. I don't know the way people are using Boosted but it seems like Bootstrap has some trouble with it, so maybe we can retain it for now and see ?
In the scss, I think we are fine since it doesn't impact the bundle if the $enable-dark-mode
is set to false
. The main things are in the docs CSS.
For the color-mode experience, I agree that we might need a callout on the color modes page but maybe we can add an informative callout that it'll come until v5.4 or asap or something ? Otherwise, we could maybe retouch some parts of the page like the homemade color mode and the javascript part ?
I couldn't think about something you didn't mentionned in the description so well done :)
Finally chose to keep |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 🚀 I don't think we can handle much apart warning users, let's give it a try !
Description
This PR will be the latest PR to merge just before the release of Boosted v5.3.0. It hides the dark mode as it is not yet implemented for Boosted. The inner mechanism will stay, but it must be deactivated from the documentation.
The content of this PR must be reverted right after the release so we can get back to work based on the main branch of Bootstrap. If a v5.3.1 is released before we have the time to release the dark mode, we'll get back this PR again.
Detailed content of this PR in terms of modifications:
data-bs-theme
in the layouts used to display the documentation (base and examples)color-modes.js
in documentationvariables-dark
must remain.$enable-dark-mode
could be easier to understand and evaluate the impact for usersvariables-dark
must remaindata-bs-theme="dark"
. IMO can stay as-is.variables-dark
imports must remainMotivation & Context
The readers/users must understand by reading the documentation (migration guide included) that the inner mechanism for the color mode is available but they can't use it yet for the dark mode in their projects.
Types of change
Live previews