Add basic styled text documentation #10296
Open
Conversation
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
NigelBreslaw
approved these changes
Dec 22, 2025
expenses
force-pushed
the
styled-text-docs
branch
from
086f6ef to
1ad58db
Compare
tronical
reviewed
Jan 7, 2026
| import CodeSnippetMD from "@slint/common-files/src/components/CodeSnippetMD.astro"; | ||
|
|
||
|
|
||
| The `StyledText` type renders text with various styling and interactive properties, such as bolded, underlined and colored sections as well as HTTP links. It is based on a subset of the [commonmark](https://commonmark.org/) spec. |
Member
There was a problem hiding this comment.
This is under types and properties but it looks like the reference documentation for the element (as the quoted text says).
I suggest to either fold this into the styled text element reference docs or cross-link between them and disambiguate that this is about the property type, not the element. A way of disambiguating would be to use the actual property type in this file. But my preference is folding them for now.
tronical
reviewed
Jan 7, 2026
|
|
||
| Styled Text supports the following features: | ||
|
|
||
| - Italics |
Member
There was a problem hiding this comment.
Instead of a plain list, I think it would be better to have a visual table, like here: https://commonmark.org/help/
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
No description provided.