DateComponentsFormatter
A formatter that creates string representations of quantities of time.
Declaration
class DateComponentsFormatterOverview
An DateComponentsFormatter object takes quantities of time and formats them as a user-readable string. Use a date components formatter to create strings for your app’s interface. The formatter object has many options for creating both abbreviated and expanded strings. The formatter takes the current user’s locale and language into account when generating strings.
To use this class, create an instance, configure its properties, and call one of its methods to generate an appropriate string. The properties of this class let you configure the calendar and specify the date and time units you want displayed in the resulting string. The listing below shows how to configure a formatter to create the string “About 5 minutes remaining”.
The methods of this class may be called safely from any thread of your app. It is also safe to share a single instance of this class from multiple threads, with the caveat that you should not change the configuration of the object while another thread is using it to generate a string.
Topics
Formatting Values
Configuring the Formatter Options
allowedUnitsallowsFractionalUnitscalendarcollapsesLargestUnitincludesApproximationPhraseincludesTimeRemainingPhrasemaximumUnitCountunitsStylezeroFormattingBehavior