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

feat: define the style system #98

Open
5 tasks
helmturner opened this issue Mar 9, 2024 · 0 comments
Open
5 tasks

feat: define the style system #98

helmturner opened this issue Mar 9, 2024 · 0 comments
Assignees
Labels
design needs layout/design work or spec documentation Improvements or additions to documentation frontend

Comments

@helmturner
Copy link
Member

helmturner commented Mar 9, 2024

This issue has three parts:

  • Configure the style utilities
  • Define the brand guide
  • Document pfreferred patterns and best practices

Configure the Style Utilities

There are three main points of configuration for the style system:

  • 1. design/tokens.css.ts

This file creates a set of predefined, 'blessed' values to be used across the site. These are essentially the 'raw' values that act as building blocks for the rest of the system, however they can be used directly if needed (though this should be considered an escape hatch).

  • 2. design/sprinkles.css.ts

The 'sprinkles' file exports a utility that can be used to construct scoped style utilities. You would use the 'sprinkles' function in a .css.ts to build utility styles, then import them into your component. See the sprinkles docs for more info.

  • 3. themes.sprinkles.css.ts

I'm still not entirely set on how themes will be used. Currently they just provide a subset of tokens, but this implementation is likely to change.

Define the Brand Guide

This should ultimately be up to someone with a better eye than me, but for now I'm translating this as "figure out how to implement themes idiomatically so that, when someone with design sense wants to help, they can easily implement their vision"

Documentation

Much of this is still in an experimental state, but as this gets tested and refined we'll update documentation accordingly. For now, please refer to the Vanilla Extract Docs

@helmturner helmturner added documentation Improvements or additions to documentation frontend design needs layout/design work or spec labels Mar 9, 2024
@helmturner helmturner self-assigned this Mar 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design needs layout/design work or spec documentation Improvements or additions to documentation frontend
Projects
None yet
Development

No branches or pull requests

1 participant