feat: add a character counter to gl-form-textarea
What does this MR do?
Provides a recommended character count option and a maximum character count option.
The recommended character count is always displayed, counting down to 0,
formatted by the characterCountText
prop. It remains gray even when
the difference is 0. Once the threshold is crossed, the count is
displayed as grey, formatted by the characterCountOverLimitText
. This
is set by using the countType
of 'recommended'
.
The maximum character count is always displayed, counting down to 0,
formatted by the characterCountText
prop. It remains grey if the
remaining count is 0. Once the threshold has been crossed, the count is
displayed as a negative value with danger text and formatted by the
characterCountOverLimitText
. This is set by using the countType
of
'max'
, and is the default choice.
This is only enabled if count
is truthy, as a max or recommended count
of 0
don't really make sense.
NO DEFAULT FORMATTED TEXT IS PROVIDED FOR characterCountText
OR
characterCountOverLimitText
. THIS IS BECAUSE THERE ARE NO TRANSLATIONS
AVAILABILE IN THIS PROJECT.
The recommended values are below:
For max
type
-
characterCountText
:'%{count} characters left'
-
characterCountOverLimitText
:'%{count} characters over limit'
For recommended
type
-
characterCountText
:'%{count} recommended characters left'
-
characterCountTextOverLimit
:'%{count} over recommended length'
Closes Add character count support to GlFormTextarea (#1243 - closed)
Does this MR meet the acceptance criteria?
Conformity
-
Code review guidelines. -
GitLab UI's contributing guidlines. -
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 in the following projects to ensure that the @gitlab/ui
package can be upgraded quickly after the changes are released:-
GitLab: mr_url -
CustomersDot: mr_url -
Status Page: mr_url
-
-
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"
toaria-expanded="true"
when an accordion is expanded. -
Color combinations have sufficient contrast.