# Rich Text Visualization Options

**Component Reference:** Rich Text or @splunk/visualizations/richText

Source: `@splunk/visualization-schemas/richTextOptionsSchema`

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `backgroundColor` | string | `transparent` | Specify the background color using a Hex code such as "#FF0000" or "transparent". Pattern: `^#(?:[0-9a-fA-F]{3,4}\|[0-9a-fA-F]{6}\|[0-9a-fA-F]{8})$\|^transparent$\|^rgb\\(\\s*(\\d{1,3}),\\s*(\\d{1,3}),\\s*(\\d{1,3})\\)$\|^rgba\\(\\s*(\\d{1,3}%?),\\s*(\\d{1,3}%?),\\s*(\\d{1,3}%?),\\s*(\\d*(?:\\.\\d+)?)\\)$\|\\$(\\w+:)?([^$\|:]+?)(\\\|[\|\\w]+)?\\$` |
| `bold` | boolean | `false` | Apply bold font weight to all text by default. |
| `border` | object | — | Border configuration for the rich text container. |
| `customFontSize` | number | `14` | Specify the custom font size in pixels when fontSize is set to "custom". Valid range is 1-200. Range: min 1, max 200 |
| `fontColor` | string | `> themes.defaultFontColor` | Specify the text color using Hex codes or RGBA values, such as "#FF0000" or "rgba(25,12,13,0.1)". The default for enterprise light is "#3c444d". The default for enterprise dark is "#FFFFFF". The default for prisma dark is "rgba(255, 255, 255, 0.7)". Pattern: `^#(?:[0-9a-fA-F]{3,4}\|[0-9a-fA-F]{6}\|[0-9a-fA-F]{8})$\|^transparent$\|^rgb\\(\\s*(\\d{1,3}),\\s*(\\d{1,3}),\\s*(\\d{1,3})\\)$\|^rgba\\(\\s*(\\d{1,3}%?),\\s*(\\d{1,3}%?),\\s*(\\d{1,3}%?),\\s*(\\d*(?:\\.\\d+)?)\\)$\|\\$(\\w+:)?([^$\|:]+?)(\\\|[\|\\w]+)?\\$` |
| `fontFamily` | string | `Splunk Data Sans` | Specify the font family for rich text content, such as "Arial" or "Times New Roman". Note: the font needs to be available to your end user. Allowed values: `Splunk Data Sans`, `Splunk Platform Sans Mono`, `Arial`, `Helvetica`, `Times New Roman`, `Comic Sans MS`, `Georgia`, `Verdana`, `Courier New` |
| `fontSize` | string | `default` | Specify the base font size preset. Font sizes range from extra small (10px) to extra large (20px) with the default being 14px. Allowed values: `extraSmall`, `small`, `default`, `large`, `extraLarge`, `custom` |
| `highlightColor` | string | `transparent` | Specify the highlight/background color for selected text using Hex codes or RGBA values. Pattern: `^#(?:[0-9a-fA-F]{3,4}\|[0-9a-fA-F]{6}\|[0-9a-fA-F]{8})$\|^transparent$\|^rgb\\(\\s*(\\d{1,3}),\\s*(\\d{1,3}),\\s*(\\d{1,3})\\)$\|^rgba\\(\\s*(\\d{1,3}%?),\\s*(\\d{1,3}%?),\\s*(\\d{1,3}%?),\\s*(\\d*(?:\\.\\d+)?)\\)$\|\\$(\\w+:)?([^$\|:]+?)(\\\|[\|\\w]+)?\\$` |
| `horizontalAlignment` | string | `left` | Specify the horizontal text alignment. Allowed values: `left`, `center`, `right`, `justify` |
| `italic` | boolean | `false` | Apply italic font style to all text by default. |
| `lineHeight` | number \| string | `1.5` | Specify the line height as a number (e.g., 1.5 means 150% of font size) or string value. |
| `link` | string | `` | Specify a URL to make the entire rich text content a clickable link. |
| `listType` | string | `` | Specify the default list type for the content. Allowed values: ``, `unordered`, `ordered` |
| `padding` | number \| array<unknown> | `8` | Padding in pixels. Can be a single number (all sides), array of 2 (vertical, horizontal), or array of 4 (top, right, bottom, left). |
| `previewTokenValues` | boolean | `false` | When true, resolved token values are shown in the editor while in edit mode. When false (default), $token$ patterns are displayed as-is in edit mode. Tokens always resolve in view mode regardless of this setting. |
| `richTextContent` | string | `<p></p>` | HTML content for the rich text editor. Inline styles should only include differences from default text styles. |
| `strikethrough` | boolean | `false` | Apply strikethrough text decoration to all text by default. |
| `underline` | boolean | `false` | Apply underline text decoration to all text by default. |
| `verticalAlign` | string | `top` | Specify the vertical alignment of content within the container. Allowed values: `top`, `middle`, `bottom` |

_Auto-generated; do not edit by hand._
