Skip to content

Commit

Permalink
Bumped version to 1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
chRyNaN committed Jan 6, 2024
1 parent 6ca970d commit 5f65f41
Show file tree
Hide file tree
Showing 222 changed files with 1,825 additions and 1,047 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ object LibraryConstants {
const val group = "com.chrynan.colors"
const val owner = "chrynan"
const val repoName = "colors"
const val versionName = "1.0.0"
const val versionName = "1.1.0"
val versionDescription = "Release $versionName ($versionCode)"
const val license = "Apache-2.0"
const val vcsUrl = "https://github.com/chRyNaN/colors.git"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
# LocalColors

[common]\
val [LocalColors](-local-colors.md): ProvidableCompositionLocal<[Colors](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-colors/index.md)>
val [LocalColors](-local-colors.md): <!---  GfmCommand {"@class":"org.jetbrains.dokka.gfm.ResolveLinkGfmCommand","dri":{"packageName":"","classNames":"<Error class: unknown class>","callable":null,"target":{"@class":"org.jetbrains.dokka.links.PointingToDeclaration"},"extra":null}} --->&lt;Error class: unknown class&gt;<!--- --->&lt;<!---  GfmCommand {"@class":"org.jetbrains.dokka.gfm.ResolveLinkGfmCommand","dri":{"packageName":"","classNames":"<Error class: unknown class>","callable":null,"target":{"@class":"org.jetbrains.dokka.links.PointingToDeclaration"},"extra":null}} --->&lt;Error class: unknown class&gt;<!--- --->&gt;

A ProvidableCompositionLocal of the [Colors](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-colors/index.md) interface.
A ProvidableCompositionLocal of the Colors interface.

To access this value in a Composable function, simply access the `current` value:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
//[colors-compose-web](../../index.md)/[com.chrynan.colors.compose.web](index.md)

# Package com.chrynan.colors.compose.web
# Package-level declarations

## Types

| Name | Summary |
|---|---|
| [ComposeColor](-compose-color/index.md) | [common, js]<br>[common]<br>expect class [ComposeColor](-compose-color/index.md)<br>[js]<br>actual typealias [ComposeColor](-compose-color/index.md) = CSSColorValue |

## Functions
## Properties

| Name | Summary |
|---|---|
| [isSystemInDarkTheme](is-system-in-dark-theme.md) | [common]<br>@Composable<br>@ReadOnlyComposable<br>fun [isSystemInDarkTheme](is-system-in-dark-theme.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)<br>Determines whether the current system theme is set to dark mode. |
| [systemBasedColors](system-based-colors.md) | [common]<br>@Composable<br>fun [LightOrDarkColorTheme](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-light-or-dark-color-theme/index.md).[systemBasedColors](system-based-colors.md)(): [Colors](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-colors/index.md)<br>Obtains the appropriate [Colors](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-colors/index.md) instance of this [LightOrDarkColorTheme](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-light-or-dark-color-theme/index.md) depending on the result of the [isSystemInDarkTheme](is-system-in-dark-theme.md) function. If [isSystemInDarkTheme](is-system-in-dark-theme.md) returns true, then the [LightOrDarkColorTheme.dark](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-colors/index.md) will be returned. Otherwise, the [LightOrDarkColorTheme.light](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-colors/index.md) will be returned. |
| [toComposeColor](to-compose-color.md) | [common, js]<br>[common]<br>expect fun [Color](../../../colors-core/colors-core/com.chrynan.colors/-color/index.md).[toComposeColor](to-compose-color.md)(): [ComposeColor](-compose-color/index.md)<br>[js]<br>actual fun [Color](../../../colors-core/colors-core/com.chrynan.colors/-color/index.md).[toComposeColor](to-compose-color.md)(): [ComposeColor](-compose-color/index.md) |
| [toCSSColorValue](to-c-s-s-color-value.md) | [js]<br>fun [Color](../../../colors-core/colors-core/com.chrynan.colors/-color/index.md).[toCSSColorValue](to-c-s-s-color-value.md)(destinationColorSpace: [ColorSpace](../../../colors-core/colors-core/com.chrynan.colors.space/-color-space/index.md) = ColorSpaces.SRGB, renderIntent: [RenderIntent](../../../colors-core/colors-core/com.chrynan.colors.space/-render-intent/index.md) = RenderIntent.PERCEPTUAL): CSSColorValue<br>Converts this [Color](../../../colors-core/colors-core/com.chrynan.colors/-color/index.md) to a CSSColorValue so that it can be used with compose-web components. |
| [LocalColors](-local-colors.md) | [common]<br>val [LocalColors](-local-colors.md): <!---  GfmCommand {"@class":"org.jetbrains.dokka.gfm.ResolveLinkGfmCommand","dri":{"packageName":"","classNames":"<Error class: unknown class>","callable":null,"target":{"@class":"org.jetbrains.dokka.links.PointingToDeclaration"},"extra":null}} --->&lt;Error class: unknown class&gt;<!--- --->&lt;<!---  GfmCommand {"@class":"org.jetbrains.dokka.gfm.ResolveLinkGfmCommand","dri":{"packageName":"","classNames":"<Error class: unknown class>","callable":null,"target":{"@class":"org.jetbrains.dokka.links.PointingToDeclaration"},"extra":null}} --->&lt;Error class: unknown class&gt;<!--- --->&gt;<br>A ProvidableCompositionLocal of the Colors interface. |

## Properties
## Functions

| Name | Summary |
|---|---|
| [LocalColors](-local-colors.md) | [common]<br>val [LocalColors](-local-colors.md): ProvidableCompositionLocal&lt;[Colors](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-colors/index.md)&gt;<br>A ProvidableCompositionLocal of the [Colors](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-colors/index.md) interface. |
| [isSystemInDarkTheme](is-system-in-dark-theme.md) | [common]<br>fun [isSystemInDarkTheme](is-system-in-dark-theme.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)<br>Determines whether the current system theme is set to dark mode. |
| [systemBasedColors](system-based-colors.md) | [common]<br>fun <!---  GfmCommand {"@class":"org.jetbrains.dokka.gfm.ResolveLinkGfmCommand","dri":{"packageName":"","classNames":"<Error class: unknown class>","callable":null,"target":{"@class":"org.jetbrains.dokka.links.PointingToDeclaration"},"extra":null}} --->&lt;Error class: unknown class&gt;<!--- --->.[systemBasedColors](system-based-colors.md)(): <!---  GfmCommand {"@class":"org.jetbrains.dokka.gfm.ResolveLinkGfmCommand","dri":{"packageName":"","classNames":"<Error class: unknown class>","callable":null,"target":{"@class":"org.jetbrains.dokka.links.PointingToDeclaration"},"extra":null}} --->&lt;Error class: unknown class&gt;<!--- ---><br>Obtains the appropriate Colors instance of this LightOrDarkColorTheme depending on the result of the [isSystemInDarkTheme](is-system-in-dark-theme.md) function. If [isSystemInDarkTheme](is-system-in-dark-theme.md) returns true, then the Colors will be returned. Otherwise, the Colors will be returned. |
| [toComposeColor](to-compose-color.md) | [common]<br>expect fun <!---  GfmCommand {"@class":"org.jetbrains.dokka.gfm.ResolveLinkGfmCommand","dri":{"packageName":"","classNames":"<Error class: unknown class>","callable":null,"target":{"@class":"org.jetbrains.dokka.links.PointingToDeclaration"},"extra":null}} --->&lt;Error class: unknown class&gt;<!--- --->.[toComposeColor](to-compose-color.md)(): [ComposeColor](-compose-color/index.md) |
| [toCSSColorValue](to-c-s-s-color-value.md) | [js]<br>fun [Color](../../../colors-core/colors-core/com.chrynan.colors/-color/index.md).[toCSSColorValue](to-c-s-s-color-value.md)(destinationColorSpace: [ColorSpace](../../../colors-core/colors-core/com.chrynan.colors.space/-color-space/index.md) = ColorSpaces.SRGB, renderIntent: [RenderIntent](../../../colors-core/colors-core/com.chrynan.colors.space/-render-intent/index.md) = RenderIntent.PERCEPTUAL): CSSColorValue<br>Converts this [Color](../../../colors-core/colors-core/com.chrynan.colors/-color/index.md) to a CSSColorValue so that it can be used with compose-web components. |
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@
# isSystemInDarkTheme

[common]\

@Composable

@ReadOnlyComposable

fun [isSystemInDarkTheme](is-system-in-dark-theme.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)

Determines whether the current system theme is set to dark mode.
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
# systemBasedColors

[common]\
fun <!---  GfmCommand {"@class":"org.jetbrains.dokka.gfm.ResolveLinkGfmCommand","dri":{"packageName":"","classNames":"<Error class: unknown class>","callable":null,"target":{"@class":"org.jetbrains.dokka.links.PointingToDeclaration"},"extra":null}} --->&lt;Error class: unknown class&gt;<!--- --->.[systemBasedColors](system-based-colors.md)(): <!---  GfmCommand {"@class":"org.jetbrains.dokka.gfm.ResolveLinkGfmCommand","dri":{"packageName":"","classNames":"<Error class: unknown class>","callable":null,"target":{"@class":"org.jetbrains.dokka.links.PointingToDeclaration"},"extra":null}} --->&lt;Error class: unknown class&gt;<!--- --->

@Composable

fun [LightOrDarkColorTheme](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-light-or-dark-color-theme/index.md).[systemBasedColors](system-based-colors.md)(): [Colors](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-colors/index.md)

Obtains the appropriate [Colors](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-colors/index.md) instance of this [LightOrDarkColorTheme](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-light-or-dark-color-theme/index.md) depending on the result of the [isSystemInDarkTheme](is-system-in-dark-theme.md) function. If [isSystemInDarkTheme](is-system-in-dark-theme.md) returns true, then the [LightOrDarkColorTheme.dark](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-colors/index.md) will be returned. Otherwise, the [LightOrDarkColorTheme.light](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-colors/index.md) will be returned.
Obtains the appropriate Colors instance of this LightOrDarkColorTheme depending on the result of the [isSystemInDarkTheme](is-system-in-dark-theme.md) function. If [isSystemInDarkTheme](is-system-in-dark-theme.md) returns true, then the Colors will be returned. Otherwise, the Colors will be returned.
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,5 @@

# toComposeColor

[common, js]\
[common]\
expect fun [Color](../../../colors-core/colors-core/com.chrynan.colors/-color/index.md).[toComposeColor](to-compose-color.md)(): [ComposeColor](-compose-color/index.md)

[js]\
actual fun [Color](../../../colors-core/colors-core/com.chrynan.colors/-color/index.md).[toComposeColor](to-compose-color.md)(): [ComposeColor](-compose-color/index.md)
expect fun <!---  GfmCommand {"@class":"org.jetbrains.dokka.gfm.ResolveLinkGfmCommand","dri":{"packageName":"","classNames":"<Error class: unknown class>","callable":null,"target":{"@class":"org.jetbrains.dokka.links.PointingToDeclaration"},"extra":null}} --->&lt;Error class: unknown class&gt;<!--- --->.[toComposeColor](to-compose-color.md)(): [ComposeColor](-compose-color/index.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[colors-compose](../../../index.md)/[com.chrynan.colors.compose](../index.md)/[ComposeColor](index.md)

# ComposeColor

[common]\
typealias [ComposeColor](index.md) = [Color](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color.html)

typealias to [androidx.compose.ui.graphics.Color](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color.html).
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//[colors-compose](../../../index.md)/[com.chrynan.colors.compose](../index.md)/[ComposeColors](index.md)

# ComposeColors

[common]\
typealias [ComposeColors](index.md) = [Colors](https://developer.android.com/reference/kotlin/androidx/compose/material/Colors.html)

typealias to [androidx.compose.material.Colors](https://developer.android.com/reference/kotlin/androidx/compose/material/Colors.html).
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,8 @@ fun [MaterialTheme](-material-theme.md)(colorTheme: [LightOrDarkColorTheme](../.

A Composable function to create a [MaterialTheme](https://developer.android.com/reference/kotlin/androidx/compose/material/MaterialTheme.html) with the provided [Colors](../../../colors-theme/colors-theme/com.chrynan.colors.theme/-colors/index.md) class.

## See also
#### See also

common

| | |
|---|---|
| [androidx.compose.material.MaterialTheme](https://developer.android.com/reference/kotlin/androidx/compose/material/MaterialTheme.html) | |
| |
|---|
| [MaterialTheme](https://developer.android.com/reference/kotlin/androidx/compose/material/MaterialTheme.html) |
Loading

0 comments on commit 5f65f41

Please sign in to comment.