Skip to content
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
99 commits
Select commit Hold shift + click to select a range
4af58dd
docs(design-tokens): creates documentation for design tokens.
edonehoo Sep 21, 2023
dcf788f
Working on design tokens doc structure.
edonehoo Sep 28, 2023
daf5827
Continues adding content and outlining the docs structure.
edonehoo Oct 16, 2023
1ce4cde
Ready design tokens docs for draft preview.
edonehoo Oct 16, 2023
c127c80
Update page info.
edonehoo Oct 16, 2023
33c76dc
Add to side nav.
edonehoo Oct 16, 2023
0a68c45
Merge branch 'main' into iss1258
edonehoo Oct 16, 2023
5bac9c1
Adjust section label.
edonehoo Oct 16, 2023
755447f
Update packages/documentation-site/patternfly-docs/patternfly-docs.co…
edonehoo Oct 17, 2023
84aeaa8
Small typos.
edonehoo Oct 17, 2023
1afaf67
Update sidebar.'
edonehoo Oct 19, 2023
b3ae361
Updates to the charts about page and charts colors page (#3759)
aratti96 Oct 23, 2023
986495e
chore(release): releasing packages [ci skip]
patternfly-build Oct 23, 2023
07ddbe5
Update broken links on menu accessibility docs
nicolethoen Oct 23, 2023
d5ff4c2
Update broken links on menu design guidelines
nicolethoen Oct 23, 2023
9e75254
chore(release): releasing packages [ci skip]
patternfly-build Oct 23, 2023
77bf3e3
Removing the redudancy in the file. Use is described above the text. …
kuklas Oct 27, 2023
8a8e808
chore(release): releasing packages [ci skip]
patternfly-build Oct 27, 2023
f0af60b
docs(design-guidelines) Updates content for consistency. (#3782)
edonehoo Oct 27, 2023
30ce913
chore(release): releasing packages [ci skip]
patternfly-build Oct 27, 2023
6e87200
chore(docs-framework): add class on example load (#3789)
wise-king-sullyman Oct 27, 2023
a7164b2
chore(release): releasing packages [ci skip]
patternfly-build Oct 27, 2023
b4c8bf9
docs(terminology): Updates n/a and -- descriptions for clarity. (#3783)
edonehoo Oct 30, 2023
5505299
chore(release): releasing packages [ci skip]
patternfly-build Oct 30, 2023
47b5f74
feat(dark-theme): replace dark theme switcher with toggle group (#3788)
wise-king-sullyman Nov 1, 2023
1fe9735
chore(release): releasing packages [ci skip]
patternfly-build Nov 1, 2023
3c03fff
chore(JumpLinks): updated a11y docs to match template (#3808)
thatblindgeye Nov 7, 2023
bd46721
fix(react-drag-drop): add react-drag-drop to latest version (#3801)
kmcfaul Nov 7, 2023
d430387
chore(release): releasing packages [ci skip]
patternfly-build Nov 7, 2023
7b95d88
fix: clean up versions and showdown deps (#3816)
nicolethoen Nov 10, 2023
a74cc87
chore(release): releasing packages [ci skip]
patternfly-build Nov 10, 2023
5e9bb58
Added expand/collapse all cards info (#3815)
kaedward Nov 10, 2023
4ed6e7a
chore(release): releasing packages [ci skip]
patternfly-build Nov 10, 2023
e375fdc
fix: add charts dark theme stylesheet (#3802)
nicolethoen Nov 13, 2023
abb0e69
chore(release): releasing packages [ci skip]
patternfly-build Nov 13, 2023
47c5cae
fix(drag drop): add drag drop to 5.1 versions.json (#3817)
kmcfaul Nov 13, 2023
bf9a278
chore(release): releasing packages [ci skip]
patternfly-build Nov 13, 2023
6fc3bb6
fix: add virtualized table to extensions staging (#3819)
nicolethoen Nov 14, 2023
86c07c6
chore(release): releasing packages [ci skip]
patternfly-build Nov 14, 2023
51c2b17
chore(Sidebar): updated a11y docs (#3813)
thatblindgeye Nov 17, 2023
ae88bcd
chore(AboutModal): updated a11y docs to match template (#3796)
thatblindgeye Nov 17, 2023
602f0c4
chore(release): releasing packages [ci skip]
patternfly-build Nov 17, 2023
7163a6d
Makes some content updates.
edonehoo Nov 20, 2023
f0f4ae7
fix: prepare org for component groups release (#3822)
nicolethoen Nov 21, 2023
3b87291
chore(release): releasing packages [ci skip]
patternfly-build Nov 21, 2023
69a8869
Update github actions to add new issues to project board (#3818)
jessiehuff Nov 30, 2023
ef5c617
chore(release): releasing packages [ci skip]
patternfly-build Nov 30, 2023
d37ef97
docs(accessibility-fundamentals): Updates content as part of audit. (…
edonehoo Dec 13, 2023
8b3d55c
docs(patternfly-accessibility): Updates content as part of content au…
edonehoo Dec 13, 2023
aad9098
docs(accessibility-development): Updates documentation as part of con…
edonehoo Dec 13, 2023
1a60605
docs(accessibility-scorecard): Updates content as part of content aud…
edonehoo Dec 13, 2023
d773f4e
chore(deps): add react as a dep at the root level (#3834)
wise-king-sullyman Dec 13, 2023
e105f46
chore(release): releasing packages [ci skip]
patternfly-build Dec 13, 2023
151cff0
chore(Skeleton): updated a11y docs to match template (#3824)
thatblindgeye Dec 13, 2023
9af62e5
chore(HelperText): updated a11y docs to match template (#3805)
thatblindgeye Dec 13, 2023
a493800
chore(ExpandableSection): updated a11y docs to match template (#3803)
thatblindgeye Dec 13, 2023
5af2f2a
chore(CodeEditor): updated a11y documentation to match template (#3799)
thatblindgeye Dec 13, 2023
82249bc
chore(release): releasing packages [ci skip]
patternfly-build Dec 13, 2023
d3a4acc
chore(deps): bump semver from 5.7.1 to 5.7.2 (#3841)
dependabot[bot] Dec 13, 2023
6cf51d8
chore(deps): bump @babel/traverse from 7.18.6 to 7.23.6 (#3842)
dependabot[bot] Dec 13, 2023
e0fb0b5
chore(release): releasing packages [ci skip]
patternfly-build Dec 13, 2023
98bbeb8
docs(level): expands design guidelines for level layout. (#3673)
edonehoo Dec 13, 2023
de0b76b
[Snyk] Fix for 1 vulnerabilities (#3828)
patternfly-build Dec 13, 2023
c9eb93c
chore(release): releasing packages [ci skip]
patternfly-build Dec 13, 2023
08f307d
chore(deps): bump postcss from 8.4.31 to 8.4.32 (#3844)
dependabot[bot] Dec 14, 2023
62db391
chore(release): releasing packages [ci skip]
patternfly-build Dec 14, 2023
4ae7d2f
[Snyk] Security upgrade puppeteer from 18.2.0 to 19.7.3 (#3843)
patternfly-build Dec 14, 2023
4f9b45f
chore(deps): bump qs from 6.5.2 to 6.5.3 (#3309)
dependabot[bot] Dec 14, 2023
7b84dce
fix: try a v6 release
nicolethoen Dec 14, 2023
e45742b
chore(release): releasing packages [ci skip]
patternfly-build Dec 14, 2023
5362368
fix: use surge for v6 staging rather than aws bucket
nicolethoen Dec 15, 2023
e278614
fix: bump docs-framework version in docs-site
nicolethoen Dec 15, 2023
32b4e39
chore(release): releasing packages [ci skip]
patternfly-build Dec 15, 2023
6016d25
fix: try publish v6 to aws (#3845)
nicolethoen Dec 18, 2023
063ca3e
chore(release): releasing packages [ci skip]
patternfly-build Dec 18, 2023
aae40b5
fix: update white space to test publishing to aws
nicolethoen Dec 20, 2023
75b6d47
chore(release): releasing packages [ci skip]
patternfly-build Dec 20, 2023
8d3d62d
fix: PF brand logo in masthead to inline svg
nicolethoen Dec 20, 2023
1013af4
chore(release): releasing packages [ci skip]
patternfly-build Dec 20, 2023
3155cb4
fix: bump puppeteer (#3858)
nicolethoen Jan 12, 2024
8db0128
chore(release): releasing packages [ci skip]
patternfly-build Jan 12, 2024
be52327
fix: Update brand svg id to avoid duplicate ids
nicolethoen Jan 12, 2024
85de262
chore(release): releasing packages [ci skip]
patternfly-build Jan 12, 2024
9a1e52e
Fix: update logo svg (#3861)
nicolethoen Jan 15, 2024
70fdeaa
chore(release): releasing packages [ci skip]
patternfly-build Jan 15, 2024
d13b35e
fix: Update versions.json to include drag drop alpha
nicolethoen Jan 23, 2024
37b304b
chore(release): releasing packages [ci skip]
patternfly-build Jan 23, 2024
9c567ca
fix: bump docs framework version
nicolethoen Feb 1, 2024
0146d86
chore(release): releasing packages [ci skip]
patternfly-build Feb 1, 2024
19e2541
Continued edits.
edonehoo Feb 1, 2024
019a275
Working on content.
edonehoo Feb 2, 2024
87ba42e
Updates design info and adds images.
edonehoo Feb 5, 2024
5dfd40c
Merge branch 'v6' into iss1258
edonehoo Feb 6, 2024
a16e35c
Updates to images.
edonehoo Feb 12, 2024
f8d2ce3
Continued content updates.
edonehoo Feb 14, 2024
ca4bef5
Smooths out formatting and content.
edonehoo Feb 15, 2024
e527f0a
add all tokens documentation
nicolethoen Feb 17, 2024
1870901
Merge remote-tracking branch 'upstream/v6' into iss1258
nicolethoen Feb 27, 2024
f802226
bump to design-tokens version with versioned css
nicolethoen Feb 27, 2024
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
id: About
section: design-tokens
---

# Design tokens

This guide outlines PatternFly's use of design tokens. You should familiarize yourself with the details across this guide to learn about the purpose and implementation of PatternFly's tokens.

PatternFly's tokens are only available within Figma, so it's important that you follow our [Figma migration](/design-tokens/migrate) guide if necessary.
Comment thread
edonehoo marked this conversation as resolved.
Outdated

## What are design tokens

Design tokens are variables that store visual design attributes, like color, typography, and spacing. A design token has a name and value that represents the visual design information it contains.

## Why use tokens

Using design tokens helps maintain consistency across product design processes by ensuring that designers use the same colors for the same use cases.

Tokens also enable easier maintenance. Whenever a color is changed as part of a redesign or update,related tokens are automatically updated to reflect this change. This means that developers won't have to make any changes to code to ensure that their product is up to date with the latest recommendations. Likewise, designers will see that their designs automatically update to reflect any changes.
Comment thread
edonehoo marked this conversation as resolved.
Outdated

## PatternFly design tokens

### How to read tokens

Tokens can be read from left to right, with each part separated by a forward slash (/):

`scope / component / category / property / concept / variant / state`

Each piece represents different information:
- **Scope:** The range of the token. For example, `global` signifies that a token applies across the system.
- **Component:** The component that the token relates to.
- **Category:** NEED INFO
Comment thread
edonehoo marked this conversation as resolved.
Outdated
- **Property:** NEED INFO
- **Concept:** NEED INFO
- **Variant:** The variant type of the token's component.For example, a variant may be `plain` or `primary`.
- **State:** The state that the component is in. This is typically `disabled`, `hover`, or `active`.

Note that all PatternFly tokens also begin with `pf`.
Comment thread
edonehoo marked this conversation as resolved.
Outdated

### Token layers

PatternFly tokens have 3 layers: a **palette layer**, a **base layer**, and a **semantic layer**.
Comment thread
edonehoo marked this conversation as resolved.
Outdated

![Design layers example](./img/design-layers-example.png)
Comment thread
edonehoo marked this conversation as resolved.
Outdated

#### **Palette layer**

Palette layer tokens contain the colors in [PatternFly color palettes](/design-foundations/colors#patternfly-palettes).

If you've used PatternFly previously, these values resemble some of the CSS variables that you may be familiar with. They
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Some of our other tokens are quite like existing CSS variables, too, like spacers and status colors. Maybe @lboehling would have some good words for describing the palette layer?


**Add:** example image and/or `example / token / style / 000`

#### **Base layer**

Base layer tokens contain a wide range of tokens that the semantic layer can choose from.

These values are grouped conceptually and named numerically. There are no duplicate values within a concept group.
Comment thread
edonehoo marked this conversation as resolved.
Outdated

**Add:** example image and/or `example / token / style / 000`

#### **Semantic layer**

Semantic layer tokens will be the value that you see the most frequently. These values are the top-level tokens that are grouped conceptually and named semantically.
Comment thread
edonehoo marked this conversation as resolved.
Outdated

Most of the time, these reference base tokens, but can also reference other semantic tokens

**Add:** example image and/or `example / token / style / 000`

### Examples of token use

#### **Color tokens**

**Add:** example image and/or `example / token / style / 000`

#### **Spacing tokens**

**Add:** example image and/or `example / token / style / 000`
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
id: Designing with tokens
section: design-tokens
---

As a designer, you can access and use our token libraries in Figma.

NEED INFO

## Figma instructions

## Figma overview

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
id: Developing with tokens
section: design-tokens
---

## Installing tokens

To develop with PatternFly tokens, you must first install the tokens package from `@patternfly/react-tokens`.

NEED INFO

### Using tokens with React
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
id: Migrate to tokens
section: design-tokens
---

This guide provides instructions for migrating to tokens from PatternFly's previous design and wireframe kits.

## How to migrate a product to tokens

### For designers

Designers should migrate all designs into Figma, so that they can be updates to use tokens.

Once you've completed your migration you can begin to [design with tokens.](/design-tokens/design-with-tokens)

### For developers

Developers will need to download token packages and update all colors and styles to use tokens, instead of CSS variables.

This change may resemble the following:

```code example```

For more detailed instructions, refer to our [develop with tokens](/design/tokens/develop-with-tokens) guide.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
id: PatternFly tokens
section: design-tokens
---

## All tokens
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ if (process.env.EXTENSIONS_ONLY === 'true') {
sideNavItems: [
{ section: 'get-started' },
{ section: 'design-foundations' },
{ section: `design-tokens` },
Comment thread
edonehoo marked this conversation as resolved.
Outdated
{ section: 'accessibility' },
{ section: 'UX writing' },
{ section: 'components' },
Expand Down