Spinner: Change spinner icon when prefers-reduced-motion is set (#87641)

* change spinner icon when prefers-reduced-motion is set

* update mock

* remove outdated comment

* fix matchMedia mocks

* update spinner aria label
This commit is contained in:
Ashley Harrison 2024-05-13 11:32:02 +01:00 committed by GitHub
parent 58e554b67f
commit 9bf3adabd8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 61 additions and 34 deletions

View File

@ -6,6 +6,7 @@ import { GrafanaTheme2 } from '@grafana/data';
import { useStyles2 } from '../../themes';
import { IconSize, isIconSize } from '../../types';
import { t } from '../../utils/i18n';
import { Icon } from '../Icon/Icon';
import { getIconRoot, getIconSubDir } from '../Icon/utils';
@ -38,6 +39,8 @@ export const Spinner = ({
const styles = useStyles2(getStyles);
const deprecatedStyles = useStyles2(getDeprecatedStyles, size);
const prefersReducedMotion = window.matchMedia('(prefers-reduced-motion: reduce)').matches;
const iconName = prefersReducedMotion ? 'hourglass' : 'spinner';
// this entire if statement is handling the deprecated size prop
// TODO remove once we fully remove the deprecated type
@ -80,7 +83,17 @@ export const Spinner = ({
className
)}
>
<Icon className={cx('fa-spin', iconClassName)} name="spinner" size={size} aria-label="loading spinner" />
<Icon
className={cx(
{
'fa-spin': !prefersReducedMotion,
},
iconClassName
)}
name={iconName}
size={size}
aria-label={t('grafana-ui.spinner.aria-label', 'Loading')}
/>
</div>
);
};

View File

@ -30,11 +30,14 @@ const renderWithProvider = ({ initialState }: { initialState?: Partial<appTypes.
describe('OrganisationSwitcher', () => {
beforeEach(() => {
(window.matchMedia as jest.Mock).mockImplementation(() => ({
jest.spyOn(window, 'matchMedia').mockImplementation(
() =>
({
addEventListener: jest.fn(),
removeEventListener: jest.fn(),
matches: true,
}));
}) as unknown as MediaQueryList
);
});
it('should only render if more than one organisations', () => {
@ -80,11 +83,14 @@ describe('OrganisationSwitcher', () => {
});
it('should render a picker in mobile screen', () => {
(window.matchMedia as jest.Mock).mockImplementation(() => ({
jest.spyOn(window, 'matchMedia').mockImplementation(
() =>
({
addEventListener: jest.fn(),
removeEventListener: jest.fn(),
matches: false,
}));
}) as unknown as MediaQueryList
);
renderWithProvider({
initialState: {
organization: {

View File

@ -14,11 +14,14 @@ const renderComponent = (options?: { props: TopSearchBarSectionProps }) => {
describe('TopSearchBarSection', () => {
it('should use a wrapper on non mobile screen', () => {
(window.matchMedia as jest.Mock).mockImplementation(() => ({
jest.spyOn(window, 'matchMedia').mockImplementation(
() =>
({
addEventListener: jest.fn(),
removeEventListener: jest.fn(),
matches: true,
}));
}) as unknown as MediaQueryList
);
const component = renderComponent();
@ -27,11 +30,14 @@ describe('TopSearchBarSection', () => {
});
it('should not use a wrapper on mobile screen', () => {
(window.matchMedia as jest.Mock).mockImplementation(() => ({
jest.spyOn(window, 'matchMedia').mockImplementation(
() =>
({
addEventListener: jest.fn(),
removeEventListener: jest.fn(),
matches: false,
}));
}) as unknown as MediaQueryList
);
const component = renderComponent();

View File

@ -618,6 +618,9 @@
"select": {
"no-options-label": "No options found",
"placeholder": "Choose"
},
"spinner": {
"aria-label": "Loading"
}
},
"graph": {

View File

@ -618,6 +618,9 @@
"select": {
"no-options-label": "Ńő őpŧįőʼnş ƒőūʼnđ",
"placeholder": "Cĥőőşę"
},
"spinner": {
"aria-label": "Ŀőäđįʼnģ"
}
},
"graph": {

View File

@ -34,19 +34,15 @@ global.grafanaBootData = {
navTree: [],
};
// https://jestjs.io/docs/manual-mocks#mocking-methods-which-are-not-implemented-in-jsdom
Object.defineProperty(global, 'matchMedia', {
writable: true,
value: jest.fn().mockImplementation((query) => ({
window.matchMedia = (query) => ({
matches: false,
media: query,
onchange: null,
addListener: jest.fn(), // deprecated
removeListener: jest.fn(), // deprecated
addListener: jest.fn(), // Deprecated
removeListener: jest.fn(), // Deprecated
addEventListener: jest.fn(),
removeEventListener: jest.fn(),
dispatchEvent: jest.fn(),
})),
});
angular.module('grafana', ['ngRoute']);