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: consolidate person view types #2943

Merged
merged 4 commits into from
Jan 17, 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 @@ -15,7 +15,6 @@ import { AvatarSize, IDynamicPerson, ViewType } from '../../graph/types';
import { MgtFlyout, registerMgtFlyoutComponent } from '../sub-components/mgt-flyout/mgt-flyout';
import { getUserWithPhoto } from '../../graph/graph.userWithPhoto';
import { MgtPerson, registerMgtPersonComponent } from '../mgt-person/mgt-person';
import { PersonViewType } from '../mgt-person/mgt-person-types';

import { getSvg, SvgIcon } from '../../utils/SvgHelper';

Expand Down Expand Up @@ -607,7 +606,7 @@ export class MgtLogin extends MgtTemplatedComponent {
<mgt-person
.personDetails=${details ? JSON.parse(details) : null}
.fallbackDetails=${{ displayName: account.name, mail: account.mail }}
.view=${PersonViewType.twolines}
.view=${ViewType.twolines}
class="account"
></mgt-person>
</li>`;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,41 +4,6 @@
* See License in the project root for license information.
* -------------------------------------------------------------------------------------------
*/

/**
* Enumeration to define what parts of the person component render
*
* @export
* @enum {number}
*/

export enum PersonViewType {
/**
* Render only the avatar
*/
avatar = 2,

/**
* Render the avatar and one line of text
*/
oneline = 3,

/**
* Render the avatar and two lines of text
*/
twolines = 4,

/**
* Render the avatar and three lines of text
*/
threelines = 5,

/**
* Render the avatar and four lines of text
*/
fourlines = 6
}

export enum avatarType {
/**
* Renders avatar photo if available, falls back to initials
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import '../sub-components/mgt-flyout/mgt-flyout';
import { MgtFlyout, registerMgtFlyoutComponent } from '../sub-components/mgt-flyout/mgt-flyout';
import { PersonCardInteraction } from './../PersonCardInteraction';
import { styles } from './mgt-person-css';
import { MgtPersonConfig, PersonViewType, avatarType } from './mgt-person-types';
import { MgtPersonConfig, avatarType } from './mgt-person-types';
import { strings } from './strings';
import { isUser, isContact } from '../../graph/entityType';
import { ifDefined } from 'lit/directives/if-defined.js';
Expand Down Expand Up @@ -505,7 +505,7 @@ export class MgtPerson extends MgtTemplatedComponent {
* Sets what data to be rendered (image only, oneLine, twoLines).
* Default is 'image'.
*
* @type {ViewType | PersonViewType}
* @type {ViewType}
* @memberof MgtPerson
*/
@property({
Expand All @@ -523,7 +523,7 @@ export class MgtPerson extends MgtTemplatedComponent {
}
}
})
public view: ViewType | PersonViewType;
public view: ViewType = ViewType.image;

@state() private _fetchedImage: string;
@state() private _fetchedPresence: Presence;
Expand Down Expand Up @@ -917,7 +917,7 @@ export class MgtPerson extends MgtTemplatedComponent {
* @returns
*/
protected renderDetails(personProps: IDynamicPerson, presence?: Presence): TemplateResult {
if (!personProps || this.view === ViewType.image || this.view === PersonViewType.avatar) {
if (!personProps || this.view === ViewType.image) {
return html``;
}

Expand Down
4 changes: 2 additions & 2 deletions packages/mgt-react/src/generated/person.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
/* eslint-disable @typescript-eslint/consistent-type-definitions */
import { IDynamicPerson,AvatarSize,PersonCardInteraction,ViewType,PersonViewType } from '@microsoft/mgt-components';
import { IDynamicPerson,AvatarSize,PersonCardInteraction,ViewType } from '@microsoft/mgt-components';
import { registerMgtPersonComponent } from '@microsoft/mgt-components';
import { TemplateContext,TemplateRenderedData } from '@microsoft/mgt-element';
// eslint-disable-next-line @typescript-eslint/no-unused-vars
Expand Down Expand Up @@ -28,7 +28,7 @@ export type PersonProps = {
line2Property?: string;
line3Property?: string;
line4Property?: string;
view?: ViewType | PersonViewType;
view?: ViewType;
templateContext?: TemplateContext;
line1clicked?: (e: CustomEvent<IDynamicPerson>) => void;
line2clicked?: (e: CustomEvent<IDynamicPerson>) => void;
Expand Down
2 changes: 1 addition & 1 deletion packages/providers/mgt-teamsfx-provider/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ To learn more about authentication providers, see [Providers](./providers.md).
public render(): void {
return (
<div>
<Person personQuery="me" view={PersonViewType.threelines}></Person>
<Person personQuery="me" view={ViewType.threelines}></Person>
</div>
);
}
Expand Down
4 changes: 2 additions & 2 deletions samples/react-contoso/src/components/Messages.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { MgtTemplateProps, Person, PersonCardInteraction, PersonViewType } from '@microsoft/mgt-react';
import { MgtTemplateProps, Person, PersonCardInteraction, ViewType } from '@microsoft/mgt-react';
import { makeStyles, mergeClasses, shorthands } from '@fluentui/react-components';

const useStyles = makeStyles({
Expand Down Expand Up @@ -73,7 +73,7 @@ export function Messages(props: MgtTemplateProps) {
<div>
<Person
personQuery={email.sender.emailAddress.address}
view={PersonViewType.oneline}
view={ViewType.oneline}
personCardInteraction={PersonCardInteraction.hover}
/>
</div>
Expand Down
Loading