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: add a shimmer for the loading state of person component #3009

Merged
merged 8 commits into from
Mar 7, 2024
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
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,8 @@ $person-line4-text-line-height: var(--person-line4-text-line-height, 16px);

img,
.initials,
.contact-icon {
.contact-icon,
.shimmer {
height: 100%;
width: 100%;
border: $person-avatar-border;
Expand All @@ -197,7 +198,8 @@ $person-line4-text-line-height: var(--person-line4-text-line-height, 16px);
}

.initials,
.contact-icon {
.contact-icon,
.shimmer {
display: flex;
justify-content: center;
align-items: center;
Expand Down Expand Up @@ -232,6 +234,14 @@ $person-line4-text-line-height: var(--person-line4-text-line-height, 16px);
margin-inline-start: $person-details-left-spacing;
margin-block-end: $person-details-bottom-spacing;

.shimmer {
&.text {
width: 200px;
height: 16px;
margin: 2px 0;
}
}

&.vertical {
display: inline-flex;
flex-direction: column;
Expand Down
84 changes: 75 additions & 9 deletions packages/mgt-components/src/components/mgt-person/mgt-person.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,38 @@
* -------------------------------------------------------------------------------------------
*/

import { fluentSkeleton } from '@fluentui/web-components';
import {
MgtTemplatedTaskComponent,
ProviderState,
Providers,
buildComponentName,
customElementHelper,
mgtHtml
mgtHtml,
registerComponent
} from '@microsoft/mgt-element';
import { Presence } from '@microsoft/microsoft-graph-types';
import { html, TemplateResult, nothing } from 'lit';
import { TemplateResult, html, nothing } from 'lit';
import { property, state } from 'lit/decorators.js';
import { classMap } from 'lit/directives/class-map.js';
import { ifDefined } from 'lit/directives/if-defined.js';
import { isContact, isUser } from '../../graph/entityType';
import { findPeople, getEmailFromGraphEntity } from '../../graph/graph.people';
import { getGroupImage, getPersonImage } from '../../graph/graph.photos';
import { getUserPresence } from '../../graph/graph.presence';
import { findUsers, getMe, getUser } from '../../graph/graph.user';
import { getUserWithPhoto } from '../../graph/graph.userWithPhoto';
import { AvatarSize, IDynamicPerson, ViewType, viewTypeConverter } from '../../graph/types';
import '../../styles/style-helper';
import { registerFluentComponents } from '../../utils/FluentComponents';
import { SvgIcon, getSvg } from '../../utils/SvgHelper';
import { IExpandable, IHistoryClearer } from '../mgt-person-card/types';
import '../sub-components/mgt-flyout/mgt-flyout';
import { MgtFlyout, registerMgtFlyoutComponent } from '../sub-components/mgt-flyout/mgt-flyout';
import { type PersonCardInteraction, personCardConverter } from './../PersonCardInteraction';
import { personCardConverter, type PersonCardInteraction } from './../PersonCardInteraction';
import { styles } from './mgt-person-css';
import { MgtPersonConfig, AvatarType, avatarTypeConverter } from './mgt-person-types';
import { AvatarType, MgtPersonConfig, avatarTypeConverter } from './mgt-person-types';
import { strings } from './strings';
import { isUser, isContact } from '../../graph/entityType';
import { ifDefined } from 'lit/directives/if-defined.js';
import { buildComponentName, registerComponent } from '@microsoft/mgt-element';
import { IExpandable, IHistoryClearer } from '../mgt-person-card/types';

/**
* Person properties part of original set provided by graph by default
Expand All @@ -55,6 +58,8 @@ export const defaultPersonProperties = [
];

export const registerMgtPersonComponent = () => {
registerFluentComponents(fluentSkeleton);

// register self first to avoid infinte loop due to circular ref between person and person card
registerComponent('person', MgtPerson);

Expand Down Expand Up @@ -585,7 +590,68 @@ export class MgtPerson extends MgtTemplatedTaskComponent {
* @memberof MgtPerson
*/
protected renderLoading = (): TemplateResult => {
return this.renderTemplate('loading', null) || html``;
const rootClasses = classMap({
'person-root': true,
small: !this.isThreeLines() && !this.isFourLines() && !this.isLargeAvatar(),
large: this.avatarSize !== 'auto' && this.isLargeAvatar(),
noline: this.isNoLine(),
oneline: this.isOneLine(),
twolines: this.isTwoLines(),
threelines: this.isThreeLines(),
fourlines: this.isFourLines(),
vertical: this.isVertical()
});

const detailsClasses = classMap({
'details-wrapper': true,
vertical: this.isVertical()
});

return (
this.renderTemplate('loading', null) ||
html`
<div class="${rootClasses}">
<div class="avatar-wrapper">
<fluent-skeleton shimmer class="shimmer" shape="circle"></fluent-skeleton>
</div>
<div class=${detailsClasses}>
${this.renderLoadingLines()}
</div>
</div>`
);
};

protected renderLoadingLines = (): TemplateResult[] => {
const lines: TemplateResult[] = [];
if (this.isNoLine()) return lines;
if (this.isOneLine()) {
lines.push(this.renderLoadingLine(1));
}
if (this.isTwoLines()) {
lines.push(this.renderLoadingLine(1));
lines.push(this.renderLoadingLine(2));
}
if (this.isThreeLines()) {
lines.push(this.renderLoadingLine(1));
lines.push(this.renderLoadingLine(2));
lines.push(this.renderLoadingLine(3));
}
if (this.isFourLines()) {
lines.push(this.renderLoadingLine(1));
lines.push(this.renderLoadingLine(2));
lines.push(this.renderLoadingLine(3));
lines.push(this.renderLoadingLine(4));
}
return lines;
};

protected renderLoadingLine = (line: number): TemplateResult => {
const lineNumber = `line${line}`;
return html`
<div class=${lineNumber}>
<fluent-skeleton shimmer class="shimmer text" shape="rect"></fluent-skeleton>
</div>
`;
};

/**
Expand Down
Loading