Object

ListItemStyle

The object for defining the style for bulleted or numbered lists in an article.

Properties

type
string
(Required)

The type of list item indicator to use.

Allowed options are:

  • bullet: Prepends a bullet before each list item. This is the default for unordered lists.

  • decimal: Prepends each list item with an incremental number. This is the default for ordered lists.

  • lower_alphabetical: Prepends list items with a lowercase letter.

  • upper_alphabetical: Prepends list items with an uppercase letter.

  • lower_roman: Prepends list items with a lowercase Roman numeral.

  • upper_roman: Prepends list items with an uppercase Roman numeral.

  • character: Prepends list items with a custom character. Use the character property to specify a character.

  • none: Will not prepend any indicator for list items. Indenting will still be in effect.

character
string

If type is set to character, provide the character to use as the list item indicator. Only a single character is supported.

Discussion

Use the ListItemStyle object to define text formatting for a bulleted (unordered) or numbered (ordered) list. Put listItemStyle inside a TextStyle object or ComponentTextStyle object and set the text component’s format property to html. See Using HTML with Apple News Format.

This object can be used in TextStyle and ComponentTextStyle.

Example

{ "componentTextStyles": { "exampleStyle": { "unorderedListItems": { "type": "character", "character": "✓" } } }}

See Also

Text Styles

Defining and Applying Text Styles

Define and apply custom, default, and inline text styles, or use HTML tags or Markdown syntax to style your text.

About Apple News Format Fonts

See the iOS font families supported in Apple News Format.

object TextStyle

The object for defining the text style (font family, size, color, and so on) that you can apply to ranges of text.

object ComponentTextStyle

The object for defining the style for a text component, including spacing, alignment, and drop caps.

object DropCapStyle

The object for defining the drop cap text style for use in the first paragraph in a text component.

object InlineTextStyle

The object for applying text styling when not using HTML or Markdown formatting.