adobe/spectrum-web-components

[Bug]: Coachmark step count is not localized

Open

#4,780 opened on Sep 24, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (256 forks)auto 404
Component:CoachmarkFeatureGood first issueSEV 3i18n

Repository metrics

Stars
 (1,525 stars)
PR merge metrics
 (PR metrics pending)

Description

Code of conduct

  • I agree to follow this project's code of conduct.

Impacted component(s)

Coachmark

Expected behavior

In the Coachmark component the step count, for example "1 of 3" has hardcoded the "of" string. The expected behavior is that this string is localized, or is at least configurable so the client can pass in the string to use in this case.

Actual behavior

The "of" word is hardcoded.

Screenshots

issue-2 issue-3

What browsers are you seeing the problem in?

Chrome

How can we reproduce this issue?

Bug was discovered in a pre-release version so I can't share my own reproduction steps, as the feature has not been publicly released. But this surely reproduces anywhere Coachmark component is used.

  1. Change language to non-english
  2. Enter multi-step coachmark tour Code where this is hard-coded is here https://github.com/adobe/spectrum-web-components/blob/a2b6bea7142930d8143d9ca887e2c56ffa71a669/packages/coachmark/src/Coachmark.ts#L278

Sample code or abstract reproduction which illustrates the problem

No response

Severity

SEV 3

Logs taken while reproducing problem

No response

Contributor guide

Research direction
Locate the hardcoded 'of' string in the Coachmark component (likely in packages/coachmark/src/Coachmark.ts) and replace it with a localized version or add a property to make it configurable.
Tech stack
typescript
Domain
frontend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90