Skip to content

DataViz docs #45

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

DataViz docs #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6117ebe
DataViz docs
tominurmi Oct 17, 2022
d86d0a2
remove colour palette
tominurmi Dec 8, 2022
2742703
rename page
tominurmi Dec 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/components/data-viz-colours.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Data viz colour palette
149 changes: 149 additions & 0 deletions docs/components/data-viz-guidelines.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
# Colour guidelines

<Guideline title="Primary Colour" image="dataviz-primary.svg">
If you only need one colour hue, use <strong>viz-blue-400.</strong>
<br />
<br />
Note that this is not the same as the regular blue you find in the FINN colour palette.
</Guideline>
<br />
<br />

## Categorical colours

<Guideline title="Categorical" image="dataviz-categorical.svg">
These colours work well for categorical data, and are colourblind-safe.
<br />
<br />
<ol>
<li>viz-indigo-400</li>
<li>viz-pink-600</li>
<li>viz-teal-400</li>
<li>viz-orange-400</li>
</ol>
<br />
<strong>viz-indigo-400</strong> can be swapped with <strong>viz-blue-400</strong> in cases where comparison is related
to "self" as <strong>viz-blue-400</strong> is perceived as a more "important" colour.
</Guideline>

<Guideline title="Categorical - bordered version" image="dataviz-categorical-bordered.svg">
Brighter colours can be used as long as the darker colour is used as a border, to create enough contrast against the
background.*
<br />
<br />
<ol>
<li>
fill: <strong>viz-indigo-300</strong>, border: <strong>viz-indigo-500</strong>
</li>
<li>
fill: <strong>viz-pink-200</strong>, border: <strong>viz-pink-500</strong>
</li>
<li>
fill: <strong>viz-teal-200</strong>, border: <strong>viz-teal-500</strong>
</li>
<li>
fill: <strong>viz-orange-200</strong>, border: <strong>viz-orange-500</strong>
</li>
</ol>
</Guideline>

<Guideline title="Categorical - Extended" image="dataviz-categorical-extended.svg">
Use these colours if you need more than four hues. These colours are not fully colourblind-safe, and should therefore
be used with caution.
<br />
<br />
<ol>
<li>viz-indigo-400</li>
<li>viz-pink-600</li>
<li>viz-teal-400</li>
<li>viz-orange-400</li>
<li>viz-indigo-600</li>
<li>viz-pink-400</li>
<li>viz-teal-600</li>
<li>viz-orange-600</li>
</ol>
</Guideline>
<br />
<br />

## Good vs bad

<Guideline title="Good and bad numbers" image="dataviz-good-bad.svg">
Colours can be used to indicate good and bad numbers. Blue and red is the safest combination:
<ol>
<li>viz-blue-400</li>
<li>viz-red-500</li>
<li>
fill: <strong>viz-blue-200</strong>, border: <strong>viz-blue-500</strong>
</li>
<li>
fill: <strong>viz-red-200</strong>, border: <strong>viz-red-600</strong>
</li>
</ol>

<br />

or, with a neutral middle colour, with or without border:

<ol>
<li>viz-blue-400</li>
<li>viz-WarmGray-400</li>
<li>viz-red-500</li>
<li>
fill: <strong>viz-blue-200</strong>, border: <strong>viz-blue-500</strong>
</li>
<li>
fill: <strong>viz-WarmGray-200</strong>, border: <strong>viz-WarmGray-600</strong>
</li>
<li>
fill: <strong>viz-red-200</strong>, border: <strong>viz-red-600</strong>
</li>
</ol>

<br />
Teal and red should only be used if the brightness contrast is high:
<ol>
<li>viz-teal-400</li>
<li>viz-red-600</li>
</ol>

<br/>
Yellow needs an outline in order to have good enough contrast against a white background.
<ol>
<li>
fill: <strong>viz-Green-200</strong>, border: <strong>viz-Green-500</strong>
</li>
<li>
fill: <strong>viz-Yellow-400</strong>, border: <strong>viz-Yellow-600</strong>
</li>
<li>
fill: <strong>viz-red-300</strong>, border: <strong>viz-red-500</strong>
</li>
</ol>
</Guideline>
<br />
<br />

## Reference

<Guideline title="For historical data" image="dataviz-reference.svg">
Use <strong>viz-warmGrey-400</strong> if you need to include data that is less important than the primary data, for
example reference data and historical data.
</Guideline>
<br />
<br />

## Utility colours

<Guideline title="Supporting chart elements" image="dataviz-chart-elements.svg">
Utility colours are used for supporting chart elements like labels and grid lines.
<br />
<br />
Utility colours are colours from fabric:
<ul>
<li>Licorice (gray-700/#464646)</li>
<li>Stone (gray-500/#767676)</li>
<li>Sardine (bluegray-300/#C3CCD9)</li>
<li>Marble (bluegray-50/#F6F8FB)</li>
</ul>
</Guideline>
14 changes: 14 additions & 0 deletions src/pages/_app.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.