docs(ui-kit/ios): document per-entity link, phone and email colors - #484
Open
shreeyajoshi-cometchat wants to merge 1 commit into
Open
docs(ui-kit/ios): document per-entity link, phone and email colors#484shreeyajoshi-cometchat wants to merge 1 commit into
shreeyajoshi-cometchat wants to merge 1 commit into
Conversation
Covers the new textLinkColor, textPhoneNumberColor and textEmailColor properties on TextBubbleStyle and LinkPreviewBubbleStyle, their fallback to textHighlightColor, and the inheritance from textBubbleStyle to linkPreviewBubbleStyle. Also clarifies linkTextColor (the static URL caption on the preview card) versus textLinkColor (the tappable link in the message text), with the Android attribute equivalents. Ref: cometchat-team/uikit-ios#957 [ENG-38546] Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
Description
Documents the per-entity link colours added to the iOS UI Kit in cometchat-team/uikit-ios#957 (ENG-38546). Before this change
textHighlightColorwas the single value applied to URLs, phone numbers and email addresses alike, so integrators could not colour them differently. Three new optional properties —textLinkColor,textPhoneNumberColorandtextEmailColor— now exist on bothTextBubbleStyleandLinkPreviewBubbleStyle, and none of them were documented.Two sections are added to
ui-kit/ios/message-bubble-styling.mdx:## Text Bubble. A properties table covering the three newUIColor?properties plustextHighlightColoras the documented fallback, followed by global and per-instance Swift examples.## Link Preview Bubble. Covers how preview bubbles inherit the colours fromtextBubbleStyle, and separates the tappable in-text link from the preview card's own labels.Behaviour was verified against the implementation rather than the PR description, which surfaced two things worth noting for review:
textLinkColor ?? textHighlightColor, with defaults set inTextBubbleStyle.init(styleType:)— the theme's info colour for incoming bubbles, white for outgoing.2b8df826b) addsdidSet-driven inheritance fromtextBubbleStyletolinkPreviewBubbleStyle. It only fills values still unset and re-runs on every write totextBubbleStyle, so assignment order is observable. This is documented as a Note so integrators do not hit it as a surprise.linkTextColorandtextLinkColorare easy to confuse — the first styles the static URL caption printed beneath the preview card, the second the tappable link in the message text. Both are called out explicitly, with the Android attribute equivalents (cometchatTextBubbleLinkPreviewTitleColor,...DescriptionColor,...LinkColor) cross-referenced.Related Issue(s)
ENG-38546 · Source PR: cometchat-team/uikit-ios#957
Type of Change
Checklist
Additional Information
iOS is the first CometChat platform to expose per-entity link colours, so there was no cross-platform doc pattern to mirror and these sections are iOS-original. For reviewer context, a survey of the other platforms found:
textLinkColor/textPhoneNumberColor/textEmailColorcometchatTextBubbleTextLinkColorlinkTextColor, explicitly shared across URL, phone and email--cometchat-text-color-highlighttoken or hand-written CSSOne naming collision is worth flagging but is not addressed here, since it is an API-level concern rather than a docs one: iOS uses
linkTextColorfor the preview card's URL caption, whereas React Native useslinkTextColorfor the tappable link — the opposite meaning. The iOS docs disambiguate the two names in prose, but if cross-platform parity work follows, that is the collision to resolve.No screenshots included — the change is text and tables only, with no new images.