@skyux/avatarView in NPM | View in GitHub None found. npm install --save-exact @skyux/avatar None found. import { SkyAvatarModule } from '@skyux/avatar';
Selector: sky-avatar
canChange: booleanWhether users can change the image. To select a different image,
users click the image or drag another image on top of it,
much like the sky-file-drop component in the
file attachment module.
Default: false
maxFileSize: number | undefinedThe maximum file size for the image in bytes.
Default: 512000 bytes
name: string | undefinedThe name of the record that the avatar represents.
If the src property does not specify an image, the component displays
initials from the first and last words in the name. To ensure
that the component extracts the correct initials, specify a name with no prefix
or suffix, or just specify initials with a space between them. This property is
not required, but the component requires either the name or src property.
size: SkyAvatarSize | undefinedThe size of the avatar.
Acceptable values are: "small", "medium", and "large".
Default: "large"
src: SkyAvatarSrc | undefinedThe image to identify a record. This property is
not required, but the component requires either the name or src property.
avatarChanged: EventEmitter<SkyFileItem>Emits a SkyFileItem object when the image is updated.
type SkyAvatarSize = "large" | "medium" | "small"type SkyAvatarSrc = string | Blob | FileSKY UX test harnesses are built upon Angular CDK component harnesses. For more information see the Angular CDK component harness documentation.
import { SkyAvatarHarness } from '@skyux/avatar/testing';
Harness for interacting with an avatar component in tests.
hostSelector: string Default: 'sky-avatar'
closeError(): Promise<void>Closes the currently displayed error.
Promise<void>
dropAvatarFile(file: File, waitForChange?: boolean): Promise<void>Simulates the user selecting or dropping an image onto the component.
file: FilewaitForChange?: booleanPromise<void>
getCanChange(): Promise<boolean>Gets whether users can change the image.
Promise<boolean>
getInitials(): Promise<undefined | string>Gets the initials displayed when no image URL is specified.
Promise<undefined | string>
getSrc(): Promise<undefined | string | Blob>Gets the avatar's current image URL or Blob.
Promise<undefined | string | Blob>
hasFileTypeError(): Promise<boolean>Gets whether an error indicating an invalid file type is displayed.
Promise<boolean>
hasMaxSizeError(): Promise<boolean>Gets whether an error indicating an invalid file size is displayed.
Promise<boolean>
SkyAvatarHarness.with(filters: SkyAvatarHarnessFilters): HarnessPredicate<SkyAvatarHarness>Gets a HarnessPredicate that can be used to search for a
SkyAvatarHarness that meets certain criteria.
filters: SkyAvatarHarnessFiltersHarnessPredicate<SkyAvatarHarness>
A set of criteria that can be used to filter a list of SkyAvatarHarness instances.
interface SkyAvatarHarnessFilters {
dataSkyId?: string | RegExp;
}dataSkyId?: string | RegExpOnly find instances whose data-sky-id attribute matches the given value.
Loading...