@fluentui/react-avatar 9.0.0-nightly.d730088d7f.0 → 9.0.0-rc.10

package/dist/react-avatar.d.ts

@@ -1,132 +0,0 @@
-import type { ComponentProps } from '@fluentui/react-utilities';
-import type { ComponentState } from '@fluentui/react-utilities';
-import type { ForwardRefComponent } from '@fluentui/react-utilities';
-import type { IntrinsicShorthandProps } from '@fluentui/react-utilities';
-import type { ObjectShorthandProps } from '@fluentui/react-utilities';
-import type { PresenceBadgeProps } from '@fluentui/react-badge';
-import * as React_2 from 'react';
-import type { ShorthandRenderFunction } from '@fluentui/react-utilities';
-
-export declare const Avatar: ForwardRefComponent<AvatarProps>;
-
-export declare type AvatarCommons = Omit<React_2.HTMLAttributes<HTMLElement>, 'children'> & {
-    /**
-     * The name used for displaying the initials of the avatar if the image is not provided
-     */
-    name: string;
-    /**
-     * Custom method for generating the initials from the name property, which is shown if no image is provided.
-     */
-    getInitials: (name: string, isRtl: boolean) => 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' | 'glow' | 'ring-shadow' | 'ring-glow';
-    /**
-     * 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>, 'image'> & Partial<AvatarCommons> & {
-    /**
-     * The Avatar's image. Cannot be typed as a normal slot since it should not accept any children
-     * but can accept a children render function.
-     */
-    image?: Omit<IntrinsicShorthandProps<'img'>, 'children'> & {
-        children?: ShorthandRenderFunction<React_2.HTMLAttributes<HTMLImageElement>>;
-    };
-};
-
-export declare type AvatarSlots = {
-    root: Omit<IntrinsicShorthandProps<'span'>, 'color'> & {
-        children?: never;
-    };
-    /**
-     * This overidden in the component's props, it's only here to make `getSlots` work
-     * `img`  is an exception since it should never accept children, but can accept a children render function
-     */
-    image?: IntrinsicShorthandProps<'img'>;
-    /**
-     * The label shown when there's no image. Defaults to the initials derived from `name` using `getInitials`.
-     */
-    label?: IntrinsicShorthandProps<'span'>;
-    /**
-     * Icon to be displayed when the avatar doesn't have an image or name (or if getInitials returns an empty string).
-     *
-     * @defaultvalue `Person20Regular` (the default icon's size depends on the Avatar's size)
-     */
-    icon?: IntrinsicShorthandProps<'span'>;
-    /**
-     * Badge to show the avatar's presence status.
-     */
-    badge?: ObjectShorthandProps<PresenceBadgeProps>;
-};
-
-/**
- * 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 declare const renderAvatar: (state: AvatarState) => JSX.Element;
-
-export declare const useAvatar: (props: AvatarProps, ref: React_2.Ref<HTMLElement>) => AvatarState;
-
-export declare const useAvatarStyles: (state: AvatarState) => AvatarState;
-
-export { }

package/lib/Avatar.d.ts

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

package/lib/common/isConformant.d.ts

@@ -1,4 +0,0 @@
-import type { IsConformantOptions } from '@fluentui/react-conformance';
-export declare function isConformant<TProps = {}>(testInfo: Omit<IsConformantOptions<TProps>, 'componentPath'> & {
-    componentPath?: string;
-}): void;

package/lib/common/isConformant.js

@@ -1,12 +0,0 @@
-import { isConformant as baseIsConformant } from '@fluentui/react-conformance';
-import makeStylesTests from '@fluentui/react-conformance-make-styles';
-export function isConformant(testInfo) {
-  var defaultOptions = {
-    asPropHandlesRef: true,
-    componentPath: module.parent.filename.replace('.test', ''),
-    disabledTests: ['has-docblock'],
-    extraTests: makeStylesTests
-  };
-  baseIsConformant(defaultOptions, testInfo);
-}
-//# sourceMappingURL=isConformant.js.map

package/lib/common/isConformant.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/common/isConformant.ts"],"names":[],"mappings":"AAAA,SAAS,YAAY,IAAI,gBAAzB,QAAiD,6BAAjD;AACA,OAAO,eAAP,MAA4B,yCAA5B;AAGA,OAAM,SAAU,YAAV,CACJ,QADI,EACqF;AAEzF,MAAM,cAAc,GAAyC;AAC3D,IAAA,gBAAgB,EAAE,IADyC;AAE3D,IAAA,aAAa,EAAE,MAAO,CAAC,MAAR,CAAgB,QAAhB,CAAyB,OAAzB,CAAiC,OAAjC,EAA0C,EAA1C,CAF4C;AAG3D,IAAA,aAAa,EAAE,CAAC,cAAD,CAH4C;AAI3D,IAAA,UAAU,EAAE;AAJ+C,GAA7D;AAOA,EAAA,gBAAgB,CAAC,cAAD,EAAiB,QAAjB,CAAhB;AACD","sourceRoot":""}

package/lib/components/Avatar/Avatar.d.ts

@@ -1,3 +0,0 @@
-import type { AvatarProps } from './Avatar.types';
-import type { ForwardRefComponent } from '@fluentui/react-utilities';
-export declare const Avatar: ForwardRefComponent<AvatarProps>;

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

@@ -1,112 +0,0 @@
-import * as React from 'react';
-import type { ComponentProps, ComponentState, IntrinsicShorthandProps, ObjectShorthandProps, ShorthandRenderFunction } from '@fluentui/react-utilities';
-import type { PresenceBadgeProps } from '@fluentui/react-badge';
-export declare type AvatarSlots = {
-    root: Omit<IntrinsicShorthandProps<'span'>, 'color'> & {
-        children?: never;
-    };
-    /**
-     * This overidden in the component's props, it's only here to make `getSlots` work
-     * `img`  is an exception since it should never accept children, but can accept a children render function
-     */
-    image?: IntrinsicShorthandProps<'img'>;
-    /**
-     * The label shown when there's no image. Defaults to the initials derived from `name` using `getInitials`.
-     */
-    label?: IntrinsicShorthandProps<'span'>;
-    /**
-     * Icon to be displayed when the avatar doesn't have an image or name (or if getInitials returns an empty string).
-     *
-     * @defaultvalue `Person20Regular` (the default icon's size depends on the Avatar's size)
-     */
-    icon?: IntrinsicShorthandProps<'span'>;
-    /**
-     * Badge to show the avatar's presence status.
-     */
-    badge?: ObjectShorthandProps<PresenceBadgeProps>;
-};
-export declare type AvatarCommons = Omit<React.HTMLAttributes<HTMLElement>, 'children'> & {
-    /**
-     * The name used for displaying the initials of the avatar if the image is not provided
-     */
-    name: string;
-    /**
-     * Custom method for generating the initials from the name property, which is shown if no image is provided.
-     */
-    getInitials: (name: string, isRtl: boolean) => 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' | 'glow' | 'ring-shadow' | 'ring-glow';
-    /**
-     * 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>, 'image'> & Partial<AvatarCommons> & {
-    /**
-     * The Avatar's image. Cannot be typed as a normal slot since it should not accept any children
-     * but can accept a children render function.
-     */
-    image?: Omit<IntrinsicShorthandProps<'img'>, 'children'> & {
-        children?: ShorthandRenderFunction<React.HTMLAttributes<HTMLImageElement>>;
-    };
-};
-/**
- * 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'>;
-};

package/lib/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/components/Avatar/renderAvatar.d.ts

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

package/lib/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: (props: AvatarProps, ref: React.Ref<HTMLElement>) => AvatarState;

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

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

package/lib/index.d.ts

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

package/lib/utils/getInitials.d.ts

@@ -1,9 +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.
- *
- * @public
- */
-export declare function getInitials(displayName: string | undefined | null, isRtl: boolean, allowPhoneInitials?: boolean): string;

package/lib/utils/index.d.ts

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

package/lib-commonjs/Avatar.d.ts

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

package/lib-commonjs/common/isConformant.d.ts

@@ -1,4 +0,0 @@
-import type { IsConformantOptions } from '@fluentui/react-conformance';
-export declare function isConformant<TProps = {}>(testInfo: Omit<IsConformantOptions<TProps>, 'componentPath'> & {
-    componentPath?: string;
-}): void;

package/lib-commonjs/common/isConformant.js

@@ -1,23 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.isConformant = void 0;
-
-var react_conformance_1 = /*#__PURE__*/require("@fluentui/react-conformance");
-
-var react_conformance_make_styles_1 = /*#__PURE__*/require("@fluentui/react-conformance-make-styles");
-
-function isConformant(testInfo) {
-  var defaultOptions = {
-    asPropHandlesRef: true,
-    componentPath: module.parent.filename.replace('.test', ''),
-    disabledTests: ['has-docblock'],
-    extraTests: react_conformance_make_styles_1.default
-  };
-  react_conformance_1.isConformant(defaultOptions, testInfo);
-}
-
-exports.isConformant = isConformant;
-//# sourceMappingURL=isConformant.js.map

package/lib-commonjs/common/isConformant.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/common/isConformant.ts"],"names":[],"mappings":";;;;;;;AAAA,IAAA,mBAAA,gBAAA,OAAA,CAAA,6BAAA,CAAA;;AACA,IAAA,+BAAA,gBAAA,OAAA,CAAA,yCAAA,CAAA;;AAGA,SAAgB,YAAhB,CACE,QADF,EAC2F;AAEzF,MAAM,cAAc,GAAyC;AAC3D,IAAA,gBAAgB,EAAE,IADyC;AAE3D,IAAA,aAAa,EAAE,MAAO,CAAC,MAAR,CAAgB,QAAhB,CAAyB,OAAzB,CAAiC,OAAjC,EAA0C,EAA1C,CAF4C;AAG3D,IAAA,aAAa,EAAE,CAAC,cAAD,CAH4C;AAI3D,IAAA,UAAU,EAAE,+BAAA,CAAA;AAJ+C,GAA7D;AAOA,EAAA,mBAAA,CAAA,YAAA,CAAiB,cAAjB,EAAiC,QAAjC;AACD;;AAXD,OAAA,CAAA,YAAA,GAAA,YAAA","sourceRoot":""}

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

@@ -1,3 +0,0 @@
-import type { AvatarProps } from './Avatar.types';
-import type { ForwardRefComponent } from '@fluentui/react-utilities';
-export declare const Avatar: ForwardRefComponent<AvatarProps>;

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

@@ -1,112 +0,0 @@
-import * as React from 'react';
-import type { ComponentProps, ComponentState, IntrinsicShorthandProps, ObjectShorthandProps, ShorthandRenderFunction } from '@fluentui/react-utilities';
-import type { PresenceBadgeProps } from '@fluentui/react-badge';
-export declare type AvatarSlots = {
-    root: Omit<IntrinsicShorthandProps<'span'>, 'color'> & {
-        children?: never;
-    };
-    /**
-     * This overidden in the component's props, it's only here to make `getSlots` work
-     * `img`  is an exception since it should never accept children, but can accept a children render function
-     */
-    image?: IntrinsicShorthandProps<'img'>;
-    /**
-     * The label shown when there's no image. Defaults to the initials derived from `name` using `getInitials`.
-     */
-    label?: IntrinsicShorthandProps<'span'>;
-    /**
-     * Icon to be displayed when the avatar doesn't have an image or name (or if getInitials returns an empty string).
-     *
-     * @defaultvalue `Person20Regular` (the default icon's size depends on the Avatar's size)
-     */
-    icon?: IntrinsicShorthandProps<'span'>;
-    /**
-     * Badge to show the avatar's presence status.
-     */
-    badge?: ObjectShorthandProps<PresenceBadgeProps>;
-};
-export declare type AvatarCommons = Omit<React.HTMLAttributes<HTMLElement>, 'children'> & {
-    /**
-     * The name used for displaying the initials of the avatar if the image is not provided
-     */
-    name: string;
-    /**
-     * Custom method for generating the initials from the name property, which is shown if no image is provided.
-     */
-    getInitials: (name: string, isRtl: boolean) => 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' | 'glow' | 'ring-shadow' | 'ring-glow';
-    /**
-     * 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>, 'image'> & Partial<AvatarCommons> & {
-    /**
-     * The Avatar's image. Cannot be typed as a normal slot since it should not accept any children
-     * but can accept a children render function.
-     */
-    image?: Omit<IntrinsicShorthandProps<'img'>, 'children'> & {
-        children?: ShorthandRenderFunction<React.HTMLAttributes<HTMLImageElement>>;
-    };
-};
-/**
- * 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'>;
-};

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: (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: (props: AvatarProps, ref: React.Ref<HTMLElement>) => AvatarState;

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

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

package/lib-commonjs/index.d.ts

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

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

@@ -1,9 +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.
- *
- * @public
- */
-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';