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

Improve the documentation on available CSS variables #1880

Open
sebnitu opened this issue Jun 13, 2024 · 0 comments
Open

Improve the documentation on available CSS variables #1880

sebnitu opened this issue Jun 13, 2024 · 0 comments
Labels
IS: docs Next Related to the next branch

Comments

@sebnitu
Copy link
Owner

sebnitu commented Jun 13, 2024

Problem

Currently we're implementing a "file" approach for documentation of CSS and SCSS variables. For CSS vars, this can be very cryptic since a lot of custom properties are set and output using core functions and mixins. We should improve this by displaying the true names and values for every CSS variable used by a component. Here are a few options to explore:

  • Using JavaScript, get the computed styles: e.g: searching for vars with --vb-[component]-* etc.
  • Use the core functions/mixins to store CSS var usage and find a way to output that data to the front-end.
  • Crawl the output CSS file for all CSS variable definitions and usages.
@sebnitu sebnitu added PR: docs Next Related to the next branch IS: docs and removed PR: docs labels Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
IS: docs Next Related to the next branch
Projects
None yet
Development

No branches or pull requests

1 participant