-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[Skeleton] Add skeleton for thumbnails #1041
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| --- | ||
| name: Skeleton thumbnail | ||
| category: Feedback indicators | ||
| releasedIn: 3.7.2 | ||
| keywords: | ||
| - SkeletonThumbnail | ||
| - skeleton | ||
| - loading | ||
| - page | ||
| --- | ||
|
|
||
| # Skeleton image | ||
|
|
||
| Skeleton thumbnail is used to provide a low fidelity representation of an image before it appears on the page, and improves load times perceived by merchants. Use for thumbnails in or outside of a card. | ||
|
|
||
| --- | ||
|
|
||
| ## Best practices | ||
|
|
||
| Skeleton thumbnail component should: | ||
|
|
||
| - Try to match the size of the thumbnail to the content being loaded so it gives an accurate representation. | ||
|
|
||
| --- | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Medium thumbnail | ||
|
|
||
| Use this component to represent medium thumbnails. | ||
|
|
||
| ```jsx | ||
| <SkeletonThumbnail size="medium" /> | ||
| ``` | ||
|
|
||
| ### Large thumbnail | ||
|
|
||
| Use this component to represent large thumbnails. | ||
|
|
||
| ```jsx | ||
| <SkeletonThumbnail size="large" /> | ||
| ``` | ||
|
|
||
| ### Small thumbnail | ||
|
|
||
| Use this component to represent small thumbnails. | ||
|
|
||
| ```jsx | ||
| <SkeletonThumbnail size="small" /> | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Related components | ||
|
|
||
| - Use this component with [Skeleton display text](/components/feedback-indicators/skeleton-display-text) to represent the content of a card while it’s loading. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| @mixin skeleton-thumbnail-size($size) { | ||
| height: $size; | ||
| width: $size; | ||
| } | ||
|
|
||
| .SkeletonThumbnail { | ||
| @include skeleton-shimmer; | ||
| @include skeleton-content; | ||
| } | ||
|
|
||
| .sizeSmall { | ||
| @include skeleton-thumbnail-size(rem(30px)); | ||
| } | ||
|
|
||
| .sizeMedium { | ||
| @include skeleton-thumbnail-size(rem(40px)); | ||
| } | ||
|
|
||
| .sizeLarge { | ||
| @include skeleton-thumbnail-size(rem(50px)); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| import * as React from 'react'; | ||
| import {classNames, variationName} from '@shopify/react-utilities/styles'; | ||
| import styles from './SkeletonThumbnail.scss'; | ||
|
|
||
| export type Size = 'small' | 'medium' | 'large'; | ||
|
|
||
| export interface Props { | ||
| /** | ||
| * Size of the thumbnail | ||
| * @default 'medium' | ||
| */ | ||
| size?: Size; | ||
| } | ||
|
|
||
| export default function SkeletonThumbnail({size = 'medium'}: Props) { | ||
| const className = classNames( | ||
| styles.SkeletonThumbnail, | ||
| size && styles[variationName('size', size)], | ||
| ); | ||
|
|
||
| return <div className={className} />; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| import SkeletonThumbnail from './SkeletonThumbnail'; | ||
|
|
||
| export {Props} from './SkeletonThumbnail'; | ||
| export default SkeletonThumbnail; |
10 changes: 10 additions & 0 deletions
10
src/components/SkeletonThumbnail/tests/SkeletonThumbnail.test.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| import * as React from 'react'; | ||
| import {mountWithAppProvider} from 'test-utilities'; | ||
| import SkeletonThumbnail from '../SkeletonThumbnail'; | ||
|
|
||
| describe('<SkeletonThumbnail />', () => { | ||
| it('renders', () => { | ||
| const skeletonThumbnail = mountWithAppProvider(<SkeletonThumbnail />); | ||
| expect(skeletonThumbnail.exists()).toBe(true); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🙌