Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sersoft-gmbh/color-components
A color component calculation library
https://github.com/sersoft-gmbh/color-components
swift swiftui
Last synced: about 1 month ago
JSON representation
A color component calculation library
- Host: GitHub
- URL: https://github.com/sersoft-gmbh/color-components
- Owner: sersoft-gmbh
- License: apache-2.0
- Created: 2020-12-27T15:36:39.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-24T12:53:35.000Z (4 months ago)
- Last Synced: 2024-11-16T02:04:53.411Z (2 months ago)
- Topics: swift, swiftui
- Language: Swift
- Homepage: https://sersoft-gmbh.github.io/color-components/
- Size: 16.3 MB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Color Components
[](https://github.com/sersoft-gmbh/color-components/releases/latest)
[](https://www.codacy.com/gh/sersoft-gmbh/color-components/dashboard?utm_source=github.com&utm_medium=referral&utm_content=sersoft-gmbh/color-components&utm_campaign=Badge_Grade)
[](https://codecov.io/gh/sersoft-gmbh/color-components)
[](https://sersoft-gmbh.github.io/color-components)
A color component calculation library written in Swift.
## Installation
Add the following dependency to your `Package.swift`:
```swift
.package(url: "https://github.com/sersoft-gmbh/color-components.git", from: "1.0.0"),
```
Or add it via Xcode (as of Xcode 11).
## Usage
These color component implementations are currently included in `ColorComponents`:
- `BW` & `BWA`
- `HSB` & `HSBA` (with aliases for `HSV` & `HSVA`)
- `HSL` & `HSLA`
- `RGB` & `RGBA`
- `CIE.XYZ` & `CIE.XYZA`
Each implementation is generic and supports both integer values (0 - 255) and floating point values (0.0 - 1.0). Also, conversions between components have been implemented. Some conversions have to go through other components, though.
If available, each implementation also provides conversion options from and to the platform native colors (e.g. `UIColor` on iOS, tvOS & watchOS and `NSColor` on macOS). `SwiftUI.Color` is also supported as of macOS 11, iOS 14, tvOS 14 and watchOS 7. Due to the lack of direct component accessors, `SwiftUI.Color` support goes through the aforementioned platform colors.
## Possible Features
While not yet integrated, the following features might provide added value and could make it into this package in the future:
- CMYK color components.
- LAB color components.
- Color space support.
- More ways of converting between components, by implementing conversion paths.
## Documentation
The API is documented using header doc. If you prefer to view the documentation as a webpage, there is an online version available for you:
- [ColorComponents](https://sersoft-gmbh.github.io/color-components/main/documentation/colorcomponents)
- [ColorCalculations](https://sersoft-gmbh.github.io/color-components/main/documentation/colorcalculations)
## Contributing
If you find a bug / like to see a new feature in this package there are a few ways of helping out:
- If you can fix the bug / implement the feature yourself please do and open a PR.
- If you know how to code (which you probably do), please add a (failing) test and open a PR. We'll try to get your test green ASAP.
- If you can do neither, then open an issue. While this might be the easiest way, it will likely take the longest for the bug to be fixed / feature to be implemented.
## License
See [LICENSE](./LICENSE) file.