Skip to main content
Version: v2

FormattedAtom Interface

Portion of a string with formatting.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature​

/** @sealed */
interface FormattedAtom<TFormat, TText>

Type Parameters​

ParameterDescription
TFormat
TText

Properties​

PropertyAlertsModifiersTypeDescription
contentAlphareadonlyTTextContent which is formatted.
formatAlphaTFormatFormatting which is applied to the content.

Property Details​

content​

Content which is formatted.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

readonly content: TText;

Type: TText

format​

Formatting which is applied to the content.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

format: TFormat;

Type: TFormat

Remarks​

Can be reassigned or deeply mutated to edit the formatting of the content.