Skip to content
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

Jump to bottom

[Lens] accessibility screen reader issues #84395

Merged
merged 6 commits into from
Dec 3, 2020
Merged

[Lens] accessibility screen reader issues #84395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d9a744c
[Lens] accessibility screen reader issues
mbondyra Nov 25, 2020
c015606
fix i18n
mbondyra Nov 26, 2020
d842c17
fix: no aria-label on divs
mbondyra Nov 30, 2020
f232650
Merge branch 'master' into lens/accessibility-screen-reader
kibanamachine Dec 1, 2020
fa93967
cr fixes
mbondyra Dec 1, 2020
efe3c2d
Merge branch 'master' into lens/accessibility-screen-reader
kibanamachine Dec 3, 2020
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
2 changes: 1 addition & 1 deletion x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/config_panel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ function LayerPanels(
{...props}
key={layerId}
layerId={layerId}
dataTestSubj={`lns-layerPanel-${index}`}
index={index}
visualizationState={visualizationState}
updateVisualization={setVisualizationState}
updateDatasource={updateDatasource}
Expand Down
36 changes: 34 additions & 2 deletions ...ugins/lens/public/editor_frame_service/editor_frame/config_panel/dimension_container.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,39 @@
animation: euiFlyout $euiAnimSpeedNormal $euiAnimSlightResistance;
}

.lnsDimensionContainer__footer,
.lnsDimensionContainer__header {
.lnsDimensionContainer__footer {
padding: $euiSizeS;
}

.lnsDimensionContainer__header {
padding: $euiSizeS $euiSizeXS;
}

.lnsDimensionContainer__headerTitle {
padding: $euiSizeS $euiSizeXS;
cursor: pointer;

&:hover {
text-decoration: underline;
}
}

.lnsDimensionContainer__headerLink {
&:focus-within {
background-color: transparentize($euiColorVis1, .9);

.lnsDimensionContainer__headerTitle {
text-decoration: underline;
}
}
}

.lnsDimensionContainer__backIcon {
&:hover {
transform: none !important; // sass-lint:disable-line no-important
}

&:focus {
background-color: transparent;
}
}
54 changes: 37 additions & 17 deletions ...lugins/lens/public/editor_frame_service/editor_frame/config_panel/dimension_container.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ import {
EuiFlyoutHeader,
EuiFlyoutFooter,
EuiTitle,
EuiButtonIcon,
EuiButtonEmpty,
EuiFlexGroup,
EuiFlexItem,
EuiFocusTrap,
EuiOutsideClickDetector,
Expand Down Expand Up @@ -54,24 +56,42 @@ export function DimensionContainer({
className="lnsDimensionContainer"
>
<EuiFlyoutHeader hasBorder className="lnsDimensionContainer__header">
<EuiTitle size="xs">
<EuiButtonEmpty
onClick={closeFlyout}
data-test-subj="lns-indexPattern-dimensionContainerTitle"
id="lnsDimensionContainerTitle"
iconType="sortLeft"
flush="left"
>
<strong>
{i18n.translate('xpack.lens.configure.configurePanelTitle', {
defaultMessage: '{groupLabel} configuration',
values: {
groupLabel,
},
<EuiFlexGroup
gutterSize="none"
alignItems="center"
className="lnsDimensionContainer__headerLink"
onClick={closeFlyout}
>
<EuiFlexItem grow={false}>
<EuiButtonIcon
Copy link
Contributor

Choose a reason for hiding this comment

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

This looks a little strange because the button has the little y translation on hover while the heading doesn't: Can we make it look like the old version (no translation)?
Kapture 2020-12-01 at 15 26 55

color="text"
data-test-subj="lns-indexPattern-dimensionContainerBack"
className="lnsDimensionContainer__backIcon"
onClick={closeFlyout}
iconType="sortLeft"
aria-label={i18n.translate('xpack.lens.dimensionContainer.closeConfiguration', {
defaultMessage: 'Close configuration',
})}
</strong>
</EuiButtonEmpty>
</EuiTitle>
/>
</EuiFlexItem>
<EuiFlexItem grow={true}>
<EuiTitle size="xs">
<h2
id="lnsDimensionContainerTitle"
className="lnsDimensionContainer__headerTitle"
>
<strong>
{i18n.translate('xpack.lens.configure.configurePanelTitle', {
defaultMessage: '{groupLabel} configuration',
values: {
groupLabel,
},
})}
</strong>
</h2>
</EuiTitle>
</EuiFlexItem>
</EuiFlexGroup>
</EuiFlyoutHeader>
<EuiFlexItem className="eui-yScrollWithShadows" grow={1}>
{panel}
Expand Down
2 changes: 1 addition & 1 deletion ...k/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ describe('LayerPanel', () => {
onRemoveLayer: jest.fn(),
dispatch: jest.fn(),
core: coreMock.createStart(),
dataTestSubj: 'lns_layerPanel-0',
index: 0,
};
}

Expand Down
54 changes: 40 additions & 14 deletions x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ import { DimensionContainer } from './dimension_container';
import { ColorIndicator } from './color_indicator';
import { PaletteIndicator } from './palette_indicator';

const triggerLinkA11yText = (label: string) =>
i18n.translate('xpack.lens.configure.editConfig', {
defaultMessage: 'Click to edit configuration for {label} or drag to move',
values: { label },
});

const initialActiveDimensionState = {
isNew: false,
};
Expand Down Expand Up @@ -58,7 +64,7 @@ function isSameConfiguration(config1: unknown, config2: unknown) {
export function LayerPanel(
props: Exclude<ConfigPanelWrapperProps, 'state' | 'setState'> & {
layerId: string;
dataTestSubj: string;
index: number;
isOnlyLayer: boolean;
updateVisualization: StateSetter<unknown>;
updateDatasource: (datasourceId: string, newState: unknown) => void;
Expand All @@ -75,7 +81,7 @@ export function LayerPanel(
initialActiveDimensionState
);

const { framePublicAPI, layerId, isOnlyLayer, onRemoveLayer, dataTestSubj } = props;
const { framePublicAPI, layerId, isOnlyLayer, onRemoveLayer, index } = props;
const datasourcePublicAPI = framePublicAPI.datasourceLayers[layerId];

useEffect(() => {
Expand Down Expand Up @@ -125,7 +131,11 @@ export function LayerPanel(
const columnLabelMap = layerDatasource.uniqueLabels(layerDatasourceConfigProps.state);
return (
<ChildDragDropProvider {...dragDropContext}>
<EuiPanel data-test-subj={dataTestSubj} className="lnsLayerPanel" paddingSize="s">
<EuiPanel
data-test-subj={`lns-layerPanel-${index}`}
className="lnsLayerPanel"
paddingSize="s"
>
<EuiFlexGroup gutterSize="s" alignItems="flexStart" responsive={false}>
<EuiFlexItem grow={false} className="lnsLayerPanel__settingsFlexItem">
<LayerSettings
Expand Down Expand Up @@ -180,14 +190,10 @@ export function LayerPanel(

<EuiSpacer size="m" />

{groups.map((group, index) => {
{groups.map((group, groupIndex) => {
const newId = generateId();
const isMissing = !isEmptyLayer && group.required && group.accessors.length === 0;

const triggerLinkA11yText = i18n.translate('xpack.lens.configure.editConfig', {
defaultMessage: 'Click to edit configuration or drag to move',
});

return (
<EuiFormRow
className={
Expand All @@ -198,7 +204,7 @@ export function LayerPanel(
fullWidth
label={<div className="lnsLayerPanel__groupLabel">{group.groupLabel}</div>}
labelType="legend"
key={index}
key={groupIndex}
isInvalid={isMissing}
error={
isMissing ? (
Expand Down Expand Up @@ -327,8 +333,8 @@ export function LayerPanel(
});
}
}}
aria-label={triggerLinkA11yText}
title={triggerLinkA11yText}
aria-label={triggerLinkA11yText(columnLabelMap[accessor])}
title={triggerLinkA11yText(columnLabelMap[accessor])}
>
<ColorIndicator accessorConfig={accessorConfig}>
<NativeRenderer
Expand All @@ -351,11 +357,13 @@ export function LayerPanel(
aria-label={i18n.translate(
'xpack.lens.indexPattern.removeColumnLabel',
{
defaultMessage: 'Remove configuration',
defaultMessage: 'Remove configuration from "{groupLabel}"',
values: { groupLabel: group.groupLabel },
}
)}
title={i18n.translate('xpack.lens.indexPattern.removeColumnLabel', {
defaultMessage: 'Remove configuration',
defaultMessage: 'Remove configuration from "{groupLabel}"',
values: { groupLabel: group.groupLabel },
})}
onClick={() => {
trackUiEvent('indexpattern_dimension_removed');
Expand Down Expand Up @@ -435,6 +443,13 @@ export function LayerPanel(
contentProps={{
className: 'lnsLayerPanel__triggerTextContent',
}}
aria-label={i18n.translate(
'xpack.lens.indexPattern.removeColumnAriaLabel',
{
defaultMessage: 'Drop a field or click to add to {groupLabel}',
values: { groupLabel: group.groupLabel },
}
)}
data-test-subj="lns-empty-dimension"
onClick={() => {
if (activeId) {
Expand Down Expand Up @@ -535,6 +550,17 @@ export function LayerPanel(
iconType="trash"
color="danger"
data-test-subj="lnsLayerRemove"
aria-label={
isOnlyLayer
? i18n.translate('xpack.lens.resetLayerAriaLabel', {
defaultMessage: 'Reset layer {index}',
values: { index: index + 1 },
})
: i18n.translate('xpack.lens.deleteLayerAriaLabel', {
defaultMessage: `Delete layer {index}`,
values: { index: index + 1 },
})
}
onClick={() => {
// If we don't blur the remove / clear button, it remains focused
// which is a strange UX in this case. e.target.blur doesn't work
Expand All @@ -554,7 +580,7 @@ export function LayerPanel(
defaultMessage: 'Reset layer',
})
: i18n.translate('xpack.lens.deleteLayer', {
defaultMessage: 'Delete layer',
defaultMessage: `Delete layer`,
})}
</EuiButtonEmpty>
</EuiFlexItem>
Expand Down
4 changes: 3 additions & 1 deletion ...lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel_wrapper.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,9 @@ export function WorkspacePanelWrapper({
<EuiScreenReaderOnly>
<h1 id="lns_ChartTitle" data-test-subj="lns_ChartTitle">
{title ||
i18n.translate('xpack.lens.chartTitle.unsaved', { defaultMessage: 'Unsaved' })}
mbondyra marked this conversation as resolved.
Show resolved Hide resolved
i18n.translate('xpack.lens.chartTitle.unsaved', {
defaultMessage: 'Unsaved visualization',
})}
</h1>
</EuiScreenReaderOnly>
<EuiPageContentBody className="lnsWorkspacePanelWrapper__pageContentBody">
Expand Down
93 changes: 50 additions & 43 deletions x-pack/plugins/lens/public/indexpattern_datasource/field_item.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,49 +181,56 @@ export const InnerFieldItem = function InnerFieldItem(props: FieldItemProps) {
/>
);
return (
<EuiPopover
ownFocus
className="lnsFieldItem__popoverAnchor"
display="block"
data-test-subj="lnsFieldListPanelField"
container={document.querySelector<HTMLElement>('.application') || undefined}
button={
<DragDrop
label={field.displayName}
value={value}
data-test-subj={`lnsFieldListPanelField-${field.name}`}
draggable
>
<FieldButton
className={`lnsFieldItem lnsFieldItem--${field.type} lnsFieldItem--${
exists ? 'exists' : 'missing'
}`}
isActive={infoIsOpen}
onClick={togglePopover}
aria-label={i18n.translate('xpack.lens.indexPattern.fieldStatsButtonAriaLabel', {
defaultMessage: '{fieldName}: {fieldType}. Hit enter for a field preview.',
values: {
fieldName: field.displayName,
fieldType: field.type,
},
})}
fieldIcon={lensFieldIcon}
fieldName={
<EuiHighlight search={wrapOnDot(highlight)}>
{wrapOnDot(field.displayName)}
</EuiHighlight>
}
fieldInfoIcon={lensInfoIcon}
/>
</DragDrop>
}
isOpen={infoIsOpen}
closePopover={() => setOpen(false)}
anchorPosition="rightUp"
panelClassName="lnsFieldItem__fieldPanel"
>
<FieldItemPopoverContents {...state} {...props} />
</EuiPopover>
<li>
<EuiPopover
ownFocus
className="lnsFieldItem__popoverAnchor"
display="block"
data-test-subj="lnsFieldListPanelField"
container={document.querySelector<HTMLElement>('.application') || undefined}
button={
<DragDrop
label={field.displayName}
value={value}
data-test-subj={`lnsFieldListPanelField-${field.name}`}
draggable
>
<FieldButton
className={`lnsFieldItem lnsFieldItem--${field.type} lnsFieldItem--${
exists ? 'exists' : 'missing'
}`}
isActive={infoIsOpen}
onClick={togglePopover}
buttonProps={{
['aria-label']: i18n.translate(
'xpack.lens.indexPattern.fieldStatsButtonAriaLabel',
{
defaultMessage: '{fieldName}: {fieldType}. Hit enter for a field preview.',
values: {
fieldName: field.displayName,
fieldType: field.type,
},
}
),
}}
fieldIcon={lensFieldIcon}
fieldName={
<EuiHighlight search={wrapOnDot(highlight)}>
{wrapOnDot(field.displayName)}
</EuiHighlight>
}
fieldInfoIcon={lensInfoIcon}
/>
</DragDrop>
}
isOpen={infoIsOpen}
closePopover={() => setOpen(false)}
anchorPosition="rightUp"
panelClassName="lnsFieldItem__fieldPanel"
>
<FieldItemPopoverContents {...state} {...props} />
</EuiPopover>
</li>
);
};

Expand Down
Loading