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.

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

fix(ToggleSkeleton): fix issue with ToggleSkeleton style #13963

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -1186,6 +1186,16 @@
"contributions": [
"code"
]
},
{
"login": "modaslam",
"name": "Mohammed Aslam P. A.",
"avatar_url": "https://avatars.githubusercontent.com/u/33179527?v=4",
"profile": "https://github.com/modaslam",
"contributions": [
"code",
"doc"
]
}
],
"commitConvention": "none"
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,7 @@ check out our [Contributing Guide](/.github/CONTRIBUTING.md) and our
<td align="center"><a href="http://www.steveblackonline.com/"><img src="https://avatars.githubusercontent.com/u/7853451?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Steven Black</b></sub></a><br /><a href="https://github.com/carbon-design-system/carbon/commits?author=sjbeatle" title="Code">💻</a> <a href="#a11y-sjbeatle" title="Accessibility">️️️️♿️</a></td>
<td align="center"><a href="https://github.com/mrkjdy"><img src="https://avatars.githubusercontent.com/u/32761859?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mark Judy</b></sub></a><br /><a href="https://github.com/carbon-design-system/carbon/commits?author=mrkjdy" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/anton-tsymuk-viacomcbs"><img src="https://avatars.githubusercontent.com/u/112623876?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Anton Tsymuk</b></sub></a><br /><a href="https://github.com/carbon-design-system/carbon/commits?author=anton-tsymuk-viacomcbs" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/modaslam"><img src="https://avatars.githubusercontent.com/u/33179527?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mohammed Aslam P. A.</b></sub></a><br /><a href="https://github.com/carbon-design-system/carbon/commits?author=modaslam" title="Code">💻</a> <a href="https://github.com/carbon-design-system/carbon/commits?author=modaslam" title="Documentation">📖</a></td>
</tr>
</table>

Expand Down
8 changes: 8 additions & 0 deletions e2e/components/Toggle/Toggle-test.e2e.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ test.describe('Toggle', () => {
theme,
});
});

test('skeleton @vrt', async ({ page }) => {
await snapshotStory(page, {
component: 'Toggle',
id: 'components-toggle--skeleton',
theme,
});
});
});
});

Expand Down
20 changes: 0 additions & 20 deletions packages/react/__tests__/__snapshots__/PublicAPI-test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -9086,33 +9086,13 @@ Map {
},
},
"ToggleSkeleton" => Object {
"defaultProps": Object {
"aria-label": "Toggle is loading",
"size": "md",
},
"propTypes": Object {
"aria-label": Object {
"isRequired": true,
"type": "string",
},
"className": Object {
"type": "string",
},
"id": Object {
"type": "string",
},
"labelText": Object {
"type": "string",
},
"size": Object {
"args": Array [
Array [
"sm",
"md",
],
],
"type": "oneOf",
},
},
},
"ToggleSmallSkeleton" => Object {
Expand Down
125 changes: 28 additions & 97 deletions packages/react/src/components/Toggle/Toggle.Skeleton.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,106 +8,37 @@
import PropTypes from 'prop-types';
import React from 'react';
import cx from 'classnames';
import { PrefixContext } from '../../internal/usePrefix';
import { usePrefix } from '../../internal/usePrefix';

type ToggleSkeletonProps = {
'aria-label': string;

/**
* Specify an optional className to add to the form item wrapper.
*/
interface ToggleSkeletonProps {
'aria-label'?: string;
className?: string;

/**
* Provide an id that unique represents the underlying `<input>`
*/
id?: string;

/**
* Provide the text that will be read by a screen reader when visiting this
* control
* `aria-label` is always required but will be null if `labelText` is also
* provided
*/
labelText?: string;

/**
* Specify the size of the Toggle. Currently only supports 'sm' or 'md' (default)
*/
size?: 'sm' | 'md';
} & React.HTMLAttributes<HTMLDivElement>;

class ToggleSkeleton extends React.Component<ToggleSkeletonProps> {
static propTypes = {
['aria-label']: PropTypes.string.isRequired,

/**
* Specify an optional className to add to the form item wrapper.
*/
className: PropTypes.string,
/**
* Provide an id that unique represents the underlying `<input>`
*/
id: PropTypes.string,

/**
* Provide the text that will be read by a screen reader when visiting this
* control
* `aria-label` is always required but will be undefined if `labelText` is also
* provided
*/
labelText: PropTypes.string,

/**
* Specify the size of the Toggle. Currently only supports 'sm' or 'md' (default)
*/
size: PropTypes.oneOf(['sm', 'md']),
};

static defaultProps: Partial<ToggleSkeletonProps> = {
['aria-label']: 'Toggle is loading',
size: 'md',
};

render() {
const { id, labelText, className, size, ...rest } = this.props;

return (
<PrefixContext.Consumer>
{(prefix) => {
const toggleInputClassNames = cx(
`${prefix}--toggle ${prefix}--skeleton`,
{
[`${prefix}--toggle-input--small`]: size === 'sm',
}
);

return (
<div className={cx(`${prefix}--form-item`, className)} {...rest}>
<input
type="checkbox"
id={id}
className={toggleInputClassNames}
/>

<label
className={`${prefix}--toggle-input__label`}
htmlFor={id}
aria-label={labelText ? undefined : this.props['aria-label']}>
{labelText ? <div>{labelText}</div> : null}
<span className={`${prefix}--toggle__switch`}>
<span className={`${prefix}--toggle__text--left`} />
<span className={`${prefix}--toggle__appearance`} />
<span className={`${prefix}--toggle__text--right`} />
</span>
</label>
</div>
);
}}
</PrefixContext.Consumer>
);
}
}

const ToggleSkeleton: React.FC<ToggleSkeletonProps> = ({
'aria-label': ariaLabel = 'Toggle is loading',
className,
...rest
}) => {
const prefix = usePrefix();

const skeletonClassNames = cx(
`${prefix}--toggle ${prefix}--toggle--skeleton`,
className
);

return (
<div className={skeletonClassNames} {...rest} aria-label={ariaLabel}>
<div className={`${prefix}--toggle__skeleton-circle`} />
<div className={`${prefix}--toggle__skeleton-rectangle`} />
</div>
);
};

ToggleSkeleton.propTypes = {
'aria-label': PropTypes.string,
className: PropTypes.string,
};

export default ToggleSkeleton;
export { ToggleSkeleton };
8 changes: 7 additions & 1 deletion packages/react/src/components/Toggle/Toggle.stories.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import React from 'react';

import { VStack } from '../Stack';
import Toggle from '../Toggle';
import Toggle, { ToggleSkeleton } from '../Toggle';

export default {
title: 'Components/Toggle',
Expand Down Expand Up @@ -106,3 +106,9 @@ export const WithAcessibleLabels = () => (
</div>
</VStack>
);

export const Skeleton = () => (
<div>
<ToggleSkeleton aria-label="Toggle is loading" />
</div>
);
francinelucca marked this conversation as resolved.
Show resolved Hide resolved
22 changes: 22 additions & 0 deletions packages/styles/scss/components/toggle/_toggle.scss
Original file line number Diff line number Diff line change
Expand Up @@ -194,4 +194,26 @@
.#{$prefix}--toggle__switch {
@include high-contrast-mode('focus');
}

// Skeleton state
.#{$prefix}--toggle--skeleton {
display: flex;
align-items: center;
}

.#{$prefix}--toggle--skeleton .#{$prefix}--toggle__skeleton-circle {
@include circular-skeleton;

width: rem(18px);
height: rem(18px);
border-radius: 50%;
}

.#{$prefix}--toggle--skeleton .#{$prefix}--toggle__skeleton-rectangle {
@include skeleton;

width: rem(24px);
height: rem(8px);
margin-left: rem(8px);
}
}
25 changes: 25 additions & 0 deletions packages/styles/scss/utilities/_skeleton.scss
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,28 @@
}
}
}

/// Circular Skeleton loading animation
/// @access public
/// @example @include circular-skeleton;
/// @group utilities
@mixin circular-skeleton {
position: relative;
overflow: hidden;
background: $skeleton-background;
border-radius: 50%;

&::before {
position: absolute;
width: 200%;
height: 100%;
animation: 3000ms ease-in-out skeleton infinite;
background: $skeleton-element;
content: '';
will-change: transform-origin, transform, opacity;

@media (prefers-reduced-motion: reduce) {
animation: none;
}
}
}
Loading