Skip to content

Commit ecbe1a8

Browse files
committed
added missing properties to the list and added docs
1 parent d29c6c5 commit ecbe1a8

File tree

1 file changed

+70
-1
lines changed

1 file changed

+70
-1
lines changed

packages/uui-css/lib/custom-properties.story.ts

Lines changed: 70 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,14 @@ const propertySizeTemplate = (property: any) => html` <uui-table-row>
8686
</uui-table-row>`;
8787

8888
export const InterfaceColors = () => {
89-
const surface = ['surface', 'background', 'text', 'color-border', 'divider'];
89+
const surface = [
90+
'surface',
91+
'background',
92+
'text',
93+
'color-border',
94+
'divider',
95+
'interactive',
96+
];
9097
const state = ['selected', 'current', 'disabled'];
9198
const color = ['primary', 'positive', 'warning', 'danger', 'disabled'];
9299
const universal = ['header', 'focus', 'hover'];
@@ -98,6 +105,68 @@ export const InterfaceColors = () => {
98105
specific look.
99106
</p>
100107
108+
<h3>Naming convention</h3>
109+
<p>Here's a description and examples of how to use the interface colors.</p>
110+
<h4>Color variants</h4>
111+
<p>Most colors has up to 3 variants.</p>
112+
<ul>
113+
<li>
114+
<b>Contrast</b> - This color will stand out and be readable with the
115+
main color as it's background. Mostly used for text and icons.
116+
</li>
117+
<li>
118+
<b>Standalone</b> - This color will have a higher contrast to the
119+
surface color than it's main variant. Example: if the surface color is
120+
light, the standalone variant will be a darker variant of the main
121+
color. Often used when thin or smaller items has to stand out on the
122+
surface backgrounds. Items such as: text, icons and border.
123+
</li>
124+
<li>
125+
<b>Emphasis</b> - Used when you want to emphasize an element, make it
126+
stand out. Mostly used for hover and focus states.
127+
</li>
128+
</ul>
129+
<h4>Text and interactables</h4>
130+
<ul>
131+
<li>
132+
<b>Text</b> - Used for most text, or icons appearing together with text
133+
</li>
134+
<li>
135+
<b>Interactable</b> - Used when the text or icon is interactable, such
136+
as a link
137+
</li>
138+
</ul>
139+
<h4>States</h4>
140+
<ul>
141+
<li>
142+
<b>Selected</b> - Used to highlight the text or background color of
143+
items that are currently selected.
144+
</li>
145+
<li>
146+
<b>Current</b> - Only used to show navigation. Example: Background or
147+
text color of the current tab or breadcrumb.
148+
</li>
149+
<li><b>Disabled</b> - For elements that are disabled.</li>
150+
</ul>
151+
<h4>Borders and dividers</h4>
152+
<ul>
153+
<li><b>Border</b> - Used when an element needs a border around it</li>
154+
<li>
155+
<b>Divider</b> - For elements that needs to be visually separated.
156+
Example: a list of items
157+
</li>
158+
</ul>
159+
<h4>Misc</h4>
160+
<ul>
161+
<li><b>Surface</b> - The main background color for elements</li>
162+
<li><b>Background</b> - The main background color of the app</li>
163+
<li><b>Header</b> - Background color of the header of the app</li>
164+
<li>
165+
<b>Focus</b> - Color for the focus outline on inputs, buttons, links and
166+
so on
167+
</li>
168+
</ul>
169+
101170
<h3>Surface</h3>
102171
<uui-table @click=${copyToClipboard}>
103172
<uui-table-head>

0 commit comments

Comments
 (0)