adobe / adobe/spectrum-web-components

[Bug]: Coachmark step count is not localized

Open
#4,780 2 comments 0 reactions 0 assignees View on GitHub
Component:Coachmark Feature Good first issue i18n SEV 3
Dominant language
TypeScript
Stars
1.5k
Forks
262
Avg merge
3d 10h
Merged PRs (30d)
68

Description

### Code of conduct

- [X] 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](https://github.com/user-attachments/assets/fa571da0-9358-4c4c-827e-e9f71c43bb31)
![issue-3](https://github.com/user-attachments/assets/6b3c6094-5d40-4a32-beb7-abc671b70a35)

### 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

Open the contributing guide

Research direction

Start in packages/coachmark/src/Coachmark.ts around line 278, where the step count is assembled. Check the Coachmark usage and localization behavior with a non-English multi-step tour; done means the “of” text is localized or can be supplied by the client.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend, internationalization
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.