Skip to content

Commit

Permalink
Generated updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris committed Feb 11, 2023
1 parent 72e76ea commit e2de09f
Show file tree
Hide file tree
Showing 86 changed files with 800 additions and 174 deletions.
104 changes: 59 additions & 45 deletions docs/package-list

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
# ParcelableSaver

[common]\
fun <[T](-parcelable-saver.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [ParcelableSaver](-parcelable-saver.md)(parcelable: [Parcelable](../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcelable/index.md) = Parcelable.Default, serializer: KSerializer<[T](-parcelable-saver.md)>): Saver<[T](-parcelable-saver.md), *>

Creates a Saver that uses the provided [parcelable](-parcelable-saver.md) and [serializer](-parcelable-saver.md) to save and restore the value.
@ExperimentalSerializationApi

fun <[T](-parcelable-saver.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [ParcelableSaver](-parcelable-saver.md)(parcelable: [Parcelable](../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcelable/index.md) = Parcelable.Default, serializer: KSerializer<[T](-parcelable-saver.md)>): [Saver](-saver/index.md)<[T](-parcelable-saver.md), *>

Creates a [Saver](-saver/index.md) that uses the provided [parcelable](-parcelable-saver.md) and [serializer](-parcelable-saver.md) to save and restore the value.
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
//[parcelable-compose](../../../index.md)/[com.chrynan.parcelable.compose](../index.md)/[SaverScope](index.md)/[canBeSaved](can-be-saved.md)

# canBeSaved

[common, js]\
[common]\
expect abstract fun [canBeSaved](can-be-saved.md)(value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)

[js]\
actual abstract fun [canBeSaved](can-be-saved.md)(value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
//[parcelable-compose](../../../index.md)/[com.chrynan.parcelable.compose](../index.md)/[SaverScope](index.md)

# SaverScope

[common]\
expect fun interface [SaverScope](index.md)

[js]\
actual fun interface [SaverScope](index.md)

[android, jvm]\
actual typealias [SaverScope](index.md) = [SaverScope](https://developer.android.com/reference/kotlin/androidx/compose/runtime/saveable/SaverScope.html)

## Functions

| Name | Summary |
|---|---|
| [canBeSaved](can-be-saved.md) | [common, js]<br>[common]<br>expect abstract fun [canBeSaved](can-be-saved.md)(value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)<br>[js]<br>actual abstract fun [canBeSaved](can-be-saved.md)(value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) |
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
//[parcelable-compose](../../index.md)/[com.chrynan.parcelable.compose](index.md)/[Saver](-saver.md)

# Saver

[common, js]\
[common]\
expect fun &lt;[Original](-saver.md), [Saveable](-saver.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt; [Saver](-saver.md)(save: [SaverScope](-saver-scope/index.md).(value: [Original](-saver.md)) -&gt; [Saveable](-saver.md)?, restore: (value: [Saveable](-saver.md)) -&gt; [Original](-saver.md)?): [Saver](-saver/index.md)&lt;[Original](-saver.md), [Saveable](-saver.md)&gt;

[js]\
actual fun &lt;[Original](-saver.md), [Saveable](-saver.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt; [Saver](-saver.md)(save: [SaverScope](-saver-scope/index.md).(value: [Original](-saver.md)) -&gt; [Saveable](-saver.md)?, restore: (value: [Saveable](-saver.md)) -&gt; [Original](-saver.md)?): [Saver](-saver/index.md)&lt;[Original](-saver.md), [Saveable](-saver.md)&gt;
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
//[parcelable-compose](../../../index.md)/[com.chrynan.parcelable.compose](../index.md)/[Saver](index.md)

# Saver

[common]\
expect interface [Saver](index.md)&lt;[Original](index.md), [Saveable](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt;

[js]\
actual interface [Saver](index.md)&lt;[Original](index.md), [Saveable](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt;

[android, jvm]\
actual typealias [Saver](index.md) = [Saver](https://developer.android.com/reference/kotlin/androidx/compose/runtime/saveable/Saver.html)&lt;[Original](index.md), [Saveable](index.md)&gt;

## Functions

| Name | Summary |
|---|---|
| [restore](restore.md) | [common, js]<br>[common]<br>expect abstract fun [restore](restore.md)(value: [Saveable](index.md)): [Original](index.md)?<br>[js]<br>actual abstract fun [restore](restore.md)(value: [Saveable](index.md)): [Original](index.md)? |
| [save](save.md) | [common, js]<br>[common]<br>expect abstract fun [SaverScope](../-saver-scope/index.md).[save](save.md)(value: [Original](index.md)): [Saveable](index.md)?<br>[js]<br>actual abstract fun [SaverScope](../-saver-scope/index.md).[save](save.md)(value: [Original](index.md)): [Saveable](index.md)? |
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
//[parcelable-compose](../../../index.md)/[com.chrynan.parcelable.compose](../index.md)/[Saver](index.md)/[restore](restore.md)

# restore

[common, js]\
[common]\
expect abstract fun [restore](restore.md)(value: [Saveable](index.md)): [Original](index.md)?

[js]\
actual abstract fun [restore](restore.md)(value: [Saveable](index.md)): [Original](index.md)?
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
//[parcelable-compose](../../../index.md)/[com.chrynan.parcelable.compose](../index.md)/[Saver](index.md)/[save](save.md)

# save

[common, js]\
[common]\
expect abstract fun [SaverScope](../-saver-scope/index.md).[save](save.md)(value: [Original](index.md)): [Saveable](index.md)?

[js]\
actual abstract fun [SaverScope](../-saver-scope/index.md).[save](save.md)(value: [Original](index.md)): [Saveable](index.md)?
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
//[parcelable-compose](../../index.md)/[com.chrynan.parcelable.compose](index.md)/[autoSaver](auto-saver.md)

# autoSaver

[common, android, js, jvm]\
[common]\
expect fun &lt;[T](auto-saver.md)&gt; [autoSaver](auto-saver.md)(): [Saver](-saver/index.md)&lt;[T](auto-saver.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt;

[android, js, jvm]\
actual fun &lt;[T](auto-saver.md)&gt; [autoSaver](auto-saver.md)(): [Saver](-saver/index.md)&lt;[T](auto-saver.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt;
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
//[parcelable-compose](../../index.md)/[com.chrynan.parcelable.compose](index.md)

# Package com.chrynan.parcelable.compose
# Package-level declarations

## Types

| Name | Summary |
|---|---|
| [Saver](-saver/index.md) | [common, js, android, jvm]<br>[common]<br>expect interface [Saver](-saver/index.md)&lt;[Original](-saver/index.md), [Saveable](-saver/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt;<br>[js]<br>actual interface [Saver](-saver/index.md)&lt;[Original](-saver/index.md), [Saveable](-saver/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt;<br>[android, jvm]<br>actual typealias [Saver](-saver/index.md) = [Saver](https://developer.android.com/reference/kotlin/androidx/compose/runtime/saveable/Saver.html)&lt;[Original](-saver/index.md), [Saveable](-saver/index.md)&gt; |
| [SaverScope](-saver-scope/index.md) | [common, js, android, jvm]<br>[common]<br>expect fun interface [SaverScope](-saver-scope/index.md)<br>[js]<br>actual fun interface [SaverScope](-saver-scope/index.md)<br>[android, jvm]<br>actual typealias [SaverScope](-saver-scope/index.md) = [SaverScope](https://developer.android.com/reference/kotlin/androidx/compose/runtime/saveable/SaverScope.html) |

## Functions

| Name | Summary |
|---|---|
| [ParcelableSaver](-parcelable-saver.md) | [common]<br>fun &lt;[T](-parcelable-saver.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt; [ParcelableSaver](-parcelable-saver.md)(parcelable: [Parcelable](../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcelable/index.md) = Parcelable.Default, serializer: KSerializer&lt;[T](-parcelable-saver.md)&gt;): Saver&lt;[T](-parcelable-saver.md), *&gt;<br>Creates a Saver that uses the provided [parcelable](-parcelable-saver.md) and [serializer](-parcelable-saver.md) to save and restore the value. |
| [rememberSavable](remember-savable.md) | [common]<br>@Composable<br>fun &lt;[T](remember-savable.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt; [rememberSavable](remember-savable.md)(vararg inputs: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?, parcelable: [Parcelable](../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcelable/index.md) = Parcelable.Default, serializer: KSerializer&lt;[T](remember-savable.md)&gt;, key: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, init: () -&gt; [T](remember-savable.md)): [T](remember-savable.md)<br>Calls rememberSaveable using a [ParcelableSaver](-parcelable-saver.md) created using the provided [parcelable](remember-savable.md) and [serializer](remember-savable.md). |
| [autoSaver](auto-saver.md) | [common, android, js, jvm]<br>[common]<br>expect fun &lt;[T](auto-saver.md)&gt; [autoSaver](auto-saver.md)(): [Saver](-saver/index.md)&lt;[T](auto-saver.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt;<br>[android, js, jvm]<br>actual fun &lt;[T](auto-saver.md)&gt; [autoSaver](auto-saver.md)(): [Saver](-saver/index.md)&lt;[T](auto-saver.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt; |
| [listSaver](list-saver.md) | [common, js]<br>[common]<br>expect fun &lt;[Original](list-saver.md), [Saveable](list-saver.md)&gt; [listSaver](list-saver.md)(save: [SaverScope](-saver-scope/index.md).(value: [Original](list-saver.md)) -&gt; [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)&lt;[Saveable](list-saver.md)&gt;, restore: (list: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)&lt;[Saveable](list-saver.md)&gt;) -&gt; [Original](list-saver.md)?): [Saver](-saver/index.md)&lt;[Original](list-saver.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt;<br>[js]<br>actual fun &lt;[Original](list-saver.md), [Saveable](list-saver.md)&gt; [listSaver](list-saver.md)(save: [SaverScope](-saver-scope/index.md).(value: [Original](list-saver.md)) -&gt; [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)&lt;[Saveable](list-saver.md)&gt;, restore: (list: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)&lt;[Saveable](list-saver.md)&gt;) -&gt; [Original](list-saver.md)?): [Saver](-saver/index.md)&lt;[Original](list-saver.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt; |
| [mapSaver](map-saver.md) | [common, js]<br>[common]<br>expect fun &lt;[T](map-saver.md)&gt; [mapSaver](map-saver.md)(save: [SaverScope](-saver-scope/index.md).(value: [T](map-saver.md)) -&gt; [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)&lt;[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?&gt;, restore: ([Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)&lt;[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?&gt;) -&gt; [T](map-saver.md)?): [Saver](-saver/index.md)&lt;[T](map-saver.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt;<br>[js]<br>actual fun &lt;[T](map-saver.md)&gt; [mapSaver](map-saver.md)(save: [SaverScope](-saver-scope/index.md).(value: [T](map-saver.md)) -&gt; [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)&lt;[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?&gt;, restore: ([Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)&lt;[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?&gt;) -&gt; [T](map-saver.md)?): [Saver](-saver/index.md)&lt;[T](map-saver.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt; |
| [ParcelableSaver](-parcelable-saver.md) | [common]<br>@ExperimentalSerializationApi<br>fun &lt;[T](-parcelable-saver.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt; [ParcelableSaver](-parcelable-saver.md)(parcelable: [Parcelable](../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcelable/index.md) = Parcelable.Default, serializer: KSerializer&lt;[T](-parcelable-saver.md)&gt;): [Saver](-saver/index.md)&lt;[T](-parcelable-saver.md), *&gt;<br>Creates a [Saver](-saver/index.md) that uses the provided [parcelable](-parcelable-saver.md) and [serializer](-parcelable-saver.md) to save and restore the value. |
| [rememberSavable](remember-savable.md) | [common]<br>@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)<br>@ExperimentalSerializationApi<br>fun &lt;[T](remember-savable.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt; [rememberSavable](remember-savable.md)(vararg inputs: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?, parcelable: [Parcelable](../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcelable/index.md) = Parcelable.Default, serializer: KSerializer&lt;[T](remember-savable.md)&gt;, key: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, init: () -&gt; [T](remember-savable.md)): [T](remember-savable.md)<br>Calls [rememberSaveable](remember-saveable.md) using a [ParcelableSaver](-parcelable-saver.md) created using the provided [parcelable](remember-savable.md) and [serializer](remember-savable.md). |
| [rememberSaveable](remember-saveable.md) | [common]<br>@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)<br>fun &lt;[T](remember-saveable.md)&gt; [rememberSaveable](remember-saveable.md)(vararg inputs: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?, stateSaver: [Saver](-saver/index.md)&lt;[T](remember-saveable.md), out [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt;, key: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, init: () -&gt; [MutableState](https://developer.android.com/reference/kotlin/androidx/compose/runtime/MutableState.html)&lt;[T](remember-saveable.md)&gt;): [MutableState](https://developer.android.com/reference/kotlin/androidx/compose/runtime/MutableState.html)&lt;[T](remember-saveable.md)&gt;<br>@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)<br>fun &lt;[T](remember-saveable.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt; [rememberSaveable](remember-saveable.md)(vararg inputs: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?, saver: [Saver](-saver/index.md)&lt;[T](remember-saveable.md), out [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt; = autoSaver(), key: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, init: () -&gt; [T](remember-saveable.md)): [T](remember-saveable.md)<br>[common]<br>@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)<br>@ExperimentalSerializationApi<br>fun &lt;[T](remember-saveable.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt; [rememberSaveable](remember-saveable.md)(vararg inputs: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?, parcelable: [Parcelable](../../../parcelable-core/parcelable-core/com.chrynan.parcelable.core/-parcelable/index.md) = Parcelable.Default, serializer: KSerializer&lt;[T](remember-saveable.md)&gt;, key: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, init: () -&gt; [MutableState](https://developer.android.com/reference/kotlin/androidx/compose/runtime/MutableState.html)&lt;[T](remember-saveable.md)&gt;): [MutableState](https://developer.android.com/reference/kotlin/androidx/compose/runtime/MutableState.html)&lt;[T](remember-saveable.md)&gt;<br>Calls [rememberSaveable](remember-saveable.md) using a [ParcelableSaver](-parcelable-saver.md) created using the provided [parcelable](remember-saveable.md) and [serializer](remember-saveable.md). |
| [Saver](-saver.md) | [common, js]<br>[common]<br>expect fun &lt;[Original](-saver.md), [Saveable](-saver.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt; [Saver](-saver.md)(save: [SaverScope](-saver-scope/index.md).(value: [Original](-saver.md)) -&gt; [Saveable](-saver.md)?, restore: (value: [Saveable](-saver.md)) -&gt; [Original](-saver.md)?): [Saver](-saver/index.md)&lt;[Original](-saver.md), [Saveable](-saver.md)&gt;<br>[js]<br>actual fun &lt;[Original](-saver.md), [Saveable](-saver.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt; [Saver](-saver.md)(save: [SaverScope](-saver-scope/index.md).(value: [Original](-saver.md)) -&gt; [Saveable](-saver.md)?, restore: (value: [Saveable](-saver.md)) -&gt; [Original](-saver.md)?): [Saver](-saver/index.md)&lt;[Original](-saver.md), [Saveable](-saver.md)&gt; |
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
//[parcelable-compose](../../index.md)/[com.chrynan.parcelable.compose](index.md)/[listSaver](list-saver.md)

# listSaver

[common, js]\
[common]\
expect fun &lt;[Original](list-saver.md), [Saveable](list-saver.md)&gt; [listSaver](list-saver.md)(save: [SaverScope](-saver-scope/index.md).(value: [Original](list-saver.md)) -&gt; [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)&lt;[Saveable](list-saver.md)&gt;, restore: (list: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)&lt;[Saveable](list-saver.md)&gt;) -&gt; [Original](list-saver.md)?): [Saver](-saver/index.md)&lt;[Original](list-saver.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt;

[js]\
actual fun &lt;[Original](list-saver.md), [Saveable](list-saver.md)&gt; [listSaver](list-saver.md)(save: [SaverScope](-saver-scope/index.md).(value: [Original](list-saver.md)) -&gt; [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)&lt;[Saveable](list-saver.md)&gt;, restore: (list: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)&lt;[Saveable](list-saver.md)&gt;) -&gt; [Original](list-saver.md)?): [Saver](-saver/index.md)&lt;[Original](list-saver.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)&gt;
Loading

0 comments on commit e2de09f

Please sign in to comment.