Charlie Tran 843a6c5bbb
feat(frontend): update datahub-web client UI code (#1806)
* Releases updated version of datahub-web client UI code

* Fix typo in yarn lock

* Change yarn lock to match yarn registry directories

* Previous commit missed some paths

* Even more changes to yarnlock missing in previous commit

* Include codegen file for typings

* Add files to get parity for datahub-web and current OS datahub-midtier

* Add in typo fix from previous commit - change to proper license

* Implement proper OS fix for person entity picture url

* Workarounds for open source DH issues

* Fixes institutional memory api and removes unopensourced tabs for datasets

* Fixes search dataset deprecation and user search issue as a result of changes

* Remove internal only options in the avatar menu
2020-08-26 15:44:50 -07:00

44 lines
1.4 KiB
TypeScript

import Component from '@glimmer/component';
import { Avatar } from '@datahub/shared/modules/avatars/avatar';
/**
* The types available for name display
*/
type DisplayType = 'name' | 'username';
interface IAvatarNameComponenetArgs {
// A single instance of the Avatar class, representing the person whose name we want to show in
// this component
avatar: Avatar;
// Base class to use in addition to the base avatar name component class, if needed
nameClass?: string;
// Option passed in to select type of name displayed
displayType?: DisplayType;
}
export const baseAvatarNameComponentClass = 'avatar-name';
/**
* The AvatarNameComponent is responsible for rendering an avatar when there is a single name
* to be shown for the person. It should be used in conjunction with the main avatar container
* @example
* <Avatar::Containers::AvatarMain ...props as |avatars|>
* {{#each avatars as |avatar|}}
* <Avatar::AvatarName @avatar={{avatar}} />
* {{/each}}
* </Avatar::Containers::AvatarMain>
*/
export default class AvatarNameComponent extends Component<IAvatarNameComponenetArgs> {
/**
* Attaching to component for ease of access in the template
*/
baseClass = baseAvatarNameComponentClass;
/**
* The intended name type to be displayed
*/
get displayType(): DisplayType {
return this.args.displayType || 'username';
}
}