Skip to content
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

Assess USWDS theming for legacy veda-config instances #1389

Open
3 tasks
dzole0311 opened this issue Jan 20, 2025 · 0 comments
Open
3 tasks

Assess USWDS theming for legacy veda-config instances #1389

dzole0311 opened this issue Jan 20, 2025 · 0 comments
Assignees

Comments

@dzole0311
Copy link
Collaborator

Context

We have figured out how the USWDS theming will work for the new NextJS-based instances + the veda UI repo for local development.

We also need to assess whether and how USWDS-based theming for veda-ui components can be supported long-term within legacy veda-config instances, when veda-ui is used as a submodule (e.g. the existing veda-config).

Acceptance Criteria

  • Confirm whether USWDS theming is compatible with legacy veda-config instances
  • Add additional configuration in veda-config if required to support USWDS theming
  • Provide documentation detailing the theming setup process for legacy instances

Related Tickets

[If applicable, link any tickets that are related]

@dzole0311 dzole0311 added the P2 Find a way to fix in the next few sprints label Jan 20, 2025
@dzole0311 dzole0311 self-assigned this Feb 4, 2025
@aboydnw aboydnw removed the P2 Find a way to fix in the next few sprints label Feb 4, 2025
dzole0311 added a commit that referenced this issue Feb 10, 2025
**Related Ticket:** #1415

### Description of Changes

Make the USWDS banner flag path and alt texts configurable. The USWDS
assets are currently resolved incorrectly because they're using absolute
paths (starting with '/') which are being resolved relative to earth.gov
instead of earth.gov/ghgcenter. As an immediate fix, this PR makes the
flag path configurable so we can adjust it based on the deployment
context.

### Notes & Questions About Changes
- Path resolution could potentially affect other USWDS assets beyond the
flag and in other components. We'll be tackling this via #1429 (subpath
route handling) and #1389

### Validation / Testing
- Start veda-ui locally
- Change the `flagImgSrc` path in veda-config.js to
`/img/icon-https.svg`
- Restart your server
- Verify that the flag img in the banner shows the new icon
- Change it back the original flag path
- Verify that the flag icon is shown
dzole0311 added a commit that referenced this issue Feb 10, 2025
**Related Ticket:** #1415

Make the USWDS banner flag path and alt texts configurable. The USWDS
assets are currently resolved incorrectly because they're using absolute
paths (starting with '/') which are being resolved relative to earth.gov
instead of earth.gov/ghgcenter. As an immediate fix, this PR makes the
flag path configurable so we can adjust it based on the deployment
context.

- Path resolution could potentially affect other USWDS assets beyond the
flag and in other components. We'll be tackling this via #1429 (subpath
route handling) and #1389

- Start veda-ui locally
- Change the `flagImgSrc` path in veda-config.js to
`/img/icon-https.svg`
- Restart your server
- Verify that the flag img in the banner shows the new icon
- Change it back the original flag path
- Verify that the flag icon is shown
dzole0311 added a commit that referenced this issue Feb 10, 2025
**Related Ticket:** #1415

Make the USWDS banner flag path and alt texts configurable. The USWDS
assets are currently resolved incorrectly because they're using absolute
paths (starting with '/') which are being resolved relative to earth.gov
instead of earth.gov/ghgcenter. As an immediate fix, this PR makes the
flag path configurable so we can adjust it based on the deployment
context.

- Path resolution could potentially affect other USWDS assets beyond the
flag and in other components. We'll be tackling this via #1429 (subpath
route handling) and #1389

- Start veda-ui locally
- Change the `flagImgSrc` path in veda-config.js to
`/img/icon-https.svg`
- Restart your server
- Verify that the flag img in the banner shows the new icon
- Change it back the original flag path
- Verify that the flag icon is shown
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants