Skip to content

Commit

Permalink
Merge branch 'main' into iss3821
Browse files Browse the repository at this point in the history
  • Loading branch information
edonehoo authored Jan 17, 2024
2 parents ecfca8d + ca0be8b commit 88e06bb
Show file tree
Hide file tree
Showing 254 changed files with 656 additions and 388 deletions.
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@
]
},
"devDependencies": {
"@patternfly/patternfly": "5.1.0-prerelease.32",
"@patternfly/react-code-editor": "5.1.1-prerelease.22",
"@patternfly/react-core": "5.1.1-prerelease.22",
"@patternfly/react-table": "5.1.1-prerelease.22",
"@patternfly/patternfly": "5.2.0-prerelease.7",
"@patternfly/react-code-editor": "5.2.0-prerelease.48",
"@patternfly/react-core": "5.2.0-prerelease.47",
"@patternfly/react-table": "5.2.0-prerelease.47",
"@octokit/rest": "^19.0.7",
"glob": "^8.1.0",
"lerna": "^6.4.1",
Expand Down
62 changes: 62 additions & 0 deletions packages/ast-helpers/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,68 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

## 1.3.22 (2024-01-16)

**Note:** Version bump only for package @patternfly/ast-helpers





## 1.3.21 (2024-01-16)


### Bug Fixes

* bump to latest release candidates ahead of 5.2 release ([#3862](https://github.com/patternfly/patternfly-org/issues/3862)) ([12eeb78](https://github.com/patternfly/patternfly-org/commit/12eeb782d32c4fa65f6aef64292f1e0d92f0d183))





## 1.3.20 (2024-01-15)

**Note:** Version bump only for package @patternfly/ast-helpers





## 1.3.19 (2024-01-15)

**Note:** Version bump only for package @patternfly/ast-helpers





## 1.3.18 (2024-01-12)


### Bug Fixes

* bump puppeteer to fix core ([#3860](https://github.com/patternfly/patternfly-org/issues/3860)) ([1695209](https://github.com/patternfly/patternfly-org/commit/169520944b7c3dccf69709e6e2075b9153fce059))





## 1.3.17 (2024-01-05)

**Note:** Version bump only for package @patternfly/ast-helpers





## 1.3.16 (2024-01-03)

**Note:** Version bump only for package @patternfly/ast-helpers





## 1.3.15 (2023-12-14)

**Note:** Version bump only for package @patternfly/ast-helpers
Expand Down
2 changes: 1 addition & 1 deletion packages/ast-helpers/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@patternfly/ast-helpers",
"description": "Acorn AST helpers for working with live code",
"version": "1.3.15",
"version": "1.3.22",
"author": "Red Hat",
"license": "MIT",
"publishConfig": {
Expand Down
62 changes: 62 additions & 0 deletions packages/documentation-framework/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,68 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

## 5.3.22 (2024-01-16)

**Note:** Version bump only for package @patternfly/documentation-framework





## 5.3.21 (2024-01-16)


### Bug Fixes

* bump to latest release candidates ahead of 5.2 release ([#3862](https://github.com/patternfly/patternfly-org/issues/3862)) ([12eeb78](https://github.com/patternfly/patternfly-org/commit/12eeb782d32c4fa65f6aef64292f1e0d92f0d183))





## 5.3.20 (2024-01-15)

**Note:** Version bump only for package @patternfly/documentation-framework





## 5.3.19 (2024-01-15)

**Note:** Version bump only for package @patternfly/documentation-framework





## 5.3.18 (2024-01-12)


### Bug Fixes

* bump puppeteer to fix core ([#3860](https://github.com/patternfly/patternfly-org/issues/3860)) ([1695209](https://github.com/patternfly/patternfly-org/commit/169520944b7c3dccf69709e6e2075b9153fce059))





## 5.3.17 (2024-01-05)

**Note:** Version bump only for package @patternfly/documentation-framework





## 5.3.16 (2024-01-03)

**Note:** Version bump only for package @patternfly/documentation-framework





## 5.3.15 (2023-12-14)

**Note:** Version bump only for package @patternfly/documentation-framework
Expand Down
14 changes: 7 additions & 7 deletions packages/documentation-framework/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@patternfly/documentation-framework",
"description": "A framework to build documentation for PatternFly.",
"version": "5.3.15",
"version": "5.3.22",
"author": "Red Hat",
"license": "MIT",
"private": false,
Expand All @@ -17,7 +17,7 @@
"@babel/plugin-transform-react-jsx": "7.17.12",
"@babel/preset-env": "7.18.2",
"@mdx-js/util": "1.6.16",
"@patternfly/ast-helpers": "^1.3.15",
"@patternfly/ast-helpers": "^1.3.22",
"@reach/router": "npm:@gatsbyjs/[email protected]",
"autoprefixer": "9.8.6",
"babel-loader": "9.1.2",
Expand Down Expand Up @@ -51,7 +51,7 @@
"postcss": "8.4.32",
"postcss-loader": "7.1.0",
"process": "^0.11.10",
"puppeteer": "19.7.3",
"puppeteer": "19.11.1",
"puppeteer-cluster": "0.23.0",
"react-docgen": "5.3.1",
"react-monaco-editor": "^0.51.0",
Expand Down Expand Up @@ -80,10 +80,10 @@
"webpack-merge": "5.8.0"
},
"peerDependencies": {
"@patternfly/patternfly": "5.1.0",
"@patternfly/react-code-editor": "5.1.1",
"@patternfly/react-core": "5.1.1",
"@patternfly/react-table": "5.1.1",
"@patternfly/patternfly": "5.2.0-prerelease.7",
"@patternfly/react-code-editor": "5.2.0-prerelease.48",
"@patternfly/react-core": "5.2.0-prerelease.47",
"@patternfly/react-table": "5.2.0-prerelease.47",
"react": "^17.0.0 || ^18.0.0",
"react-dom": "^17.0.0 || ^18.0.0"
}
Expand Down
25 changes: 24 additions & 1 deletion packages/documentation-framework/versions.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,32 @@
{
"Releases": [
{
"name": "5.2.0",
"date": "2024-01-17",
"latest": true,
"versions": {
"@patternfly/patternfly": "5.1.0",
"@patternfly/react-charts": "7.1.1",
"@patternfly/react-code-editor": "5.1.1",
"@patternfly/react-core": "5.1.1",
"@patternfly/react-icons": "5.1.1",
"@patternfly/react-styles": "5.1.1",
"@patternfly/react-table": "5.1.1",
"@patternfly/react-drag-drop": "5.0.0-alpha.0",
"@patternfly/react-tokens": "5.1.1",
"@patternfly/react-catalog-view-extension": "5.0.0",
"@patternfly/react-component-groups": "5.0.0",
"@patternfly/react-console": "5.0.0",
"@patternfly/react-log-viewer": "5.0.0",
"@patternfly/react-topology": "5.1.0",
"@patternfly/react-user-feedback": "5.0.0",
"@patternfly/react-virtualized-extension": "5.0.0",
"@patternfly/quickstarts": "5.0.0"
}
},{
"name": "5.1.0",
"date": "2023-10-06",
"latest": true,
"hidden": true,
"versions": {
"@patternfly/patternfly": "5.1.0",
"@patternfly/react-charts": "7.1.1",
Expand Down
8 changes: 4 additions & 4 deletions packages/documentation-site/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@
"screenshots": "pf-docs-framework screenshots"
},
"dependencies": {
"@patternfly/documentation-framework": "^5.2.15",
"@patternfly/documentation-framework": "^5.3.20",
"@patternfly/quickstarts": "^5.1.0",
"@patternfly/react-catalog-view-extension": "5.0.0",
"@patternfly/react-console": "5.0.0",
"@patternfly/react-docs": "6.1.1",
"@patternfly/react-docs": "6.2.0-prerelease.49",
"@patternfly/react-log-viewer": "5.1.0-prerelease.1",
"@patternfly/react-topology": "5.2.0-prerelease.1",
"@patternfly/react-topology": "5.2.0-prerelease.3",
"@patternfly/react-user-feedback": "5.0.0",
"@patternfly/react-component-groups": "5.0.0",
"@patternfly/react-component-groups": "5.1.0-prerelease.2",
"@patternfly/react-virtualized-extension": "5.0.0",
"react": "^17.0.0 || ^18.0.0",
"react-dom": "^17.0.0 || ^18.0.0",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: About
id: About charts
section: charts
---

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
@@ -1,5 +1,5 @@
---
id: About
id: About UX writing
section: UX writing
sortValue: 1

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
id: Design for accessibility
section: accessibility
---

import { Card, CardBody, Grid, GridItem } from '@patternfly/react-core';

As described in our [accessibility fundamentals](/accessibility/accessibility-fundamentals), users may interact with your product through a variety of assistive technologies. In addition to [developing for accessibility](/accessibility/accessibility-development), you must also incorporate it into your product's visual design.

## Color and contrast

Color and contrast go hand-in-hand for visual design accessibility.

For example, you should consider contrast when using colors commonly affected by color perception deficiency (such as those described in ["Overview of Low Vision" by W3C](https://www.w3.org/WAI/GL/low-vision-a11y-tf/wiki/Overview_of_Low_Vision#Color_Perception)). Different colors in a UI should be distinguishable for users across the color perception deficiency spectrum, typically by ensuring that each color has a different contrast weight.

Designing with contrast in mind also benefits users with light sensitivity.

PatternFly components use [our color palettes](/design-foundations/colors) to pass color contrast tests. As long as you follow our recommendations, any UI built with PatternFly components should have proper contrast between colors, making them distinguishable for users with different types of color perception and light sensitivity.

It's important not to solely rely on color for conveying information. Even though PatternFly components pass color contrast tests, they also use icons to further help with identification, which can be especially helpful for users with a form of color blindness.

<br />
<img src="./ally-color-example.png" alt="Two sets of alert components being compared, one displayed as normal and the other displayed with red-green color blindness emulated." width="600px"/>
<br />
<br />

If you go beyond our recommendations to combine PatternFly colors in other ways, please be sure to check your color contrast with a contrast checker. When you alter the colors and/or icons used in PatternFly components, know that they may no longer be accessible for all users.

<br />
<img src="./ally-contrast-example.png" alt="A set of alert components displayed with red-green color blindness emulated. These alert components are not clear or distinguishable, because they use poor color contrast and irrelevant icons." width="600px" />

## Content

The text in your UI should also be accessible to users with low vision. For example, links should be descriptive and concise, essential content should not be hidden in the UI, and text should scale appropriately as the UI window is resized or magnified.

To help simplify and strengthen the way that users process content, it is important to carefully consider your text size, font, letter spacing, margins, and spacing. PatternFly supports accessibility in these areas through our [typography](/design-foundations/typography) and [spacing](/design-foundations/spacers) guidelines.

## Understanding low vision

In addition to following the previous recommendations, it is helpful to develop an understanding of low-vision users, so that their needs are a key concern as you design.

**Low vision** refers to any visual impairment that impedes a person’s ability to perform everyday tasks, which cannot be corrected with glasses, contacts, medicine, or surgery.

There are 4 types of limitations as a result of low vision.

1. **Visual acuity**: A measure of a person's visual sharpness, with 20/20 being the standard.
1. **Field of vision**: The area of vision that people can see clearly when their eyes are in a fixed position. Some users have a restricted field of vision, such as central or peripheral field loss.
1. **Color perception**: How people see colors. Some of your users may have deficiencies in color perception that affects their ability to see certain colors. This is commonly called "color blindness", but many people with color perception deficiencies can still see most colors.
1. **Contrast and light sensitivity**: The way that people perceive luminance (the contrast of foreground and background).

We do our best to make PatternFly accessible for low-vision users by default, but it is important that you consciously design with these needs in mind to ensure that your final design has proper color, contrast, and content accessibility.
Loading

0 comments on commit 88e06bb

Please sign in to comment.