Skip to content

Commit

Permalink
docs: fix docs page for color-system
Browse files Browse the repository at this point in the history
  • Loading branch information
HerrTopi committed Aug 15, 2024
1 parent 6c3755e commit 6d843eb
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 40 deletions.
49 changes: 49 additions & 0 deletions docs/guides/color-system.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: Color System
category: Guides
order: 5
---

### Colors

Colors are divided into two main technical groups: primitive and semantic colors. Primitive colors store the pure hex values. The primitive colors are the building blocks of the semantic colors. Examples of semantic colors: UI, Contrasts, Datavisualization.

### Primitives

These are here for reference only, usually not needed for InstUI development. Available from the themes and from `@instructure/ui-themes`

```jsx
---
type: example
---
<ThemeColors colors={canvas.colors.primitives} label="Color palette (Primitive colors)"></ThemeColors>
```

### Additional Primitives

These are here for reference only, usually not needed for InstUI development. Available from `@instructure/ui-themes`

```jsx
---
type: example
---
<ThemeColors colors={additionalPrimitives} label="Additional Primitive colors"></ThemeColors>
```

### Data visualization

The color names show their hue value and their contrast value on a white background. They don't tell how to use them or for what data they can be applied to. Each hue has 4 primary and 5 secondary colors.

- The datavisualization color palette is for data representation only. Like graphs, chars and plots.
- These are solid colors and can not be used for creating gradients.
- First you have to use all 4 of the primary colors of a hue, then you can use the 5 secondary ones.
- Use them on a white background

Available from `@instructure/ui-themes`

```jsx
---
type: example
---
<ColorTable colors={datavisualization} colorNames={additionalPrimitives}></ColorTable>
```
40 changes: 0 additions & 40 deletions docs/guides/colors.md

This file was deleted.

0 comments on commit 6d843eb

Please sign in to comment.