Skip to content

Commit

Permalink
Generated updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chRyNaN committed Feb 27, 2023
1 parent b40c260 commit 83b86e7
Show file tree
Hide file tree
Showing 87 changed files with 1,118 additions and 315 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[ComposeNavigationContextState](../index.md)/[Companion](index.md)

# Companion

[common]\
object [Companion](index.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigationContextState](index.md)

# ComposeNavigationContextState

[common]\
@[ExperimentalNavigationApi](../../../../navigation-core/navigation-core/com.chrynan.navigation/-experimental-navigation-api/index.md)

interface [ComposeNavigationContextState](index.md)<[Destination](index.md) : [NavigationDestination](../../../../navigation-core/com.chrynan.navigation/-navigation-destination/index.md), [Context](index.md) : [NavigationContext](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-context/index.md)<[Destination](index.md)>> : [NavigationContextState](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-context-state/index.md)<[Destination](index.md), [Context](index.md)>

## Types

| Name | Summary |
|---|---|
| [Companion](-companion/index.md) | [common]<br>object [Companion](-companion/index.md) |

## Properties

| Name | Summary |
|---|---|
| [contextChanges](../-compose-navigator-state/index.md#-1880294209%2FProperties%2F-1093353005) | [common]<br>abstract val [contextChanges](../-compose-navigator-state/index.md#-1880294209%2FProperties%2F-1093353005): Flow&lt;[Context](index.md)&gt; |
| [currentContext](../-compose-navigator-state/index.md#-822285539%2FProperties%2F-1093353005) | [common]<br>abstract val [currentContext](../-compose-navigator-state/index.md#-822285539%2FProperties%2F-1093353005): [Context](index.md) |
| [initialContext](../-compose-navigator-state/index.md#-1520396056%2FProperties%2F-1093353005) | [common]<br>abstract val [initialContext](../-compose-navigator-state/index.md#-1520396056%2FProperties%2F-1093353005): [Context](index.md) |

## Inheritors

| Name |
|---|
| [ComposeNavigatorState](../-compose-navigator-state/index.md) |

## Extensions

| Name | Summary |
|---|---|
| [currentContextAsState](../current-context-as-state.md) | [common]<br>@[ExperimentalNavigationApi](../../../../navigation-core/navigation-core/com.chrynan.navigation/-experimental-navigation-api/index.md)<br>@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)<br>fun &lt;[Destination](../current-context-as-state.md) : [NavigationDestination](../../../../navigation-core/com.chrynan.navigation/-navigation-destination/index.md), [Context](../current-context-as-state.md) : [NavigationContext](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-context/index.md)&lt;[Destination](../current-context-as-state.md)&gt;&gt; [NavigationContextState](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-context-state/index.md)&lt;[Destination](../current-context-as-state.md), [Context](../current-context-as-state.md)&gt;.[currentContextAsState](../current-context-as-state.md)(initialCurrentContext: [Context](../current-context-as-state.md)): [State](https://developer.android.com/reference/kotlin/androidx/compose/runtime/State.html)&lt;[Context](../current-context-as-state.md)&gt;<br>@[ExperimentalNavigationApi](../../../../navigation-core/navigation-core/com.chrynan.navigation/-experimental-navigation-api/index.md)<br>@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)<br>fun &lt;[Destination](../current-context-as-state.md) : [NavigationDestination](../../../../navigation-core/com.chrynan.navigation/-navigation-destination/index.md), [Context](../current-context-as-state.md) : [NavigationContext](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-context/index.md)&lt;[Destination](../current-context-as-state.md)&gt;&gt; [NavigationContextState](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-context-state/index.md)&lt;[Destination](../current-context-as-state.md), [Context](../current-context-as-state.md)&gt;.[currentContextAsState](../current-context-as-state.md)(): [State](https://developer.android.com/reference/kotlin/androidx/compose/runtime/State.html)&lt;[Context](../current-context-as-state.md)&gt;<br>Obtains the changes to the [ComposeNavigationContextState.currentContext](../../../../navigation-compose/com.chrynan.navigation.compose/-compose-navigation-context-state/current-context.md) value and returns it as a [State](https://developer.android.com/reference/kotlin/androidx/compose/runtime/State.html). This allows it to be used in a [Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html) and cause recomposition when the value changes. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[ComposeNavigationDestinationState](../index.md)/[Companion](index.md)

# Companion

[common]\
object [Companion](index.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigationDestinationState](index.md)

# ComposeNavigationDestinationState

[common]\
@[ExperimentalNavigationApi](../../../../navigation-core/navigation-core/com.chrynan.navigation/-experimental-navigation-api/index.md)

interface [ComposeNavigationDestinationState](index.md)&lt;[Destination](index.md) : [NavigationDestination](../../../../navigation-core/com.chrynan.navigation/-navigation-destination/index.md)&gt; : [NavigationDestinationState](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-destination-state/index.md)&lt;[Destination](index.md)&gt;

## Types

| Name | Summary |
|---|---|
| [Companion](-companion/index.md) | [common]<br>object [Companion](-companion/index.md) |

## Properties

| Name | Summary |
|---|---|
| [currentDestination](../-compose-navigator-state/index.md#1047421983%2FProperties%2F-1093353005) | [common]<br>abstract val [currentDestination](../-compose-navigator-state/index.md#1047421983%2FProperties%2F-1093353005): [Destination](index.md) |
| [destinationChanges](../-compose-navigator-state/index.md#1416376863%2FProperties%2F-1093353005) | [common]<br>abstract val [destinationChanges](../-compose-navigator-state/index.md#1416376863%2FProperties%2F-1093353005): Flow&lt;[Destination](index.md)&gt; |
| [initialDestination](../-compose-navigator-state/index.md#-1134545814%2FProperties%2F-1093353005) | [common]<br>abstract val [initialDestination](../-compose-navigator-state/index.md#-1134545814%2FProperties%2F-1093353005): [Destination](index.md) |

## Inheritors

| Name |
|---|
| [ComposeNavigatorState](../-compose-navigator-state/index.md) |

## Extensions

| Name | Summary |
|---|---|
| [currentDestinationAsState](../current-destination-as-state.md) | [common]<br>@[ExperimentalNavigationApi](../../../../navigation-core/navigation-core/com.chrynan.navigation/-experimental-navigation-api/index.md)<br>@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)<br>fun &lt;[Destination](../current-destination-as-state.md) : [NavigationDestination](../../../../navigation-core/com.chrynan.navigation/-navigation-destination/index.md)&gt; [NavigationDestinationState](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-destination-state/index.md)&lt;[Destination](../current-destination-as-state.md)&gt;.[currentDestinationAsState](../current-destination-as-state.md)(initialCurrentKey: [Destination](../current-destination-as-state.md)): [State](https://developer.android.com/reference/kotlin/androidx/compose/runtime/State.html)&lt;[Destination](../current-destination-as-state.md)&gt;<br>@[ExperimentalNavigationApi](../../../../navigation-core/navigation-core/com.chrynan.navigation/-experimental-navigation-api/index.md)<br>@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)<br>fun &lt;[Destination](../current-destination-as-state.md) : [NavigationDestination](../../../../navigation-core/com.chrynan.navigation/-navigation-destination/index.md)&gt; [NavigationDestinationState](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-destination-state/index.md)&lt;[Destination](../current-destination-as-state.md)&gt;.[currentDestinationAsState](../current-destination-as-state.md)(): [State](https://developer.android.com/reference/kotlin/androidx/compose/runtime/State.html)&lt;[Destination](../current-destination-as-state.md)&gt;<br>Obtains the changes to the [ComposeNavigationDestinationState.currentDestination](../../../../navigation-compose/com.chrynan.navigation.compose/-compose-navigation-destination-state/current-destination.md) value and returns it as a [State](https://developer.android.com/reference/kotlin/androidx/compose/runtime/State.html). This allows it to be used in a [Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html) and cause recomposition when the value changes. |
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,3 @@ interface [ComposeNavigationScope](index.md) : [NavigationScope](../../../../nav
| Name |
|---|
| [Companion](-companion/index.md) |
| [ComposeNavigationKeyScope](../-compose-navigation-key-scope/index.md) |
| [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md) |
| [ComposeNavigationContentScope](../-compose-navigation-content-scope/index.md) |
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[ComposeNavigatorState](../index.md)/[Companion](index.md)

# Companion

[common]\
object [Companion](index.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorState](index.md)

# ComposeNavigatorState

[common]\
@[ExperimentalNavigationApi](../../../../navigation-core/navigation-core/com.chrynan.navigation/-experimental-navigation-api/index.md)

interface [ComposeNavigatorState](index.md)&lt;[Destination](index.md) : [NavigationDestination](../../../../navigation-core/com.chrynan.navigation/-navigation-destination/index.md), [Context](index.md) : [NavigationContext](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-context/index.md)&lt;[Destination](index.md)&gt;&gt; : [ComposeNavigationDestinationState](../-compose-navigation-destination-state/index.md)&lt;[Destination](index.md)&gt; , [ComposeNavigationContextState](../-compose-navigation-context-state/index.md)&lt;[Destination](index.md), [Context](index.md)&gt;

## Types

| Name | Summary |
|---|---|
| [Companion](-companion/index.md) | [common]<br>object [Companion](-companion/index.md) |

## Properties

| Name | Summary |
|---|---|
| [contextChanges](index.md#-1880294209%2FProperties%2F-1093353005) | [common]<br>abstract val [contextChanges](index.md#-1880294209%2FProperties%2F-1093353005): Flow&lt;[Context](index.md)&gt; |
| [currentContext](index.md#-822285539%2FProperties%2F-1093353005) | [common]<br>abstract val [currentContext](index.md#-822285539%2FProperties%2F-1093353005): [Context](index.md) |
| [currentDestination](index.md#1047421983%2FProperties%2F-1093353005) | [common]<br>abstract val [currentDestination](index.md#1047421983%2FProperties%2F-1093353005): [Destination](index.md) |
| [destinationChanges](index.md#1416376863%2FProperties%2F-1093353005) | [common]<br>abstract val [destinationChanges](index.md#1416376863%2FProperties%2F-1093353005): Flow&lt;[Destination](index.md)&gt; |
| [initialContext](index.md#-1520396056%2FProperties%2F-1093353005) | [common]<br>abstract val [initialContext](index.md#-1520396056%2FProperties%2F-1093353005): [Context](index.md) |
| [initialDestination](index.md#-1134545814%2FProperties%2F-1093353005) | [common]<br>abstract val [initialDestination](index.md#-1134545814%2FProperties%2F-1093353005): [Destination](index.md) |

## Extensions

| Name | Summary |
|---|---|
| [currentContextAsState](../current-context-as-state.md) | [common]<br>@[ExperimentalNavigationApi](../../../../navigation-core/navigation-core/com.chrynan.navigation/-experimental-navigation-api/index.md)<br>@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)<br>fun &lt;[Destination](../current-context-as-state.md) : [NavigationDestination](../../../../navigation-core/com.chrynan.navigation/-navigation-destination/index.md), [Context](../current-context-as-state.md) : [NavigationContext](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-context/index.md)&lt;[Destination](../current-context-as-state.md)&gt;&gt; [NavigationContextState](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-context-state/index.md)&lt;[Destination](../current-context-as-state.md), [Context](../current-context-as-state.md)&gt;.[currentContextAsState](../current-context-as-state.md)(initialCurrentContext: [Context](../current-context-as-state.md)): [State](https://developer.android.com/reference/kotlin/androidx/compose/runtime/State.html)&lt;[Context](../current-context-as-state.md)&gt;<br>@[ExperimentalNavigationApi](../../../../navigation-core/navigation-core/com.chrynan.navigation/-experimental-navigation-api/index.md)<br>@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)<br>fun &lt;[Destination](../current-context-as-state.md) : [NavigationDestination](../../../../navigation-core/com.chrynan.navigation/-navigation-destination/index.md), [Context](../current-context-as-state.md) : [NavigationContext](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-context/index.md)&lt;[Destination](../current-context-as-state.md)&gt;&gt; [NavigationContextState](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-context-state/index.md)&lt;[Destination](../current-context-as-state.md), [Context](../current-context-as-state.md)&gt;.[currentContextAsState](../current-context-as-state.md)(): [State](https://developer.android.com/reference/kotlin/androidx/compose/runtime/State.html)&lt;[Context](../current-context-as-state.md)&gt;<br>Obtains the changes to the [ComposeNavigationContextState.currentContext](../../../../navigation-compose/com.chrynan.navigation.compose/-compose-navigation-context-state/current-context.md) value and returns it as a [State](https://developer.android.com/reference/kotlin/androidx/compose/runtime/State.html). This allows it to be used in a [Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html) and cause recomposition when the value changes. |
| [currentDestinationAsState](../current-destination-as-state.md) | [common]<br>@[ExperimentalNavigationApi](../../../../navigation-core/navigation-core/com.chrynan.navigation/-experimental-navigation-api/index.md)<br>@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)<br>fun &lt;[Destination](../current-destination-as-state.md) : [NavigationDestination](../../../../navigation-core/com.chrynan.navigation/-navigation-destination/index.md)&gt; [NavigationDestinationState](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-destination-state/index.md)&lt;[Destination](../current-destination-as-state.md)&gt;.[currentDestinationAsState](../current-destination-as-state.md)(initialCurrentKey: [Destination](../current-destination-as-state.md)): [State](https://developer.android.com/reference/kotlin/androidx/compose/runtime/State.html)&lt;[Destination](../current-destination-as-state.md)&gt;<br>@[ExperimentalNavigationApi](../../../../navigation-core/navigation-core/com.chrynan.navigation/-experimental-navigation-api/index.md)<br>@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)<br>fun &lt;[Destination](../current-destination-as-state.md) : [NavigationDestination](../../../../navigation-core/com.chrynan.navigation/-navigation-destination/index.md)&gt; [NavigationDestinationState](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-destination-state/index.md)&lt;[Destination](../current-destination-as-state.md)&gt;.[currentDestinationAsState](../current-destination-as-state.md)(): [State](https://developer.android.com/reference/kotlin/androidx/compose/runtime/State.html)&lt;[Destination](../current-destination-as-state.md)&gt;<br>Obtains the changes to the [ComposeNavigationDestinationState.currentDestination](../../../../navigation-compose/com.chrynan.navigation.compose/-compose-navigation-destination-state/current-destination.md) value and returns it as a [State](https://developer.android.com/reference/kotlin/androidx/compose/runtime/State.html). This allows it to be used in a [Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html) and cause recomposition when the value changes. |
Loading

0 comments on commit 83b86e7

Please sign in to comment.