From c3c393ae02c00d9456252ec67f5274e61aef4715 Mon Sep 17 00:00:00 2001 From: Esteban Munoz Facusse Date: Thu, 23 Jun 2022 12:41:00 -0600 Subject: [PATCH 1/2] docs: Adding @internal to getInitials. --- .../react-components/react-avatar/etc/react-avatar.api.md | 4 +++- .../react-components/react-avatar/src/utils/getInitials.ts | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/packages/react-components/react-avatar/etc/react-avatar.api.md b/packages/react-components/react-avatar/etc/react-avatar.api.md index 59bcfcd878bdc5..34df0299efee61 100644 --- a/packages/react-components/react-avatar/etc/react-avatar.api.md +++ b/packages/react-components/react-avatar/etc/react-avatar.api.md @@ -105,7 +105,9 @@ export type AvatarState = ComponentState & Required>; }; -// @public +// Warning: (ae-internal-missing-underscore) The name "getInitials" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal export function getInitials(displayName: string | undefined | null, isRtl: boolean, options?: { allowPhoneInitials?: boolean; firstInitialOnly?: boolean; diff --git a/packages/react-components/react-avatar/src/utils/getInitials.ts b/packages/react-components/react-avatar/src/utils/getInitials.ts index 864f23122bcee2..b8caf7d4de528a 100644 --- a/packages/react-components/react-avatar/src/utils/getInitials.ts +++ b/packages/react-components/react-avatar/src/utils/getInitials.ts @@ -75,6 +75,8 @@ function cleanupDisplayName(displayName: string): string { * * @returns The 1 or 2 character initials based on the name. Or an empty string if no initials * could be derived from the name. + * + * @internal */ export function getInitials( displayName: string | undefined | null, From d8920837cd7d82faeaaff2b613da2df9a42f2261 Mon Sep 17 00:00:00 2001 From: Esteban Munoz Facusse Date: Thu, 23 Jun 2022 12:41:59 -0600 Subject: [PATCH 2/2] change files --- ...-react-avatar-4f8775b1-d717-49c5-a688-4998bc9773e3.json | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 change/@fluentui-react-avatar-4f8775b1-d717-49c5-a688-4998bc9773e3.json diff --git a/change/@fluentui-react-avatar-4f8775b1-d717-49c5-a688-4998bc9773e3.json b/change/@fluentui-react-avatar-4f8775b1-d717-49c5-a688-4998bc9773e3.json new file mode 100644 index 00000000000000..fb7241ed5d069c --- /dev/null +++ b/change/@fluentui-react-avatar-4f8775b1-d717-49c5-a688-4998bc9773e3.json @@ -0,0 +1,7 @@ +{ + "type": "none", + "comment": "docs: Adding @internal to getInitials.", + "packageName": "@fluentui/react-avatar", + "email": "esteban.230@hotmail.com", + "dependentChangeType": "none" +}