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

[OUI compliance] Initial re-theming #4239

Open
3 tasks
Tracked by #4065
joshuarrrr opened this issue Jun 5, 2023 · 0 comments
Open
3 tasks
Tracked by #4065

[OUI compliance] Initial re-theming #4239

joshuarrrr opened this issue Jun 5, 2023 · 0 comments
Assignees
Labels
OUI compliance Issues and PRs to maximize OUI usage and remove style and component hacks

Comments

@joshuarrrr
Copy link
Member

joshuarrrr commented Jun 5, 2023

In the initial phase of phase of look and feel updates, we plan to change OUI Sass variables for typography and colors (for both dark and light mode). In order for these updates to apply consistently and completely, we want to augment our ongoing in-depth audit compliance initiative with a parallel effort that focuses on these key areas.

Mitigation Tasks

Typography

The theme updates will be to the "Typography" values listed in https://oui.opensearch.org/1.0/#/guidelines/sass. Eventually, the new theme will also add a header font variable, in addition to ouiFont and ouiCodeFont.

Audit OpenSearch Dashboards for the following CSS properties (as well as other font-*, text-*, and line-* properties:

  1. font-family
  2. font-size
  3. font-weight
  4. font-style
  5. line-height

Suggested approach: Typography styles are not necessarily limited to inline styles or *.scss stylesheets. The audit should also discover usages where these properties are being set or passed in js interfaces or via configurations. One initial approach is to search for all casing variants of a given property (kebab, snake, camel).

Beyond any explicit styles discovered above, we also want to audit for any explicit referencing of OUI SASS variables, such as euiFont or euiCodeFont, because these are valuable signals that the feature is attempting to mimic OUI components without

Out of scope: Typography within visualizations. We'll still audit these usages (see #3368), but won't mitigate them until we have more complete UX guidance.

Colors

The theme updates will be to the "Color" values listed in https://oui.opensearch.org/1.0/#/guidelines/sass. These application color updates will also require changes to the visualization color palettes: https://oui.opensearch.org/1.0/#/guidelines/sass.

  1. Text colors
  2. Background colors
  3. Border colors
  4. Button colors
  5. Shadow colors
  6. Vis qualitative palettes (audit in progress)
  7. Vis quantitative palettes (audit in progress)

Suggested approach: Regex code search for any apparent color values (hex, rgb, rgba, hsv). Not all usages will be mitigated (such as user-specified color formats), but all should be audited.

Additional properties to include in audit/analysis

Because there are some known usages where these are used to indicate focus or text status, audits should also include info about:

  1. Border styles
  2. Shadow styles
@joshuarrrr joshuarrrr added OUI compliance Issues and PRs to maximize OUI usage and remove style and component hacks and removed untriaged labels Jun 5, 2023
@joshuarrrr joshuarrrr moved this to Todo in Look & Feel Jun 5, 2023
@joshuarrrr joshuarrrr moved this from Todo to In Progress in Look & Feel Jun 13, 2023
@wbeckler wbeckler changed the title [OUI compliance] De-risk initial theming updates [OUI compliance] Initial re-theming Jun 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OUI compliance Issues and PRs to maximize OUI usage and remove style and component hacks
Projects
Status: In Progress
Development

No branches or pull requests

2 participants