Skip to content

Conversation

@didoo
Copy link
Contributor

@didoo didoo commented Sep 30, 2025

๐Ÿ“Œ Summary

This is built on top of #3239 and is based on the initial spike done by @alex-ju in #3235

๐Ÿ› ๏ธ Detailed description

In this PR I have:

  • re-organized the components' Sass files architecture to split the common part related to HDS component in a separate file (packages/components/src/styles/components/index.scss)
  • updated the Rollup configuration to process multiple Sass files and generate distinct CSS files in output:
    • design-system-components.css - current file for HDS components
    • design-system-components-common.css - new file for theming
      • contains just the styles for the HDS component, no CSS variables coming from the design tokens pipeline
      • requires that the CSS file with the "themed" design tokens is imported separately

Then, after discussion and agreement with @alex-ju, I have moved also the existing compilation of the design-system-components.scss and design-system-power-select-overrides.scss files to our custom plugin, so we can remove rollup-plugin-scss as dev-dependency

  • in the new configuration, the design-system-power-select-overrides.scss is not only copied in the dist folder, but also compiled to .css (and a .map file is generated)

๐Ÿ”Ž How to review

You can look at the single commits, to see the sequence of steps and understand the explorations and thinking behind the PR, or you can look directly at the files, checking how the Scss files have been organized, how the Rollup plugin function has been implemented, and how the path for the include declarations have been updated to make it more obvious where a file was coming from.

๐Ÿ› ๏ธ How to test

Check out the branch, delete the dist folder under packages/components, run the command pnpm build or pnpm start, and see how different files are copied/generated under packages/components/dist/styles/@hashicorp (source Scss files, compiled CSS files, map files)

You can also go one step further, and update (or add) some design tokens, run the pnpm build command in the packages/tokens folder, and then run the command pnpm build in the packages/components folder and see how the tokens changes are reflected in the generated CSS files for the components:

  • if only $modes are changed, the file packages/components/dist/styles/@hashicorp/design-system-components.css should remain untouched
  • if the $value is changed, the file packages/components/dist/styles/@hashicorp/design-system-components.css should be updated too (the CSS variable corresponding to the token that was changed)

๐Ÿ”— External links

Jira ticket: https://hashicorp.atlassian.net/browse/HDS-5505


๐Ÿ‘€ Component checklist

  • Percy was checked for any visual regression
  • A changelog entry was added via Changesets if needed (see templates here)
    • changelogs will be added in the main feature branch

๐Ÿ’ฌ Please consider using conventional comments when reviewing this PR.

๐Ÿ“‹ PCI review checklist
  • If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.
  • If applicable, I've worked with GRC to document the impact of any changes to security controls.
    Examples of changes to controls include access controls, encryption, logging, etc.
  • If applicable, I've worked with GRC to ensure compliance due to a significant change to the in-scope PCI environment.
    Examples include changes to operating systems, ports, protocols, services, cryptography-related components, PII processing code, etc.

@didoo didoo requested review from alex-ju and Copilot September 30, 2025 11:13
@vercel
Copy link

vercel bot commented Sep 30, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Updated (UTC)
hds-showcase Ready Ready Preview Nov 25, 2025 4:59pm
hds-website Ready Ready Preview Nov 25, 2025 4:59pm

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR reorganizes the Sass architecture for the Helios Design System components to support theming capabilities. It creates a foundation for generating multiple CSS builds with different theming strategies while maintaining the existing component functionality.

Key changes:

  • Reorganizes Sass files to separate common components from theming-specific configurations
  • Updates Rollup configuration to support multiple CSS output files with custom SCSS compilation
  • Creates new themed CSS variants using CSS selectors and prefers-color-scheme approaches

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
packages/components/src/styles/components/index.scss New centralized index file importing all component SCSS files
packages/components/src/styles/@hashicorp/design-system-components.scss Refactored to use new components index and updated token paths
packages/components/src/styles/@hashicorp/design-system-components-theming-with-prefers-color-scheme.scss New themed variant using prefers-color-scheme media queries
packages/components/src/styles/@hashicorp/design-system-components-theming-with-css-selectors.scss New themed variant using CSS selectors
packages/components/rollup.config.mjs Updated with custom SCSS compilation function and multiple output configurations

@didoo didoo force-pushed the project-solar/phase-1/HDS-5505_components/modes-css-compilation branch from 75bc4b6 to b258e2e Compare September 30, 2025 13:39
@didoo didoo changed the title [WIP] [Project Solar / Phase 1 / Themed CSS for HDS components] Update Rollup configuration to process multiple Sass files and re-organize the components' Sass architecture to include theming [WIP] [Project Solar / Phase 1 / Themed CSS for HDS components] Multi-file Rollup configuration and Sass processing Sep 30, 2025
@didoo didoo changed the title [WIP] [Project Solar / Phase 1 / Themed CSS for HDS components] Multi-file Rollup configuration and Sass processing [WIP] [Project Solar / Phase 1 / Themed CSS for HDS components] Rollup configuration and Sass processing for multiple files Sep 30, 2025
@didoo didoo force-pushed the project-solar/phase-1/HDS-5216_modes/modes-pipeline-implementation branch from 1803ce4 to 66b876e Compare September 30, 2025 14:51
@didoo didoo force-pushed the project-solar/phase-1/HDS-5505_components/modes-css-compilation branch from 67f8499 to d4cd0c3 Compare September 30, 2025 14:51
@alex-ju alex-ju mentioned this pull request Oct 1, 2025
5 tasks
@didoo didoo force-pushed the project-solar/phase-1/HDS-5216_modes/modes-pipeline-implementation branch from 66b876e to 1a855c1 Compare October 2, 2025 11:38
@didoo didoo force-pushed the project-solar/phase-1/HDS-5505_components/modes-css-compilation branch from 6251490 to bb949c9 Compare October 2, 2025 11:43
@didoo didoo force-pushed the project-solar/phase-1/HDS-5216_modes/modes-pipeline-implementation branch from 1a855c1 to 57ea7fa Compare October 7, 2025 12:15
@didoo didoo force-pushed the project-solar/phase-1/HDS-5505_components/modes-css-compilation branch from bb949c9 to 88f8368 Compare October 7, 2025 15:54
Copy link
Contributor

@KristinLBradley KristinLBradley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a comment RE some linter complaints in generated dist files: #3259 (comment) and one suggested fix for a typo in a comment. Otherwise, looks good!

@didoo
Copy link
Contributor Author

didoo commented Nov 21, 2025

In packages/components/dist/styles/@hashicorp, the copyright in "design-system-components-common.css" and in "design-system-components.css" ends up below the first line of code. Probably not a big deal but it looks a little strange and causes the linter to complain about spacing.

image In "design-system-power-select-overrides.css" and "design-system-power-select-overrides.scss" There's this linter complaint: image

the linter also complains about spacing between style rules in "design-system-power-select-overrides.css" being absent.

@KristinLBradley these are compiled files, there's not much we can do (as you mentioned, they're generated in the dist folder of packages/components)

alex-ju and others added 15 commits November 25, 2025 16:55
โ€ฆadded custom source files for theming + updated rollup config to process different files
โ€ฆvalidate that all the new CSS files are generated too
โ€ฆ for old CSS files that donโ€™t exist anymore)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
โ€ฆents.scss

Co-authored-by: Kristin Bradley <kristin.bradley@hashicorp.com>
Base automatically changed from project-solar/phase-1/HDS-5216_modes/modes-pipeline-implementation to project-solar/phase-1/HDS-5216_modes/modes-feature-branch November 25, 2025 22:15
@didoo didoo merged commit 1864883 into project-solar/phase-1/HDS-5216_modes/modes-feature-branch Nov 25, 2025
27 of 30 checks passed
@didoo didoo deleted the project-solar/phase-1/HDS-5505_components/modes-css-compilation branch November 25, 2025 22:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants