Skip to content

Commit

Permalink
Generated updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris committed Nov 25, 2022
1 parent 21167bc commit ffff805
Show file tree
Hide file tree
Showing 73 changed files with 722 additions and 513 deletions.
59 changes: 40 additions & 19 deletions docs/package-list

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@

[common]\

@Composable
@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)

@Stable
@[Stable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Stable.html)

fun <[I](-compose-layout.md) : [Intent](../../../presentation-core/presentation-core/com.chrynan.presentation/-intent/index.md), [S](-compose-layout.md) : [State](../../../presentation-core/presentation-core/com.chrynan.presentation/-state/index.md), [C](-compose-layout.md) : [Change](../../../presentation-core/presentation-core/com.chrynan.presentation/-change/index.md)> [ComposeLayout](-compose-layout.md)(layout: [Layout](-layout/index.md)<[I](-compose-layout.md), [S](-compose-layout.md), [C](-compose-layout.md)>)

Renders the provided [layout](-compose-layout.md) as a Composable.
Renders the provided [layout](-compose-layout.md) as a [Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html).

Example usage:

@Composable\
fun Home {\
ComposeLayout(homeLayout)\
```kotlin
@Composable
fun Home {
ComposeLayout(homeLayout)
}
```
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@

[common]\

@Composable
@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)

abstract fun [Content](-content.md)()

Renders the UI content for this Layout.

Example usage:

@Composable\
override fun Content() {\
val state by stateChanges()\
\
Text("State = $state")\
```kotlin
@Composable
override fun Content() {
val state by stateChanges()

Text("State = $state")
}
```
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,29 @@
# Layout

[common]\
@Stable
@[Stable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Stable.html)

abstract class [Layout](index.md)<[I](index.md) : [Intent](../../../../presentation-core/presentation-core/com.chrynan.presentation/-intent/index.md), [S](index.md) : [State](../../../../presentation-core/presentation-core/com.chrynan.presentation/-state/index.md), [C](index.md) : [Change](../../../../presentation-core/presentation-core/com.chrynan.presentation/-change/index.md)> : [View](../../../../presentation-core/presentation-core/com.chrynan.presentation/-view/index.md)<[I](index.md), [S](index.md), [C](index.md)> , [Bindable](../../../../presentation-core/presentation-core/com.chrynan.presentation/-bindable/index.md)

A component that implements the [View](../../../../presentation-core/presentation-core/com.chrynan.presentation/-view/index.md) interface and serves as the binding between this presentation library and Jetpack Compose. Typically, [Layout](index.md)s are used to represent the "Screen" components in an application.
A component that implements the [View](../../../../presentation-core/presentation-core/com.chrynan.presentation/-view/index.md) interface and serves as the binding between this presentation library and Jetpack Compose. Typically, [Layout](index.md)s are used to represent the "Screen" components in an application.

Example usage:

class HomeLayout : Layout<HomeIntent, HomeState, HomeChange>() {\
\
override val viewModel = ViewModel<I, S, C>(\
perform = { intent, state -> ... },\
reduce = { state, change -> ... })\
\
@Composable\
override fun Content() {\
val state by stateChanges()\
\
// Put Composable UI code here using the [state] value\
}\
```kotlin
class HomeLayout : Layout<HomeIntent, HomeState, HomeChange>() {

override val viewModel = ViewModel<I, S, C>(
perform = { intent, state -> ... },
reduce = { state, change -> ... })

@Composable
override fun Content() {
val state by stateChanges()

// Put Composable UI code here using the [state] value
}
}
```

## Constructors

Expand All @@ -36,7 +38,7 @@ class HomeLayout : Layout&lt;HomeIntent, HomeState, HomeChange&gt;() {\
| Name | Summary |
|---|---|
| [bind](bind.md) | [common]<br>override fun [bind](bind.md)() |
| [Content](-content.md) | [common]<br>@Composable<br>abstract fun [Content](-content.md)()<br>Renders the UI content for this Layout. |
| [Content](-content.md) | [common]<br>@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)<br>abstract fun [Content](-content.md)()<br>Renders the UI content for this Layout. |
| [equals](equals.md) | [common]<br>open operator override fun [equals](equals.md)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) |
| [hashCode](hash-code.md) | [common]<br>open override fun [hashCode](hash-code.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) |
| [toString](to-string.md) | [common]<br>open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
Expand All @@ -46,13 +48,14 @@ class HomeLayout : Layout&lt;HomeIntent, HomeState, HomeChange&gt;() {\

| Name | Summary |
|---|---|
| [isBound](is-bound.md) | [common]<br>open override val [isBound](is-bound.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) |
| [isBound](is-bound.md) | [common]<br>override val [isBound](is-bound.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) |
| [key](key.md) | [common]<br>open val [key](key.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)? |
| [renderState](render-state.md) | [common]<br>open override val [renderState](render-state.md): [S](index.md)? |
| [renderState](render-state.md) | [common]<br>override val [renderState](render-state.md): [S](index.md)? |
| [viewModel](view-model.md) | [common]<br>abstract override val [viewModel](view-model.md): [ViewModel](../../../../presentation-core/presentation-core/com.chrynan.presentation/-view-model/index.md)&lt;[I](index.md), [S](index.md), [C](index.md)&gt; |

## Extensions

| Name | Summary |
|---|---|
| [unaryPlus](../unary-plus.md) | [common]<br>@Composable<br>inline operator fun &lt;[I](../unary-plus.md) : [Intent](../../../../presentation-core/presentation-core/com.chrynan.presentation/-intent/index.md), [S](../unary-plus.md) : [State](../../../../presentation-core/presentation-core/com.chrynan.presentation/-state/index.md), [C](../unary-plus.md) : [Change](../../../../presentation-core/presentation-core/com.chrynan.presentation/-change/index.md)&gt; [Layout](index.md)&lt;[I](../unary-plus.md), [S](../unary-plus.md), [C](../unary-plus.md)&gt;.[unaryPlus](../unary-plus.md)()<br>Lays out the provided [layout](../layout.md) as a Composable. |
| [stateChanges](../../com.chrynan.presentation.compose/state-changes.md) | [common]<br>@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)<br>fun &lt;[I](../../com.chrynan.presentation.compose/state-changes.md) : [Intent](../../../../presentation-core/presentation-core/com.chrynan.presentation/-intent/index.md), [S](../../com.chrynan.presentation.compose/state-changes.md) : [State](../../../../presentation-core/presentation-core/com.chrynan.presentation/-state/index.md), [C](../../com.chrynan.presentation.compose/state-changes.md) : [Change](../../../../presentation-core/presentation-core/com.chrynan.presentation/-change/index.md)&gt; [View](../../../../presentation-core/presentation-core/com.chrynan.presentation/-view/index.md)&lt;[I](../../com.chrynan.presentation.compose/state-changes.md), [S](../../com.chrynan.presentation.compose/state-changes.md), [C](../../com.chrynan.presentation.compose/state-changes.md)&gt;.[stateChanges](../../com.chrynan.presentation.compose/state-changes.md)(context: [CoroutineContext](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html) = EmptyCoroutineContext): [State](https://developer.android.com/reference/kotlin/androidx/compose/runtime/State.html)&lt;[S](../../com.chrynan.presentation.compose/state-changes.md)?&gt;<br>Obtains the changes to the underlying [State](../../../../presentation-core/presentation-core/com.chrynan.presentation/-state/index.md) as a Jetpack Compose [androidx.compose.runtime.State](https://developer.android.com/reference/kotlin/androidx/compose/runtime/State.html) value, so that the changes can cause the [Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html) function to be re-composed.<br>[common]<br>@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)<br>fun &lt;[I](../../com.chrynan.presentation.compose/state-changes.md) : [Intent](../../../../presentation-core/presentation-core/com.chrynan.presentation/-intent/index.md), [S](../../com.chrynan.presentation.compose/state-changes.md) : [State](../../../../presentation-core/presentation-core/com.chrynan.presentation/-state/index.md), [C](../../com.chrynan.presentation.compose/state-changes.md) : [Change](../../../../presentation-core/presentation-core/com.chrynan.presentation/-change/index.md)&gt; [View](../../../../presentation-core/presentation-core/com.chrynan.presentation/-view/index.md)&lt;[I](../../com.chrynan.presentation.compose/state-changes.md), [S](../../com.chrynan.presentation.compose/state-changes.md), [C](../../com.chrynan.presentation.compose/state-changes.md)&gt;.[stateChanges](../../com.chrynan.presentation.compose/state-changes.md)(initial: [S](../../com.chrynan.presentation.compose/state-changes.md)?, context: [CoroutineContext](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html) = EmptyCoroutineContext): [State](https://developer.android.com/reference/kotlin/androidx/compose/runtime/State.html)&lt;[S](../../com.chrynan.presentation.compose/state-changes.md)?&gt;<br>Obtains the changes to the underlying [State](../../../../presentation-core/presentation-core/com.chrynan.presentation/-state/index.md), starting with the provided [initial](../../com.chrynan.presentation.compose/state-changes.md) value, as a Jetpack Compose [androidx.compose.runtime.State](https://developer.android.com/reference/kotlin/androidx/compose/runtime/State.html) value, so that the changes can cause the [Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html) function to be re-composed. |
| [unaryPlus](../unary-plus.md) | [common]<br>@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)<br>inline operator fun &lt;[I](../unary-plus.md) : [Intent](../../../../presentation-core/presentation-core/com.chrynan.presentation/-intent/index.md), [S](../unary-plus.md) : [State](../../../../presentation-core/presentation-core/com.chrynan.presentation/-state/index.md), [C](../unary-plus.md) : [Change](../../../../presentation-core/presentation-core/com.chrynan.presentation/-change/index.md)&gt; [Layout](index.md)&lt;[I](../unary-plus.md), [S](../unary-plus.md), [C](../unary-plus.md)&gt;.[unaryPlus](../unary-plus.md)()<br>Lays out the provided [layout](../layout.md) as a [Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html). |
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
# isBound

[common]\
open override val [isBound](is-bound.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
override val [isBound](is-bound.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
# renderState

[common]\
open override val [renderState](render-state.md): [S](index.md)?
override val [renderState](render-state.md): [S](index.md)?
Loading

0 comments on commit ffff805

Please sign in to comment.