docs(dark-theme-handbook): Adds guidance for images and charts. #4402
Conversation
This file contains hidden or 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
Collaborator
mcoker
approved these changes
Dec 6, 2024
Contributor
mcoker
left a comment
mcoker
left a comment
There was a problem hiding this comment.
Left some comments, but they're just nits - I think it's fine as it is, too 👍👍
packages/documentation-site/patternfly-docs/content/developer-resources/dark-theme-handbook.md
Show resolved
Hide resolved
|
|
||
| The [PatternFly React charts package](https://www.npmjs.com/package/@patternfly/react-charts) uses default style values that align with our light theme. In order to support dark-themed charts, you must import the stylesheet that contains dark theme styles by adding the following line to the top of your file: | ||
|
|
||
| `import '@patternfly/patternfly/patternfly-charts.css';` |
Contributor
There was a problem hiding this comment.
This LGTM but I'll say I'm not sure if we have standard verbiage for how to import an asset like that? Specifically these 2 points:
- "adding the following line to the top of your file" - not sure if that's clear as to where it needs to go? I found this in the repo docs about how to add PF CSS to your react app - I'm assuming the charts CSS would be imported either in the same place or using similar language.
- This implies users have the
@patternfly/patternflypackage installed, which isn't needed for a react app by default, so not sure if it's worth calling that out? If so it would be similar to the linked page above in the setup section with thenpm installandyarn addcommands.
Collaborator
Author
There was a problem hiding this comment.
interesting points! I'll add a line for that first point similar to what you linked. For the second, wdyt about linking to https://www.patternfly.org/get-started/develop#develop-with-htmlcss?
…resources/dark-theme-handbook.md Co-authored-by: Michael Coker <35148959+mcoker@users.noreply.github.com>
edonehoo
commented
Dec 9, 2024
packages/documentation-site/patternfly-docs/content/developer-resources/dark-theme-handbook.md
Outdated
Show resolved
Hide resolved
…resources/dark-theme-handbook.md
nicolethoen
approved these changes
Dec 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Closes #3682 and #4237