Skip to content

docs(react-avatar): Adding @internal api access modifier to getInitials #23707

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sopranopillow merged 2 commits into from
Jun 23, 2022
Merged

docs(react-avatar): Adding @internal api access modifier to getInitials #23707

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3c393a
docs: Adding @internal to getInitials.
sopranopillow Jun 23, 2022
d892083
change files
sopranopillow Jun 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions change/@fluentui-react-avatar-4f8775b1-d717-49c5-a688-4998bc9773e3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "none",
"comment": "docs: Adding @internal to getInitials.",
"packageName": "@fluentui/react-avatar",
"email": "[email protected]",
"dependentChangeType": "none"
}
4 changes: 3 additions & 1 deletion packages/react-components/react-avatar/etc/react-avatar.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,9 @@ export type AvatarState = ComponentState<AvatarSlots> & Required<Pick<AvatarProp
color: NonNullable<Exclude<AvatarProps['color'], 'colorful'>>;
};

// @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;
Expand Down
2 changes: 2 additions & 0 deletions packages/react-components/react-avatar/src/utils/getInitials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down