@amsterdam/design-system-react
Version:
All React components from the Amsterdam Design System. Use it to compose pages in your website or application.
28 lines (27 loc) • 1.26 kB
TypeScript
/**
* @license EUPL-1.2+
* Copyright Gemeente Amsterdam
*/
import type { HTMLAttributes } from 'react';
export declare const avatarColors: readonly ["azure", "green", "lime", "magenta", "orange", "yellow"];
type AvatarColor = (typeof avatarColors)[number];
export type AvatarProps = {
/** The background colour. */
color?: AvatarColor;
/** The url for the user’s image. Its center will be displayed. Should be square and scaled down. */
imageSrc?: string;
/** The text content. Should be the user’s initials. The first two characters will be displayed. */
label: string;
} & HTMLAttributes<HTMLSpanElement>;
/**
* @see {@link https://designsystem.amsterdam/?path=/docs/components-feedback-avatar--docs Avatar docs at Amsterdam Design System}
*/
export declare const Avatar: import("react").ForwardRefExoticComponent<{
/** The background colour. */
color?: AvatarColor;
/** The url for the user’s image. Its center will be displayed. Should be square and scaled down. */
imageSrc?: string;
/** The text content. Should be the user’s initials. The first two characters will be displayed. */
label: string;
} & HTMLAttributes<HTMLSpanElement> & import("react").RefAttributes<HTMLSpanElement>>;
export {};