<!--
{
  "availability" : [
    "iOS: 15.0.0 -",
    "iPadOS: 15.0.0 -",
    "macCatalyst: 15.0.0 -",
    "macOS: 12.0.0 -",
    "tvOS: 15.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 8.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Foundation",
  "identifier" : "/documentation/Foundation/Date/FormatStyle/Symbol/CyclicYear",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "Foundation"
    ],
    "preciseIdentifier" : "s:10Foundation4DateV11FormatStyleV6SymbolV10CyclicYearV"
  },
  "title" : "Date.FormatStyle.Symbol.CyclicYear"
}
-->

# Date.FormatStyle.Symbol.CyclicYear

A type that specifies a format for a cyclic year in a date format style.

```
struct CyclicYear
```

## Overview

Calendars such as the Chinese lunar calendar and Hindu calendars use 60-year cycles of year names. If the calendar doesn’t provide cyclic year-name data, or if the year value to format is out of the range of years for which the system provides cyclic name data, then the formatting is numeric, as in [`Date.FormatStyle.Symbol.Year`](/documentation/Foundation/Date/FormatStyle/Symbol/Year).

The [`Date.FormatStyle.Symbol.CyclicYear`](/documentation/Foundation/Date/FormatStyle/Symbol/CyclicYear) type includes static factory variables that create custom [`Date.FormatStyle.Symbol.CyclicYear`](/documentation/Foundation/Date/FormatStyle/Symbol/CyclicYear) objects:

|Factory variable                                                                                      |Description                                                                                  |
|------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
|``doc://com.apple.foundation/documentation/Foundation/Date/FormatStyle/Symbol/CyclicYear/abbreviated``|A shortened representation of the cyclic year appropriate for space-constrained applications.|
|``doc://com.apple.foundation/documentation/Foundation/Date/FormatStyle/Symbol/CyclicYear/narrow``     |The shortest representation of the cyclic year.                                              |
|``doc://com.apple.foundation/documentation/Foundation/Date/FormatStyle/Symbol/CyclicYear/wide``       |The full representation of the cyclic year.                                                  |

If no format is specified as a parameter, the [`abbreviated`](/documentation/Foundation/Date/FormatStyle/Symbol/CyclicYear/abbreviated) static variable is the default format.

For more information about formatting dates, see [`Date.FormatStyle`](/documentation/Foundation/Date/FormatStyle).

## Topics

### Modifying a Cyclic Year

[`static var abbreviated: Date.FormatStyle.Symbol.CyclicYear`](/documentation/Foundation/Date/FormatStyle/Symbol/CyclicYear/abbreviated)

Custom cyclic year format style that portrays a shortened cyclic year.

[`static var narrow: Date.FormatStyle.Symbol.CyclicYear`](/documentation/Foundation/Date/FormatStyle/Symbol/CyclicYear/narrow)

Custom cyclic year format style that portrays the shortest representation of a cyclic year.

[`static var wide: Date.FormatStyle.Symbol.CyclicYear`](/documentation/Foundation/Date/FormatStyle/Symbol/CyclicYear/wide)

Custom cyclic year format style that portrays a complete representation of a cyclic year.

### Comparing Cyclic Years

[`static func == (Date, Date) -> Bool`](/documentation/Foundation/Date/==(_:_:))

Returns true if the two `Date` values represent the same point in time.

### Type Properties

[`static let omitted: Date.FormatStyle.Symbol.CyclicYear`](/documentation/Foundation/Date/FormatStyle/Symbol/CyclicYear/omitted)

The option for not including the symbol in the formatted output.

## Relationships

### Conforms To

[`Sendable`](/documentation/Swift/Sendable)

[`Equatable`](/documentation/Swift/Equatable)

[`SendableMetatype`](/documentation/Swift/SendableMetatype)

[`Hashable`](/documentation/Swift/Hashable)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)