Skip to content

Commit

Permalink
Generated updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chRyNaN committed May 15, 2022
1 parent 1913ffa commit b70cc57
Show file tree
Hide file tree
Showing 87 changed files with 1,339 additions and 164 deletions.
123 changes: 62 additions & 61 deletions docs/package-list

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@

@Stable

inline 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)>)
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.

Example usage:

@Composable\
fun Home {\
ComposeLayout(homeLayout)\
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,15 @@

@Composable

abstract fun [Content](-content.md)(state: [S](index.md))
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")\
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
# bind

[common]\
open override fun [bind](bind.md)()
override fun [bind](bind.md)()
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,22 @@
[common]\
@Stable

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)> , [Bindable](../../../../presentation-core/presentation-core/com.chrynan.presentation/-bindable/index.md)
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.
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 : BaseLayout<HomeIntent, HomeState, HomeChange>() {\
class HomeLayout : Layout<HomeIntent, HomeState, HomeChange>() {\
\
override val presenter = ...\
override val viewModel = ViewModel<I, S, C>(\
perform = { intent, state -> ... },\
reduce = { state, change -> ... })\
\
@Composable\
override fun Content() {\
val state by stateChanges()\
\
override fun Content(state: HomeState) {\
// Put Composable UI code here using the [state] value\
}\
}
Expand All @@ -30,13 +35,12 @@ class HomeLayout : BaseLayout<HomeIntent, HomeState, HomeChange>() {\

| Name | Summary |
|---|---|
| [bind](bind.md) | [common]<br>open override fun [bind](bind.md)() |
| [Content](-content.md) | [common]<br>@Composable<br>abstract fun [Content](-content.md)(state: [S](index.md)) |
| [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. |
| [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) |
| [intents](intents.md) | [common]<br>open override fun [intents](intents.md)(): Flow&lt;[I](index.md)&gt; |
| [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) |
| [unbind](unbind.md) | [common]<br>open override fun [unbind](unbind.md)() |
| [unbind](unbind.md) | [common]<br>override fun [unbind](unbind.md)() |

## Properties

Expand All @@ -45,7 +49,7 @@ class HomeLayout : BaseLayout&lt;HomeIntent, HomeState, HomeChange&gt;() {\
| [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) |
| [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)? |
| [states](states.md) | [common]<br>open override val [states](states.md): Flow&lt;[S](index.md)&gt; |
| [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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
# unbind

[common]\
open override fun [unbind](unbind.md)()
override fun [unbind](unbind.md)()
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//[presentation-compose](../../../index.md)/[com.chrynan.presentation.compose.layout](../index.md)/[Layout](index.md)/[viewModel](view-model.md)

# viewModel

[common]\
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;
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ Lays out the provided [layout](compose-layout.md) as a Composable.

@Composable

inline fun &lt;[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)&gt; [composeLayout](compose-layout.md)(key: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)? = null, presenterFactory: [PresenterFactory](../../../presentation-core/presentation-core/com.chrynan.presentation/-presenter-factory/index.md)&lt;[I](compose-layout.md), [S](compose-layout.md), [C](compose-layout.md)&gt;, noinline onLayout: @Composable([S](compose-layout.md)) -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
inline fun &lt;[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)&gt; [composeLayout](compose-layout.md)(key: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)? = null, presenterFactory: [PresenterFactory](../../../presentation-core/com.chrynan.presentation/-presenter-factory/index.md)&lt;[I](compose-layout.md), [S](compose-layout.md), [C](compose-layout.md)&gt;, noinline onLayout: @Composable([S](compose-layout.md)) -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))

Creates a [Layout](-layout/index.md) with the provided [key](compose-layout.md), [presenterFactory](compose-layout.md), and [onLayout](compose-layout.md) parameters and then lays out the layout as a Composable.
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@

| Name | Summary |
|---|---|
| [Layout](-layout/index.md) | [common]<br>@Stable<br>abstract class [Layout](-layout/index.md)&lt;[I](-layout/index.md) : [Intent](../../../presentation-core/presentation-core/com.chrynan.presentation/-intent/index.md), [S](-layout/index.md) : [State](../../../presentation-core/presentation-core/com.chrynan.presentation/-state/index.md), [C](-layout/index.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](-layout/index.md), [S](-layout/index.md)&gt; , [Bindable](../../../presentation-core/presentation-core/com.chrynan.presentation/-bindable/index.md)<br>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. |
| [Layout](-layout/index.md) | [common]<br>@Stable<br>abstract class [Layout](-layout/index.md)&lt;[I](-layout/index.md) : [Intent](../../../presentation-core/presentation-core/com.chrynan.presentation/-intent/index.md), [S](-layout/index.md) : [State](../../../presentation-core/presentation-core/com.chrynan.presentation/-state/index.md), [C](-layout/index.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](-layout/index.md), [S](-layout/index.md), [C](-layout/index.md)&gt; , [Bindable](../../../presentation-core/presentation-core/com.chrynan.presentation/-bindable/index.md)<br>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](-layout/index.md)s are used to represent the "Screen" components in an application. |

## Functions

| Name | Summary |
|---|---|
| [ComposeLayout](-compose-layout.md) | [common]<br>@Composable<br>@Stable<br>inline fun &lt;[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)&gt; [ComposeLayout](-compose-layout.md)(layout: [Layout](-layout/index.md)&lt;[I](-compose-layout.md), [S](-compose-layout.md), [C](-compose-layout.md)&gt;)<br>Renders the provided [layout](-compose-layout.md) as a Composable. |
| [layout](layout.md) | [common]<br>inline fun &lt;[I](layout.md) : [Intent](../../../presentation-core/presentation-core/com.chrynan.presentation/-intent/index.md), [S](layout.md) : [State](../../../presentation-core/presentation-core/com.chrynan.presentation/-state/index.md), [C](layout.md) : [Change](../../../presentation-core/presentation-core/com.chrynan.presentation/-change/index.md)&gt; [layout](layout.md)(key: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)? = null, presenterFactory: [PresenterFactory](../../../presentation-core/presentation-core/com.chrynan.presentation/-presenter-factory/index.md)&lt;[I](layout.md), [S](layout.md), [C](layout.md)&gt;, noinline content: @Composable([S](layout.md)) -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [Layout](-layout/index.md)&lt;[I](layout.md), [S](layout.md), [C](layout.md)&gt;<br>Creates a [Layout](-layout/index.md) with the provided [key](layout.md), [presenterFactory](layout.md), and [content](layout.md) parameters.<br>[common]<br>inline fun &lt;[I](layout.md) : [Intent](../../../presentation-core/presentation-core/com.chrynan.presentation/-intent/index.md), [S](layout.md) : [State](../../../presentation-core/presentation-core/com.chrynan.presentation/-state/index.md), [C](layout.md) : [Change](../../../presentation-core/presentation-core/com.chrynan.presentation/-change/index.md)&gt; [layout](layout.md)(key: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)? = null, presenter: [Presenter](../../../presentation-core/presentation-core/com.chrynan.presentation/-presenter/index.md)&lt;[I](layout.md), [S](layout.md), [C](layout.md)&gt;, noinline content: @Composable([S](layout.md)) -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [Layout](-layout/index.md)&lt;[I](layout.md), [S](layout.md), [C](layout.md)&gt;<br>Creates a [Layout](-layout/index.md) with the provided [key](layout.md), [presenterFactory](../../../presentation-core/presentation-core/com.chrynan.presentation/presenter-factory.md), and [content](layout.md) parameters. |
| [ComposeLayout](-compose-layout.md) | [common]<br>@Composable<br>@Stable<br>fun &lt;[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)&gt; [ComposeLayout](-compose-layout.md)(layout: [Layout](-layout/index.md)&lt;[I](-compose-layout.md), [S](-compose-layout.md), [C](-compose-layout.md)&gt;)<br>Renders the provided [layout](-compose-layout.md) as a Composable. |
| [layout](layout.md) | [common]<br>inline fun &lt;[I](layout.md) : [Intent](../../../presentation-core/presentation-core/com.chrynan.presentation/-intent/index.md), [S](layout.md) : [State](../../../presentation-core/presentation-core/com.chrynan.presentation/-state/index.md), [C](layout.md) : [Change](../../../presentation-core/presentation-core/com.chrynan.presentation/-change/index.md)&gt; [layout](layout.md)(key: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)? = null, viewModelFactory: [ViewModelFactory](../../../presentation-core/presentation-core/com.chrynan.presentation/-view-model-factory/index.md)&lt;[I](layout.md), [S](layout.md), [C](layout.md)&gt;, noinline content: @Composable() -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [Layout](-layout/index.md)&lt;[I](layout.md), [S](layout.md), [C](layout.md)&gt;<br>Creates a [Layout](-layout/index.md) with the provided [key](layout.md), [viewModelFactory](layout.md), and [content](layout.md) parameters.<br>[common]<br>inline fun &lt;[I](layout.md) : [Intent](../../../presentation-core/presentation-core/com.chrynan.presentation/-intent/index.md), [S](layout.md) : [State](../../../presentation-core/presentation-core/com.chrynan.presentation/-state/index.md), [C](layout.md) : [Change](../../../presentation-core/presentation-core/com.chrynan.presentation/-change/index.md)&gt; [layout](layout.md)(key: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)? = null, viewModel: [ViewModel](../../../presentation-core/presentation-core/com.chrynan.presentation/-view-model/index.md)&lt;[I](layout.md), [S](layout.md), [C](layout.md)&gt;, noinline content: @Composable() -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [Layout](-layout/index.md)&lt;[I](layout.md), [S](layout.md), [C](layout.md)&gt;<br>Creates a [Layout](-layout/index.md) with the provided [key](layout.md), [viewModel](layout.md), and [content](layout.md) parameters. |
| [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](-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. |
Loading

0 comments on commit b70cc57

Please sign in to comment.