Skip to content

feat(GlSingleStat): Format the displayed number based on locale

What does this MR do?

Whilst working with larger numbers and GlSingleStat I came to realize that it may be easier to read if the numbers were delimited.

So this creates a new util to delimit provided numbers based upon the user's locale (or one provided). This should mean that in Germany for example, the thousand's delimiter is a point whilst the decimal delimiter is a comma.

I've then updated GlSingleStat to use this util for the rendered number if useDelimiters is set to true.

Due to GlSingleStat using the utility GlAnimatedNumber if it is to be animated, I have had to apply the same thing to the utility GlAnimatedNumber too.

Screenshots or screen recordings

Without animation

Before Without delimiters With delimiters
image image image

With animation

Before Without delimiters With delimiters
animated_single_stat animated_single_stat animated_delimited_single_stat

Testing the changes

The simplest way would be to use the review app and view the change in Storybook.

If you would like to test it within GitLab you can either pull down this branch and update your local GDK to use it or use the integration branch. Upon getting this version of GitLab UI, use an existing GlSingleStat component and force it to use a value that exceeds 1000 to have the value delimited.

If you're feeling lucky, you could use Product Analytics, but this requires Docker/Ranger to be installed.

I would also be open to 🍐 and share my screen showing it in situ 🙂

Integration merge requests

Does this MR meet the acceptance criteria?

This checklist encourages the authors, reviewers, and maintainers of merge requests (MRs) to confirm changes were analyzed for conformity with the project's guidelines, security and accessibility.

Toggle the acceptance checklist

Conformity

  • Code review guidelines.
  • GitLab UI's contributing guidelines.
  • If it changes a Pajamas-compliant component's look & feel, the MR has been reviewed by a UX designer.
  • If it changes GitLab UI's documentation guidelines, the MR has been reviewed by a Technical Writer.
  • If the MR changes a component's API, integration MR(s) have been opened (see integration merge requests above).
  • Added the ~"component:*" label(s) if applicable.

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • Security reports checked/validated by a reviewer from the AppSec team

Accessibility

If this MR adds or modifies a component, take a few moments to review the following:

  • All actions and functionality can be done with a keyboard.
  • Links, buttons, and controls have a visible focus state.
  • All content is presented in text or with a text equivalent. For example, alt text for SVG, or aria-label for icons that have meaning or perform actions.
  • Changes in a component’s state are announced by a screen reader. For example, changing aria-expanded="false" to aria-expanded="true" when an accordion is expanded.
  • Color combinations have sufficient contrast.
Edited by Robert Hunt

Merge request reports