@fluentui/react-avatar 0.0.0-nightlyfc5cfdc52420220215.1 → 0.0.0

package/lib-commonjs/components/Avatar/Avatar.types.d.ts

@@ -1,107 +0,0 @@
-import { PresenceBadge } from '@fluentui/react-badge';
-import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';
-export declare type AvatarSlots = {
-    root: Slot<'span'>;
-    /**
-     * The Avatar's image.
-     *
-     * Usage e.g.: `image={{ src: '...' }}`
-     */
-    image?: Slot<'img'>;
-    /**
-     * (optional) Custom initials.
-     *
-     * It is usually not necessary to specify custom initials; by default they will be derived from the `name` prop,
-     * using the `getInitials` function.
-     *
-     * The initials are displayed when there is no image (including while the image is loading).
-     */
-    initials?: Slot<'span'>;
-    /**
-     * Icon to be displayed when the avatar doesn't have an image or initials.
-     *
-     * @defaultvalue `PersonRegular` (the default icon's size depends on the Avatar's size)
-     */
-    icon?: Slot<'span'>;
-    /**
-     * Badge to show the avatar's presence status.
-     */
-    badge?: Slot<typeof PresenceBadge>;
-};
-declare type AvatarCommons = {
-    /**
-     * The name of the person or entity represented by this Avatar. This should always be provided if it is available.
-     *
-     * The name will be used to determine the initials displayed when there is no icon, as well as provided to
-     * accessibility tools.
-     */
-    name?: string;
-    /**
-     * Size of the avatar in pixels.
-     *
-     * Size is restricted to a limited set of supported values recommended for most uses (see `AvatarSizeValue`) and
-     * based on design guidelines for the Avatar control.
-     *
-     * If a non-supported size is neeeded, set `size` to the next-smaller supported size, and set `width` and `height`
-     * to override the rendered size.
-     *
-     * For example, to set the avatar to 45px in size:
-     * `<Avatar size={40} style={{ width: '45px', height: '45px' }} />`
-     *
-     * @defaultvalue 32
-     */
-    size: 20 | 24 | 28 | 32 | 36 | 40 | 48 | 56 | 64 | 72 | 96 | 120 | 128;
-    /**
-     * The avatar can have a circular or square shape.
-     * @defaultvalue circular
-     */
-    shape: 'circular' | 'square';
-    /**
-     * Optional activity indicator
-     * * active: the avatar will be decorated according to activeAppearance
-     * * inactive: the avatar will be reduced in size and partially transparent
-     * * unset: normal display
-     *
-     * @defaultvalue unset
-     */
-    active: 'active' | 'inactive' | 'unset';
-    /**
-     * The appearance when `active="active"`
-     *
-     * @defaultvalue ring
-     */
-    activeAppearance: 'ring' | 'shadow' | 'ring-shadow';
-    /**
-     * The color when displaying either an icon or initials.
-     * * neutral (default): gray
-     * * brand: color from the brand palette
-     * * colorful: picks a color from a set of pre-defined colors, based on a hash of the name (or idForColor if provided)
-     * * [AvatarNamedColor]: a specific color from the theme
-     *
-     * @defaultvalue neutral
-     */
-    color: 'neutral' | 'brand' | 'colorful' | AvatarNamedColor;
-    /**
-     * Specify a string to be used instead of the name, to determine which color to use when color="colorful".
-     * Use this when a name is not available, but there is another unique identifier that can be used instead.
-     */
-    idForColor: string | undefined;
-};
-/**
- * A specific named color for the Avatar
- */
-export declare type AvatarNamedColor = 'darkRed' | 'cranberry' | 'red' | 'pumpkin' | 'peach' | 'marigold' | 'gold' | 'brass' | 'brown' | 'forest' | 'seafoam' | 'darkGreen' | 'lightTeal' | 'teal' | 'steel' | 'blue' | 'royalBlue' | 'cornflower' | 'navy' | 'lavender' | 'purple' | 'grape' | 'lilac' | 'pink' | 'magenta' | 'plum' | 'beige' | 'mink' | 'platinum' | 'anchor';
-/**
- * Properties for Avatar
- */
-export declare type AvatarProps = Omit<ComponentProps<AvatarSlots>, 'color'> & Partial<AvatarCommons>;
-/**
- * State used in rendering Avatar
- */
-export declare type AvatarState = ComponentState<AvatarSlots> & AvatarCommons & {
-    /**
-     * The Avatar's color, with `'colorful'` resolved to a named color
-     */
-    color: Exclude<AvatarCommons['color'], 'colorful'>;
-};
-export {};

package/lib-commonjs/components/Avatar/index.d.ts

@@ -1,5 +0,0 @@
-export * from './Avatar.types';
-export * from './Avatar';
-export * from './renderAvatar';
-export * from './useAvatar';
-export * from './useAvatarStyles';

package/lib-commonjs/components/Avatar/renderAvatar.d.ts

@@ -1,2 +0,0 @@
-import type { AvatarState } from './Avatar.types';
-export declare const renderAvatar_unstable: (state: AvatarState) => JSX.Element;

package/lib-commonjs/components/Avatar/useAvatar.d.ts

@@ -1,3 +0,0 @@
-import * as React from 'react';
-import type { AvatarProps, AvatarState } from './Avatar.types';
-export declare const useAvatar_unstable: (props: AvatarProps, ref: React.Ref<HTMLElement>) => AvatarState;

package/lib-commonjs/components/Avatar/useAvatarStyles.d.ts

@@ -1,3 +0,0 @@
-import type { AvatarState } from './Avatar.types';
-export declare const avatarClassName = "fui-Avatar";
-export declare const useAvatarStyles_unstable: (state: AvatarState) => AvatarState;

package/lib-commonjs/index.d.ts

@@ -1,2 +0,0 @@
-export * from './Avatar';
-export * from './utils/index';

package/lib-commonjs/utils/getInitials.d.ts

@@ -1,14 +0,0 @@
-/**
- * Regular expressions matching characters to ignore when calculating the initials.
- */
-/**
- * Get (up to 2 characters) initials based on display name of the persona.
- *
- * @param displayName - The full name of the person or entity
- * @param isRtl - Whether the display is in RTL
- * @param allowPhoneInitials - Should initials be generated from phone numbers (default false)
- *
- * @returns The 1 or 2 character initials based on the name. Or an empty string if no initials
- * could be derived from the name.
- */
-export declare function getInitials(displayName: string | undefined | null, isRtl: boolean, allowPhoneInitials?: boolean): string;

package/lib-commonjs/utils/index.d.ts

@@ -1 +0,0 @@
-export { getInitials } from './getInitials';