https://github.com/chrynan/colors
Kotlin Multiplatform Colors
https://github.com/chrynan/colors
color colors graphics kotlin kotlin-library kotlin-multi-platform kotlin-multiplatform multiplatform ui
Last synced: 5 months ago
JSON representation
Kotlin Multiplatform Colors
- Host: GitHub
- URL: https://github.com/chrynan/colors
- Owner: chRyNaN
- License: apache-2.0
- Created: 2019-04-04T19:09:18.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-12T17:37:08.000Z (over 1 year ago)
- Last Synced: 2024-09-13T06:50:47.597Z (over 1 year ago)
- Topics: color, colors, graphics, kotlin, kotlin-library, kotlin-multi-platform, kotlin-multiplatform, multiplatform, ui
- Language: Kotlin
- Homepage:
- Size: 11.9 MB
- Stars: 10
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# colors
Kotlin Multi-platform Color Support. This allows using Colors in multi-platform code. Compatible with Jetpack
Compose/Multi-platform. Serialization and Palette Generation Support.
```kotlin
val white = Color("#FFFFFF")
val black = Color(red = 0, green = 0, blue = 0)
println("White: colorLong = ${white.colorLong}; cssValue = ${white.cssValue}")
println("Black: colorLong = ${black.colorLong}; cssValue = ${black.cssValue}")
```
## Usage
To obtain a `Color` instance, use one of the constructor functions:
```kotlin
Color("#FFFFFF")
Color(255, 255, 255, 255)
Color(0xFFFFFFFF)
// Or to obtain a specific Color type, like RgbaColor
RgbaColor(255, 255, 255, 255)
```
Using properties from the `Color` interface:
```kotlin
// sRGB Color Int
color.colorInt
// Color components and ColorSpace encoded into a Long
color.colorLong
// CSS Value
color.cssValue
// ColorSpace
color.colorSpace
// Alpha value
color.alpha
// Specific Color components
color.component1()
// All Color Components - Example for an RGBA Color
val (red, green, blue, alpha) = color
// Color Components as a FloatArray
color.components
```
## Building the library
The library is provided through [Repsy.io](https://repsy.io). Checkout the
[releases page](https://github.com/chRyNaN/colors/releases) to get the latest version.
### Repository
```kotlin
repositories {
maven { url = uri("https://repo.repsy.io/mvn/chrynan/public") }
}
```
### Dependencies
#### Core:
```kotlin
implementation("com.chrynan.colors:colors-core:$VERSION")
```
#### Extensions:
```kotlin
implementation("com.chrynan.colors:colors-extension:$VERSION")
```
#### Theme:
```kotlin
implementation("com.chrynan.colors:colors-theme:$VERSION")
```
#### Palette:
```kotlin
implementation("com.chrynan.colors:colors-palette:$VERSION")
```
#### Compose Multiplatform:**
```kotlin
implementation("com.chrynan.colors:colors-compose:$VERSION")
```
#### Compose HTML:
```kotlin
implementation("com.chrynan.colors:colors-compose-web:$VERSION")
```
## Documentation
More detailed documentation is available in the [docs](docs) folder. The entry point to the
documentation can be found [here](docs/index.md).
## Sample
Checkout the [Android Sample Project](sample-android) for an example of using the library.
## License
```
Copyright 2021 chRyNaN
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```