Skip to content

Commit 5b44670

Browse files
committed
Update documentation
1 parent 0636894 commit 5b44670

2 files changed

Lines changed: 8 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,17 @@
1717
### Changed
1818

1919
- Update code for Swift 6.3.
20-
- Raise the minimum supported macOS version to 15.
2120
- Return `nil` for out-of-range hexadecimal color values instead of asserting.
2221
- Return `nil` for CSS color codes with out-of-range numeric components.
2322

2423

24+
### Breaking Changes
25+
26+
- Raise the minimum supported macOS version to 15.
27+
- Add `.shortHexWithAlpha`, `.cssHWB`, and `.cssHWBWithAlpha` cases to `ColorCodeType`; apps with exhaustive switches over the enum need updates.
28+
- Change `ColorCodeType` raw values to match the case order; apps that persist or exchange the raw integer values need migration.
29+
30+
2531
### Deprecated
2632

2733
- Deprecate `getHue(hue:saturation:lightness:alpha:)` in favor of `hslComponents`.
@@ -30,7 +36,6 @@
3036
### Fixed
3137

3238
- Create black colors from HSL color codes without producing NaN components.
33-
- Align `ColorCodeType` raw values with the case order.
3439
- Return `nil` instead of lossy short hexadecimal color codes.
3540
- Recognize CSS color keyword aliases that use the "grey" spelling.
3641

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
__ColorCode__ is a set of color extensions that allows creating NSColor/SwiftUI.Color instances from CSS color code strings, or color code strings from an NSColor instance. It also adds the ability to handle HSL color space.
44

5-
* __Requirements__: macOS 15 or later
5+
* __Requirements__: macOS 15 or later, iOS 18 or later
66

77

88
## Usage

0 commit comments

Comments
 (0)