-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #12 from GovAlta/CS-618
feat: Add Angular skeleton elements
- Loading branch information
Showing
16 changed files
with
300 additions
and
4 deletions.
There are no files selected for viewing
This file contains 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 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
1 change: 1 addition & 0 deletions
1
libs/angular-components/src/experimental/skeleton/skeleton-element.component.html
This file contains 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 @@ | ||
<div [ngClass]="elementClass"></div> |
2 changes: 2 additions & 0 deletions
2
libs/angular-components/src/experimental/skeleton/skeleton-element.component.scss
This file contains 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,2 @@ | ||
@import '../../../../core-css/src/lib/styles/skeleton-element/skeleton.scss'; | ||
@import '../../../../core-css/src/lib/styles/card/card.scss'; |
23 changes: 23 additions & 0 deletions
23
libs/angular-components/src/experimental/skeleton/skeleton-element.component.ts
This file contains 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,23 @@ | ||
import { Component, OnInit, Input } from '@angular/core'; | ||
|
||
@Component({ | ||
selector: 'goa-skeleton-element', | ||
templateUrl: './skeleton-element.component.html', | ||
styleUrls: ['./skeleton-element.component.scss'], | ||
}) | ||
export class GoASkeletonElementComponent { | ||
@Input() type: | ||
| 'text' | ||
| 'avatar' | ||
| 'title' | ||
| 'paragraph' | ||
| 'thumbnail' | ||
| 'card' = 'text'; | ||
|
||
constructor() {} | ||
|
||
get elementClass(): string { | ||
return `skeleton ${this.type}`; | ||
} | ||
|
||
} |
160 changes: 160 additions & 0 deletions
160
libs/angular-components/src/experimental/skeleton/skeleton-element.stories.mdx
This file contains 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,160 @@ | ||
import { DoDont } from '@abgov/shared/storybook-common'; | ||
import { GoASkeletonImageContentComponent } from './skeleton-image-content.component'; | ||
import { GoASkeletonElementComponent } from './skeleton-element.component'; | ||
import { GoASkeletonGridColumnComponent } from './skeleton-grid-column.component'; | ||
import { GoASkeletonContentComponent } from './skeleton-titled-content.component'; | ||
import { GoALoadingCardComponent } from '../../lib/card/skeleton-card.component'; | ||
import { | ||
Meta, | ||
Canvas, | ||
Story, | ||
ArgsTable, | ||
Description, | ||
} from '@storybook/addon-docs/blocks'; | ||
import { moduleMetadata } from '@storybook/angular'; | ||
import { action } from '@storybook/addon-actions'; | ||
|
||
import { | ||
GoACardComponent, | ||
GoACardFooterComponent, | ||
GoACardHeaderComponent, | ||
GoACardThumbImageComponent, | ||
GoACardContentComponent, | ||
} from '../../lib/card/card.component'; | ||
|
||
<Meta | ||
title="Experimental/Components/SkeletonElement" | ||
component={GoASkeletonImageContentComponent} | ||
argTypes={{ | ||
rows: 5, | ||
showImage: false, | ||
}} | ||
decorators={[ | ||
moduleMetadata({ | ||
declarations: [ | ||
GoASkeletonImageContentComponent, | ||
GoASkeletonElementComponent, | ||
GoASkeletonGridColumnComponent, | ||
GoASkeletonContentComponent, | ||
GoALoadingCardComponent, | ||
GoACardComponent, | ||
GoACardFooterComponent, | ||
GoACardHeaderComponent, | ||
GoACardThumbImageComponent, | ||
GoACardContentComponent, | ||
], | ||
}), | ||
]} | ||
/> | ||
|
||
# GoASkeletonElement | ||
|
||
A skeleton load element provides visual feedback to users while a content heavy page or element is loading. | ||
|
||
## Variations | ||
|
||
<Canvas> | ||
<Story | ||
name="Skeleton Image Content" | ||
height={300} | ||
args={{ | ||
rows: 5, | ||
}} | ||
> | ||
{(args) => { | ||
return { | ||
template: `<goa-skeleton-image-content [rows]="rows"></goa-skeleton-image-content>`, | ||
props: args, | ||
}; | ||
}} | ||
</Story> | ||
</Canvas> | ||
|
||
<Canvas> | ||
<Story | ||
name="Content without a title" | ||
height={300} | ||
args={{ | ||
rows: 5, | ||
}} | ||
> | ||
{(args) => { | ||
return { | ||
template: `<goa-skeleton-grid-column [rows]="rows"></goa-skeleton-grid-column>`, | ||
props: args, | ||
}; | ||
}} | ||
</Story> | ||
</Canvas> | ||
|
||
<Canvas> | ||
<Story | ||
name="Skeleton Content" | ||
height={300} | ||
args={{ | ||
rows: 5, | ||
}} | ||
> | ||
{(args) => { | ||
return { | ||
template: `<goa-skeleton-content [rows]="rows"></goa-skeleton-content>`, | ||
props: args, | ||
}; | ||
}} | ||
</Story> | ||
</Canvas> | ||
|
||
<Canvas> | ||
<Story | ||
name="Skeleton Card" | ||
height={100} | ||
args={{ | ||
showImage: true, | ||
}} | ||
> | ||
{(args) => { | ||
return { | ||
template: `<div style="display:'flex'; gap:'8px'"> | ||
<goa-skeleton-card [showImage]="showImage"></goa-skeleton-card> | ||
</div> | ||
`, | ||
props: args, | ||
}; | ||
}} | ||
</Story> | ||
</Canvas> | ||
|
||
```html | ||
<goa-skeleton-image-content [rows]="5"></goa-skeleton-image-content> | ||
|
||
<goa-skeleton-content [rows]="5"></goa-skeleton-content> | ||
|
||
<goa-skeleton-card [showImage]="true" /> | ||
|
||
<goa-skeleton-grid-column [rows]="5"></goa-skeleton-grid-column> | ||
``` | ||
|
||
## Usage guidelines | ||
|
||
<DoDont | ||
dos={ | ||
'Show multiple elements within a larger component as individual information containers' | ||
} | ||
donts={ | ||
'Compile several elements that may have different loading durations into one container' | ||
} | ||
/> | ||
|
||
<DoDont | ||
dos={ | ||
'Include only the most important information containers that make the component recognizable' | ||
} | ||
donts={ | ||
'Show every single element as information containers in your skeleton load' | ||
} | ||
/> | ||
|
||
<DoDont | ||
dos={'Format bones so that they are conducive to a gradual content loading'} | ||
donts={'Oversimplify the component so that it is not recognizable'} | ||
/> |
8 changes: 8 additions & 0 deletions
8
libs/angular-components/src/experimental/skeleton/skeleton-grid-column.component.html
This file contains 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,8 @@ | ||
<div className="skeleton-content"> | ||
<div> | ||
<goa-skeleton-element | ||
type="text" | ||
*ngFor="let i of arr(rows).fill(1)" | ||
></goa-skeleton-element> | ||
</div> | ||
</div> |
15 changes: 15 additions & 0 deletions
15
libs/angular-components/src/experimental/skeleton/skeleton-grid-column.component.ts
This file contains 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,15 @@ | ||
import { Component, OnInit, Input } from '@angular/core'; | ||
|
||
@Component({ | ||
selector: 'goa-skeleton-grid-column', | ||
templateUrl: './skeleton-grid-column.component.html', | ||
styleUrls: ['./skeleton-element.component.scss'], | ||
}) | ||
export class GoASkeletonGridColumnComponent { | ||
@Input() rows = 1; | ||
|
||
arr = Array; | ||
|
||
constructor() {} | ||
|
||
} |
9 changes: 9 additions & 0 deletions
9
libs/angular-components/src/experimental/skeleton/skeleton-image-content.component.html
This file contains 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,9 @@ | ||
<div class="skeleton-image-content"> | ||
<goa-skeleton-element type="thumbnail"></goa-skeleton-element> | ||
<div class="skeleton-image-content__text"> | ||
<goa-skeleton-element | ||
type="title" | ||
*ngFor="let i of arr(rows).fill(1)" | ||
></goa-skeleton-element> | ||
</div> | ||
</div> |
15 changes: 15 additions & 0 deletions
15
libs/angular-components/src/experimental/skeleton/skeleton-image-content.component.ts
This file contains 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,15 @@ | ||
import { Component, OnInit, Input } from '@angular/core'; | ||
|
||
@Component({ | ||
selector: 'goa-skeleton-image-content', | ||
templateUrl: './skeleton-image-content.component.html', | ||
styleUrls: ['./skeleton-element.component.scss'], | ||
}) | ||
export class GoASkeletonImageContentComponent { | ||
@Input() rows = 1; | ||
|
||
arr = Array; | ||
constructor() {} | ||
|
||
|
||
} |
10 changes: 10 additions & 0 deletions
10
libs/angular-components/src/experimental/skeleton/skeleton-titled-content.component.html
This file contains 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 @@ | ||
<div className="skeleton-content"> | ||
<div> | ||
<goa-skeleton-element type="title"></goa-skeleton-element> | ||
|
||
<goa-skeleton-element | ||
type="text" | ||
*ngFor="let i of arr(rows).fill(1)" | ||
></goa-skeleton-element> | ||
</div> | ||
</div> |
15 changes: 15 additions & 0 deletions
15
libs/angular-components/src/experimental/skeleton/skeleton-titled-content.component.ts
This file contains 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,15 @@ | ||
import { Component, OnInit, Input } from '@angular/core'; | ||
|
||
@Component({ | ||
selector: 'goa-skeleton-content', | ||
templateUrl: './skeleton-titled-content.component.html', | ||
styleUrls: ['./skeleton-element.component.scss'], | ||
}) | ||
export class GoASkeletonContentComponent { | ||
@Input() rows = 1; | ||
|
||
arr = Array; | ||
|
||
constructor() {} | ||
|
||
} |
This file contains 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 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
16 changes: 16 additions & 0 deletions
16
libs/angular-components/src/lib/card/skeleton-card.component.html
This file contains 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,16 @@ | ||
<goa-card isSkeleton="true"> | ||
<goa-card-thumb-image | ||
*ngIf="showImage" | ||
url="data:image/gif;base64,R0lGODlhAQABAPAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==" | ||
></goa-card-thumb-image> | ||
<goa-card-header | ||
><div><span>Lorem ipsum dolor sit amet elit</span></div></goa-card-header | ||
> | ||
<goa-card-content data-skeleton> | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod | ||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim | ||
veniam. | ||
</p> | ||
</goa-card-content> | ||
</goa-card> |
13 changes: 13 additions & 0 deletions
13
libs/angular-components/src/lib/card/skeleton-card.component.ts
This file contains 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,13 @@ | ||
import { Component, Input, OnInit } from '@angular/core'; | ||
|
||
@Component({ | ||
selector: 'goa-skeleton-card', | ||
templateUrl: './skeleton-card.component.html', | ||
styleUrls: [], | ||
}) | ||
export class GoALoadingCardComponent { | ||
constructor() {} | ||
|
||
@Input() showImage: true; | ||
|
||
} |