ListFormatStyle

struct · iOS 15.0+ · SDK 27.1

struct ListFormatStyle<Style, Base> where Style : FormatStyle, Base : Sequence, Style.FormatInput == Base.Element, Style.FormatOutput == String

A type that formats lists of items with a separator and conjunction appropriate for a given locale. A list format style creates human readable text from a `Sequence` of values. Customize the formatting behavior of the list using the ``width``, ``listType``, and ``locale`` properties. The system automatically caches unique configurations of ``ListFormatStyle`` to enhance performance. Use either `formatted()` or `formatted(_:)`, both instance methods of `Sequence`, to create a string representation of the items. The `formatted()` method applies the default list format style to a sequence of strings. For example: ```swift ["Kristin", "Paul", "Ana", "Bill"].formatted() // Kristin, Paul, Ana, and Bill ``` You can customize a list's `type` and `width` properties. - The ``listType`` property specifies the semantics of the list. - The ``width`` property determines the size of the returned string. The `formatted(_:)` method applies a custom list format style. You can use the static factory method `list(type:width:)` to create a custom list format style as a parameter to the method. This example formats a sequence with a ``ListType/and`` list type and ``Width/short`` width: ```swift ["Kristin", "Paul", "Ana", "Bill"].formatted(.list(type: .and, width: .short)) // Kristin, Paul, Ana, & Bill ``` You can provide a member format style to transform each list element to a string in applications where the elements aren't already strings. For example, the following code sample uses an `IntegerFormatStyle` to convert a range of integer values into a list: ```swift (5201719 ... 5201722).formatted(.list(memberStyle: IntegerFormatStyle(), type: .or, width: .standard)) // For locale: en_US: 5,201,719, 5,201,720, 5,201,721, or 5,201,722 // For locale: fr_CA: 5 201 719, 5 201 720, 5 201 721, ou 5 201 722 ``` > Note: > The generated string is locale-dependent and incorporates linguistic and cultural conventions of the user. You can create and reuse a list format style instance to format similar sequences. For example: ```swift let percentStyle = ListFormatStyle<FloatingPointFormatStyle.Percent, StrideThrough<Double>>(memberStyle: .percent) stride(from: 7.5, through: 9.0, by: 0.5).formatted(percentStyle) // 7.5%, 8%, 8.5%, and 9% stride(from: 89.0, through: 95.0, by: 2.0).formatted(percentStyle) // 89%, 91%, 93%, and 95% ```

Members (0)

This type has no directly callable members in this snapshot. See the framework’s skipped declarations for unsupported APIs.

All Foundation types →