refactor: Decouple USWDS packages from the library bundle #1337
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
✅ Deploy Preview for veda-ui ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
dzole0311
requested review from
vgeorge,
AliceR,
hanbyul-here,
sandrahoang686 and
snmln
package.json
Outdated
| @@ -40,6 +40,10 @@ | |||
| "engines": { | |||
| "node": ">=18.0.0" | |||
| }, | |||
| "peerDependencies": { | |||
| "@uswds/uswds": "^3.8.1", | |||
| "@trussworks/react-uswds": "^9.0.0" | |||
There was a problem hiding this comment.
do we need react-uswds as a peer dependency?
There was a problem hiding this comment.
Good point. Thinking about it again, we should move @trussworks/react-uswds to regular dependencies since we're using its components directly in our library that gets bundled by Parcel. I've updated the package.json in the instance repo as well.
hanbyul-here
approved these changes
Dec 18, 2024
dzole0311
added a commit
that referenced
this pull request
Dec 24, 2024
**Related Ticket:** #1317 ### Description of Changes Added USWDS theming guide documentation to help developers understand and implement custom styling configuration when using VEDA UI components with USWDS. This documents the changes implemented in #1337 and developmentseed/next-veda-ui#30. ### Notes & Questions About Changes _{Add additonal notes and outstanding questions here related to changes in this pull request}_ ### Validation / Testing _{Update with info on what can be manually validated in the Deploy Preview link for example "Validate style updates to selection modal do NOT affect cards"}_
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related Ticket / Closes: #1317
Related Next.js PR: developmentseed/next-veda-ui#30
Description of Changes
Restructured the library build for local development and library build:
devDependenciesand added USWDS as apeerDependencyNotes & Questions About Changes
Going forward, the VEDA UI library now expects consuming apps to:
_uswds-theme.scssconfig fileFurthermore, we could also expose the themed variables that @AliceR and @sandrahoang686 created in a similar config file like the one for USWDS (e.g.
_veda-theme.scss) and allow instances to customize them in a similar manner like the uswds theme. Since that's out of scope for this PR, I'll create a follow-up issue to track it.Validation / Testing
yarn devand check that the development environment still has full USWDS access_uswds-theme.scssconfig file -> check that the change is applied, for example, to the header