fix(CollaboratorAvatarGroup): canonicalize User.border_color → borderColor#1495
Merged
mascot-five merged 1 commit intomasterfrom May 6, 2026
Merged
Conversation
…Color Phase 7c (commit 3a18882) deferred this rename on the grounds that it would be a public sistent API break. That carve-out was correct at the time, but it has stopped being load-bearing now that we've established the coordinated-rename pattern via sistent#1484 (`useRoomActivity({ provider_url → providerUrl })`): rename the sistent contract → ship a sistent release → bump consumers in lockstep. We own the project; bringing the last consumer-facing snake_case identifier inline with the canonical naming scheme is exactly the kind of change the contract is for. Changes - `User.border_color: string` → `User.borderColor: string` on the exported `Users` prop interface for `CollaboratorAvatarGroup`. - Both `<StyledAvatar>` call sites (visible avatar group + popup overflow) updated to read `user.borderColor`. - JSDoc example + `@property` doc comment updated to match. Verified - `npx jest` — 29/29 passing. - `grep -rn "border_color" src/` — no matches. Coordinated consumer flips - `meshery-extensions/meshmap/collaborators/app.tsx:59` (the only call site building a `Users` map for `<CollaboratorAvatarGroup>`). After this PR ships in a sistent release and `@sistent/sistent` is bumped in extensions, the consumer flip is a one-line change in the same PR as the bump (matching the pattern in meshery-extensions#4221). - No other downstream consumers identified by repo audit. Signed-off-by: Yi Nuo <218099172+yi-nuo426@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates CollaboratorAvatarGroup’s public-facing users prop shape to use canonical camelCase by renaming the remaining snake_case field border_color to borderColor, aligning with the broader identifier-naming contract used across the Sistent ecosystem.
Changes:
- Renamed
User.border_color→User.borderColorin theusersmap type used byCollaboratorAvatarGroup. - Updated both
StyledAvatarcall sites to readuser.borderColor. - Updated the JSDoc example and
@propertydocumentation to match the new field name.
Contributor
There was a problem hiding this comment.
Code Review
This pull request refactors the User interface and its usage within the CollaboratorAvatarGroup component by renaming the border_color property to borderColor to align with camelCase naming conventions. The changes are consistently applied across the interface definition, JSDoc documentation, and component props. There are no review comments to address, and I have no further feedback to provide.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Renames the last remaining snake_case identifier on Sistent's consumer-facing API: `User.border_color` → `User.borderColor` on the `Users` prop interface for `CollaboratorAvatarGroup`.
Phase 7c (commit `3a18882d`) deferred this rename on the grounds that it would be a public Sistent API break. That carve-out has stopped being load-bearing now that we've established the coordinated-rename pattern via #1484 (`useRoomActivity({ provider_url → providerUrl })`): rename the Sistent contract → ship a Sistent release → bump consumers in lockstep. We own the project; canonicalizing the last consumer-facing snake_case identifier is exactly what the contract is for.
Changes
Diff: 5 lines changed in 1 file.
Test plan
Coordinated consumer flips
After this PR ships in a Sistent release and `@sistent/sistent` is bumped in extensions:
No other downstream consumers identified by cluster-wide audit.
References