@jupyter/web-components
Version:
A component library for building extensions in Jupyter frontends.
45 lines (44 loc) • 1.42 kB
TypeScript
import { AvatarOptions, Avatar } from '@microsoft/fast-foundation';
import { avatarStyles as styles } from './avatar.styles.js';
/**
* Jupyter Avatar Class
*
* @public
* @tagname jp-avatar
*/
declare class JupyterAvatar extends Avatar {
/**
* Indicates the Avatar should have an image source
*
* @public
* @remarks
* HTML Attribute: src
*/
imgSrc: string | undefined;
/**
* Indicates the Avatar should have alt text
*
* @public
* @remarks
* HTML Attribute: alt
*/
alt: string | undefined;
}
/**
* The Jupyter Avatar Template for Images
* @public
*
*/
export declare const imgTemplate: import("@microsoft/fast-element").ViewTemplate<JupyterAvatar, any>;
/**
* A function that returns a {@link @microsoft/fast-foundation#Avatar} registration for configuring the component with a DesignSystem.
* {@link @microsoft/fast-foundation#avatarTemplate}
*
*
* @public
* @remarks
* Generates HTML Element: `<jp-avatar>`
*/
export declare const jpAvatar: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<AvatarOptions> | undefined) => import("@microsoft/fast-foundation").FoundationElementRegistry<AvatarOptions, import("@microsoft/fast-element").Constructable<import("@microsoft/fast-foundation").FoundationElement>>;
export { JupyterAvatar as Avatar };
export { styles as avatarStyles };