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

doc: colors documentation for dbux3 #98

Open
wants to merge 10 commits into
base: dbux-3
Choose a base branch
from
Open

Conversation

annsch
Copy link
Collaborator

@annsch annsch commented Oct 25, 2022

  • Examples
  • Usage styles
  • Intro text finalize

@annsch annsch changed the base branch from main to dbux-3 October 25, 2022 11:54
@annsch annsch changed the title doc: colors documentation for dbux3 draft: doc: colors documentation for dbux3 Oct 25, 2022
@annsch annsch changed the title draft: doc: colors documentation for dbux3 doc: colors documentation for dbux3 Oct 25, 2022
@annsch annsch marked this pull request as draft October 25, 2022 12:00
@annsch annsch marked this pull request as ready for review October 27, 2022 08:14
@annsch annsch added the documentation Improvements or additions to documentation label Oct 27, 2022
mfranzke and others added 2 commits October 27, 2022 10:22
refactor: let's use a dl dt/dd here for semantics
Comment on lines +13 to +18
<dt><b>Primary</b></dt><dd>base key color</dd>
<dt><b>On Primary</b></dt><dd>is applied to content (icons, text, etc.) that sits on top of primary</dd>
<dt><b>Primary Background-Light</b></dt><dd>background color for current key color. Only used for backrounds.</dd>
<dt><b>Primary Background Transparent</b></dt><dd>Transparent or semi transparent backgrounds for current key color, e.g. used for form field backgrounds.</dd>
<dt><b>On Primary Background</b></dt><dd>is applied to content (icons, text, etc.) that sits on top of primary background colors (background light or transparent).</dd>
<dt><b>On Primary Background Weak</b></dt><dd>is applied to content (icons, text, etc.) that sits on top of primary background colors (background light or transparent) and is a variant to weaken content on primary backgrounds.</dd>
Copy link
Member

Choose a reason for hiding this comment

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

@annsch you could style the dt elements in bold via CSS instead of the b HTML tags.

Comment on lines +5 to +8
## Accessibility

SVGs are often conveyed inconsistently to assistive technologies. The component’s accessibility is also highly contextual.
For optimal user experience, use the aria-description prop to let assistive technology users know the purpose of the loading spinner.
Copy link
Member

Choose a reason for hiding this comment

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

@annsch I currently cannot connect the dots of this information from SVGs to colors.

Comment on lines +255 to +283

/**
* Colors Documentation
**/

main.colors-documentation h2 {
margin-top: 3rem;
}

main.colors-documentation h3 {
margin-top: 2rem;
}

main.colors-documentation figure {
margin: 0;
display: grid;
grid-auto-columns: 50% 50%;
grid: 1fr 1fr;
grid-gap: 1rem;
grid-auto-flow: column;
}

main.colors-documentation img {
height: auto;
max-width: 100%;
border-radius: 0.875rem;
box-shadow: rgb(60 64 67 / 30%) 0px 1px 2px 0px,
rgb(60 64 67 / 15%) 0px 1px 3px 1px;
}
Copy link
Member

@mfranzke mfranzke Nov 9, 2022

Choose a reason for hiding this comment

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

this file is provided by pattern lab system itself, so I've introduced a pattern-scaffolding-project-specific.scss file within DB UI Core. Let's adapt this to DB UI Base and probably even move this file from Core to Base and add these declarations afterwards.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants