Skip to content

Commit

Permalink
[docs] Mark toolbar for assistive technology (#20158)
Browse files Browse the repository at this point in the history
  • Loading branch information
eps1lon authored Mar 19, 2020
1 parent f1831df commit 5fc9926
Show file tree
Hide file tree
Showing 146 changed files with 333 additions and 308 deletions.
42 changes: 33 additions & 9 deletions docs/src/modules/components/Demo.js
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,13 @@ const styles = theme => ({
padding: theme.spacing(3),
},
},
demoHiddenHeader: {
demoHiddenToolbar: {
paddingTop: theme.spacing(2),
[theme.breakpoints.up('sm')]: {
paddingTop: theme.spacing(3),
},
},
header: {
toolbar: {
display: 'none',
[theme.breakpoints.up('sm')]: {
display: 'flex',
Expand All @@ -101,7 +101,7 @@ const styles = theme => ({
},
justifyContent: 'space-between',
},
headerButtons: {
toolbarButtons: {
margin: '2px 0',
},
code: {
Expand Down Expand Up @@ -152,6 +152,21 @@ function getDemoData(codeVariant, demo, githubLocation) {
};
}

// TODO: replace with React.useOpaqueReference if it is released
function useUniqueId(prefix) {
// useOpaqueReference
const [id, setDemoId] = React.useState(null);
React.useEffect(() => {
setDemoId(
Math.random()
.toString(36)
.slice(2),
);
}, []);

return `${prefix}${id}`;
}

function Demo(props) {
const { classes, demo, demoOptions, githubLocation } = props;
const dispatch = useDispatch();
Expand Down Expand Up @@ -309,7 +324,7 @@ function Demo(props) {

const jsx = getJsxPreview(demoData.raw || '');
const showPreview =
!demoOptions.hideHeader &&
!demoOptions.hideToolbar &&
demoOptions.defaultCodeOpen !== false &&
jsx !== demoData.raw &&
jsx.split(/\n/).length <= 17;
Expand All @@ -321,11 +336,14 @@ function Demo(props) {
showCodeLabel = showPreview ? t('showFullSource') : t('showSource');
}

const demoSourceId = useUniqueId(`demo-`);
const openDemoSource = codeOpen || showPreview;

return (
<div className={classes.root}>
<div
className={clsx(classes.demo, {
[classes.demoHiddenHeader]: demoOptions.hideHeader,
[classes.demoHiddenToolbar]: demoOptions.hideToolbar,
[classes.demoBgOutlined]: demoOptions.bg === 'outlined',
[classes.demoBgTrue]: demoOptions.bg === true,
[classes.demoBgInline]: demoOptions.bg === 'inline',
Expand All @@ -343,8 +361,13 @@ function Demo(props) {
</div>
<div className={classes.anchorLink} id={`${demoName}.js`} />
<div className={classes.anchorLink} id={`${demoName}.tsx`} />
{demoOptions.hideHeader ? null : (
<div className={classes.header}>
{demoOptions.hideToolbar ? null : (
<div
aria-controls={openDemoSource ? demoSourceId : null}
aria-label={t('demoToolbarLabel')}
className={classes.toolbar}
role="toolbar"
>
<NoSsr>
<DemoLanguages
demo={demo}
Expand All @@ -353,7 +376,7 @@ function Demo(props) {
gaEventLabel={demoOptions.demo}
onLanguageClick={handleCodeLanguageClick}
/>
<div className={classes.headerButtons}>
<div className={classes.toolbarButtons}>
<Tooltip
classes={{ popper: classes.tooltip }}
key={showSourceHint}
Expand Down Expand Up @@ -471,9 +494,10 @@ function Demo(props) {
</NoSsr>
</div>
)}
<Collapse in={codeOpen || showPreview} unmountOnExit>
<Collapse in={openDemoSource} unmountOnExit>
<MarkdownElement
className={classes.code}
id={demoSourceId}
text={`\`\`\`${demoData.sourceLanguage}\n${codeOpen ? demoData.raw : jsx}\n\`\`\``}
/>
</Collapse>
Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/components/badges/badges-de.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ You can use the `overlap` property to place the badge relative to the corner of

You can use the `anchorOrigin` prop to move the badge to any corner of the wrapped element.

{{"demo": "pages/components/badges/BadgeAlignment.js", "hideHeader": true}}
{{"demo": "pages/components/badges/BadgeAlignment.js", "hideToolbar": true}}
2 changes: 1 addition & 1 deletion docs/src/pages/components/badges/badges-es.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ Usted puede usar la propiedad `overlap` para establecer el Badge relativo a la e

Usted puede usar la propiedad `anchorOrigin` para mover el Badge a cualquier esquina del elemento envuelto.

{{"demo": "pages/components/badges/BadgeAlignment.js", "hideHeader": true}}
{{"demo": "pages/components/badges/BadgeAlignment.js", "hideToolbar": true}}
2 changes: 1 addition & 1 deletion docs/src/pages/components/badges/badges-fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ You can use the `overlap` property to place the badge relative to the corner of

You can use the `anchorOrigin` prop to move the badge to any corner of the wrapped element.

{{"demo": "pages/components/badges/BadgeAlignment.js", "hideHeader": true}}
{{"demo": "pages/components/badges/BadgeAlignment.js", "hideToolbar": true}}
2 changes: 1 addition & 1 deletion docs/src/pages/components/badges/badges-ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ You can use the `overlap` property to place the badge relative to the corner of

You can use the `anchorOrigin` prop to move the badge to any corner of the wrapped element.

{{"demo": "pages/components/badges/BadgeAlignment.js", "hideHeader": true}}
{{"demo": "pages/components/badges/BadgeAlignment.js", "hideToolbar": true}}
2 changes: 1 addition & 1 deletion docs/src/pages/components/badges/badges-pt.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ You can use the `overlap` property to place the badge relative to the corner of

You can use the `anchorOrigin` prop to move the badge to any corner of the wrapped element.

{{"demo": "pages/components/badges/BadgeAlignment.js", "hideHeader": true}}
{{"demo": "pages/components/badges/BadgeAlignment.js", "hideToolbar": true}}
2 changes: 1 addition & 1 deletion docs/src/pages/components/badges/badges-ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ components: Badge

Вы можете использовать проп `anchorOrigin` для перемещения значка в любой угол элемента.

{{"demo": "pages/components/badges/BadgeAlignment.js", "hideHeader": true}}
{{"demo": "pages/components/badges/BadgeAlignment.js", "hideToolbar": true}}
2 changes: 1 addition & 1 deletion docs/src/pages/components/badges/badges-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ You can use the `overlap` property to place the badge relative to the corner of

You can use the `anchorOrigin` prop to move the badge to any corner of the wrapped element.

{{"demo": "pages/components/badges/BadgeAlignment.js", "hideHeader": true}}
{{"demo": "pages/components/badges/BadgeAlignment.js", "hideToolbar": true}}
2 changes: 1 addition & 1 deletion docs/src/pages/components/badges/badges.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ You can use the `overlap` property to place the badge relative to the corner of

You can use the `anchorOrigin` prop to move the badge to any corner of the wrapped element.

{{"demo": "pages/components/badges/BadgeAlignment.js", "hideHeader": true}}
{{"demo": "pages/components/badges/BadgeAlignment.js", "hideToolbar": true}}
4 changes: 2 additions & 2 deletions docs/src/pages/components/chips/chips-de.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ Sie können die Requisite `size` verwenden, um einen kleinen Chip zu definieren.

## Chip Spielwiese

{{"demo": "pages/components/chips/ChipsPlayground.js", "hideHeader": true}}
{{"demo": "pages/components/chips/ChipsPlayground.js", "hideToolbar": true}}

## Barrierefreiheit

If the Chip is deletable or clickable then it is a button in tab order. When the Chip is focused (e.g. when tabbing) releasing (`keyup` event) `Backspace` or `Delete` will call the `onDelete` handler while releasing `Escape` will blur the Chip.
If the Chip is deletable or clickable then it is a button in tab order. When the Chip is focused (e.g. when tabbing) releasing (`keyup` event) `Backspace` or `Delete` will call the `onDelete` handler while releasing `Escape` will blur the Chip.
4 changes: 2 additions & 2 deletions docs/src/pages/components/chips/chips-es.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ You can use the `size` prop to define a small Chip.

## Chip Playground

{{"demo": "pages/components/chips/ChipsPlayground.js", "hideHeader": true}}
{{"demo": "pages/components/chips/ChipsPlayground.js", "hideToolbar": true}}

## Accesibilidad

If the Chip is deletable or clickable then it is a button in tab order. When the Chip is focused (e.g. when tabbing) releasing (`keyup` event) `Backspace` or `Delete` will call the `onDelete` handler while releasing `Escape` will blur the Chip.
If the Chip is deletable or clickable then it is a button in tab order. When the Chip is focused (e.g. when tabbing) releasing (`keyup` event) `Backspace` or `Delete` will call the `onDelete` handler while releasing `Escape` will blur the Chip.
4 changes: 2 additions & 2 deletions docs/src/pages/components/chips/chips-fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ You can use the `size` prop to define a small Chip.

## Terrain de jeu de puce

{{"demo": "pages/components/chips/ChipsPlayground.js", "hideHeader": true}}
{{"demo": "pages/components/chips/ChipsPlayground.js", "hideToolbar": true}}

## Accessibilité

If the Chip is deletable or clickable then it is a button in tab order. When the Chip is focused (e.g. when tabbing) releasing (`keyup` event) `Backspace` or `Delete` will call the `onDelete` handler while releasing `Escape` will blur the Chip.
If the Chip is deletable or clickable then it is a button in tab order. When the Chip is focused (e.g. when tabbing) releasing (`keyup` event) `Backspace` or `Delete` will call the `onDelete` handler while releasing `Escape` will blur the Chip.
4 changes: 2 additions & 2 deletions docs/src/pages/components/chips/chips-ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ Outlined chipsは代替スタイルを提供します。

## Chip Playground

{{"demo": "pages/components/chips/ChipsPlayground.js", "hideHeader": true}}
{{"demo": "pages/components/chips/ChipsPlayground.js", "hideToolbar": true}}

## アクセシビリティ

If the Chip is deletable or clickable then it is a button in tab order. When the Chip is focused (e.g. when tabbing) releasing (`keyup` event) `Backspace` or `Delete` will call the `onDelete` handler while releasing `Escape` will blur the Chip.
If the Chip is deletable or clickable then it is a button in tab order. When the Chip is focused (e.g. when tabbing) releasing (`keyup` event) `Backspace` or `Delete` will call the `onDelete` handler while releasing `Escape` will blur the Chip.
4 changes: 2 additions & 2 deletions docs/src/pages/components/chips/chips-pt.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ Você pode usar a propriedade `size` para definir um Chip pequeno.

## Chip - Live Demo

{{"demo": "pages/components/chips/ChipsPlayground.js", "hideHeader": true}}
{{"demo": "pages/components/chips/ChipsPlayground.js", "hideToolbar": true}}

## Acessibilidade

If the Chip is deletable or clickable then it is a button in tab order. When the Chip is focused (e.g. when tabbing) releasing (`keyup` event) `Backspace` or `Delete` will call the `onDelete` handler while releasing `Escape` will blur the Chip.
If the Chip is deletable or clickable then it is a button in tab order. When the Chip is focused (e.g. when tabbing) releasing (`keyup` event) `Backspace` or `Delete` will call the `onDelete` handler while releasing `Escape` will blur the Chip.
4 changes: 2 additions & 2 deletions docs/src/pages/components/chips/chips-ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ components: Chip

## Песочница

{{"demo": "pages/components/chips/ChipsPlayground.js", "hideHeader": true}}
{{"demo": "pages/components/chips/ChipsPlayground.js", "hideToolbar": true}}

## Доступность

If the Chip is deletable or clickable then it is a button in tab order. When the Chip is focused (e.g. when tabbing) releasing (`keyup` event) `Backspace` or `Delete` will call the `onDelete` handler while releasing `Escape` will blur the Chip.
If the Chip is deletable or clickable then it is a button in tab order. When the Chip is focused (e.g. when tabbing) releasing (`keyup` event) `Backspace` or `Delete` will call the `onDelete` handler while releasing `Escape` will blur the Chip.
4 changes: 2 additions & 2 deletions docs/src/pages/components/chips/chips-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ components: Chip

## 在线编译纸片组件

{{"demo": "pages/components/chips/ChipsPlayground.js", "hideHeader": true}}
{{"demo": "pages/components/chips/ChipsPlayground.js", "hideToolbar": true}}

## 可访问性

If the Chip is deletable or clickable then it is a button in tab order. When the Chip is focused (e.g. when tabbing) releasing (`keyup` event) `Backspace` or `Delete` will call the `onDelete` handler while releasing `Escape` will blur the Chip.
If the Chip is deletable or clickable then it is a button in tab order. When the Chip is focused (e.g. when tabbing) releasing (`keyup` event) `Backspace` or `Delete` will call the `onDelete` handler while releasing `Escape` will blur the Chip.
2 changes: 1 addition & 1 deletion docs/src/pages/components/chips/chips.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ You can use the `size` prop to define a small Chip.

## Chip Playground

{{"demo": "pages/components/chips/ChipsPlayground.js", "hideHeader": true}}
{{"demo": "pages/components/chips/ChipsPlayground.js", "hideToolbar": true}}

## Accessibility

Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/components/grid/grid-de.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Für einige Spalten sind mehrere Breiten definiert, wodurch sich das Layout am d

Nachfolgend finden Sie eine interaktive Demo, mit der Sie die visuellen Ergebnisse der verschiedenen Einstellungen untersuchen können:

{{"demo": "pages/components/grid/InteractiveGrid.js", "hideHeader": true, "bg": true}}
{{"demo": "pages/components/grid/InteractiveGrid.js", "hideToolbar": true, "bg": true}}

## Automatisches Layout

Expand Down Expand Up @@ -120,4 +120,4 @@ Obwohl die `Grid-` Komponente eine `direction-` Eigenschaft hat, die Werte von `

Die Material-UI bietet selbst keine CSS-Grid-Funktionalität. Wie Sie jedoch unten sehen, können Sie CSS-Grid einfach zum Layout Ihrer Seiten hinzufügen.

{{"demo": "pages/components/grid/CSSGrid.js", "bg": true}}
{{"demo": "pages/components/grid/CSSGrid.js", "bg": true}}
4 changes: 2 additions & 2 deletions docs/src/pages/components/grid/grid-es.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Algunas columnas tienen varios anchos definidos, causando que el layout cambie e

Debajo de esta línea hay una demostración interactiva que permite explorar el resultado visual de las distintas configuraciones:

{{"demo": "pages/components/grid/InteractiveGrid.js", "hideHeader": true, "bg": true}}
{{"demo": "pages/components/grid/InteractiveGrid.js", "hideToolbar": true, "bg": true}}

## Auto-layout

Expand Down Expand Up @@ -120,4 +120,4 @@ Though the `Grid` component has a `direction` property that allows values of `ro

Material-UI doesn't provide any CSS Grid functionality itself, but as seen below you can easily use CSS Grid to layout your pages.

{{"demo": "pages/components/grid/CSSGrid.js", "bg": true}}
{{"demo": "pages/components/grid/CSSGrid.js", "bg": true}}
4 changes: 2 additions & 2 deletions docs/src/pages/components/grid/grid-fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Plusieurs colonnes ont plusieurs largeurs définies, ce qui entraîne une modifi

Vous trouverez ci-dessous une démo interactive vous permettant d'explorer les résultats visuels des différents paramètres:

{{"demo": "pages/components/grid/InteractiveGrid.js", "hideHeader": true, "bg": true}}
{{"demo": "pages/components/grid/InteractiveGrid.js", "hideToolbar": true, "bg": true}}

## Mise en page automatique

Expand Down Expand Up @@ -120,4 +120,4 @@ Bien que le composant `Grid` ait une propriété `direction` qui autorise les va

Material-UI ne fournit aucune fonctionnalité de grille CSS, mais comme illustré ci-dessous, vous pouvez facilement utiliser CSS Grid pour mettre en page vos pages.

{{"demo": "pages/components/grid/CSSGrid.js", "bg": true}}
{{"demo": "pages/components/grid/CSSGrid.js", "bg": true}}
4 changes: 2 additions & 2 deletions docs/src/pages/components/grid/grid-ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Fluid gridsでは、コンテンツの尺度とサイズを変更する列を使

以下は、さまざまな設定の視覚的な結果を調べることができるインタラクティブなデモです。

{{"demo": "pages/components/grid/InteractiveGrid.js", "hideHeader": true, "bg": true}}
{{"demo": "pages/components/grid/InteractiveGrid.js", "hideToolbar": true, "bg": true}}

## 自動レイアウト

Expand Down Expand Up @@ -120,4 +120,4 @@ https://www.w3.org/TR/css-flexbox-1/#box-model

Material-UI自体はCSSグリッド機能自体を提供しませんが、以下に示すように、CSSグリッドを使用してページをレイアウトすることは簡単にできます。

{{"demo": "pages/components/grid/CSSGrid.js", "bg": true}}
{{"demo": "pages/components/grid/CSSGrid.js", "bg": true}}
4 changes: 2 additions & 2 deletions docs/src/pages/components/grid/grid-pt.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Algumas colunas têm várias larguras definidas, fazendo com que o leiaute seja

Abaixo está uma demonstração interativa que permite explorar os resultados visuais das diferentes configurações:

{{"demo": "pages/components/grid/InteractiveGrid.js", "hideHeader": true, "bg": true}}
{{"demo": "pages/components/grid/InteractiveGrid.js", "hideToolbar": true, "bg": true}}

## Leiaute Automático

Expand Down Expand Up @@ -120,4 +120,4 @@ Embora o componente `Grid` tenha uma propriedade `direction` que permite valores

Material-UI não fornece nenhuma funcionalidade CSS de Grade, mas como pode ser visto abaixo, você pode facilmente usar leiaute de Grade CSS em suas páginas.

{{"demo": "pages/components/grid/CSSGrid.js", "bg": true}}
{{"demo": "pages/components/grid/CSSGrid.js", "bg": true}}
4 changes: 2 additions & 2 deletions docs/src/pages/components/grid/grid-ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ components: Grid

Ниже приведен интерактивный пример, который демонстрирует результаты различных настроек сетки:

{{"demo": "pages/components/grid/InteractiveGrid.js", "hideHeader": true, "bg": true}}
{{"demo": "pages/components/grid/InteractiveGrid.js", "hideToolbar": true, "bg": true}}

## Авто-разметка

Expand Down Expand Up @@ -120,4 +120,4 @@ https://www.w3.org/TR/css-flexbox-1/#box-model

Material UI сам по себе не предоставляет никакой функциональности CSS Grid, но, как видно ниже, вы можете легко использовать CSS Grid в макете страницы.

{{"demo": "pages/components/grid/CSSGrid.js", "bg": true}}
{{"demo": "pages/components/grid/CSSGrid.js", "bg": true}}
4 changes: 2 additions & 2 deletions docs/src/pages/components/grid/grid-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ components: Grid

下面是一个交互式的演示,您可让探索不同设置下的视觉结果:

{{"demo": "pages/components/grid/InteractiveGrid.js", "hideHeader": true, "bg": true}}
{{"demo": "pages/components/grid/InteractiveGrid.js", "hideToolbar": true, "bg": true}}

## 自动布局

Expand Down Expand Up @@ -120,4 +120,4 @@ https://www.w3.org/TR/css-flexbox-1/#box-model

Material-UI 本身不提供任何 CSS Grid 功能,但如下所示,您可以轻松使用 CSS Grid 来布局您的页面。

{{"demo": "pages/components/grid/CSSGrid.js", "bg": true}}
{{"demo": "pages/components/grid/CSSGrid.js", "bg": true}}
2 changes: 1 addition & 1 deletion docs/src/pages/components/grid/grid.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Some columns have multiple widths defined, causing the layout to change at the d

Below is an interactive demo that lets you explore the visual results of the different settings:

{{"demo": "pages/components/grid/InteractiveGrid.js", "hideHeader": true, "bg": true}}
{{"demo": "pages/components/grid/InteractiveGrid.js", "hideToolbar": true, "bg": true}}

## Auto-layout

Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/components/material-icons/material-icons-de.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ components: Icon, SvgIcon

The following npm package, [@material-ui/icons](https://www.npmjs.com/package/@material-ui/icons), includes the 1,100+ official [Material icons](https://material.io/tools/icons/?style=baseline) converted to [`SvgIcon`](/api/svg-icon/) components.

{{"demo": "pages/components/material-icons/SearchIcons.js", "hideHeader": true, "bg": true}}
{{"demo": "pages/components/material-icons/SearchIcons.js", "hideToolbar": true, "bg": true}}

ℹ️ The search supports synonyms. Try searching for "hamburger", or "logout".
ℹ️ The search supports synonyms. Try searching for "hamburger", or "logout".
4 changes: 2 additions & 2 deletions docs/src/pages/components/material-icons/material-icons-es.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ components: Icon, SvgIcon

The following npm package, [@material-ui/icons](https://www.npmjs.com/package/@material-ui/icons), includes the 1,100+ official [Material icons](https://material.io/tools/icons/?style=baseline) converted to [`SvgIcon`](/api/svg-icon/) components.

{{"demo": "pages/components/material-icons/SearchIcons.js", "hideHeader": true, "bg": true}}
{{"demo": "pages/components/material-icons/SearchIcons.js", "hideToolbar": true, "bg": true}}

ℹ️ La búsqueda admite sinónimos. Intente buscar "hamburger" o "logout".
ℹ️ La búsqueda admite sinónimos. Intente buscar "hamburger" o "logout".
Loading

0 comments on commit 5fc9926

Please sign in to comment.