SceneSetupNavEntryDecoratorKt

Added in 1.0.0-alpha02

public final class SceneSetupNavEntryDecoratorKt


Summary

Public methods

static final @NonNull NavEntryDecorator<@NonNull Object>

A NavEntryDecorator that wraps each entry in a movableContentOf to allow nav displays to arbitrarily place entries in different places in the composable call hierarchy and ensures that the same entry content is not composed multiple times in different places of the hierarchy.

static final @NonNull ProvidableCompositionLocal<@NonNull Set<@NonNull Object>>

The entry keys to render in the current Scene, in the sense of the target of the animation for an AnimatedContent that is transitioning between different scenes.

static final @NonNull NavEntryDecorator<@NonNull Object>

Returns a SceneSetupNavEntryDecorator that is remembered across recompositions.

Public methods

SceneSetupNavEntryDecorator

public static final @NonNull NavEntryDecorator<@NonNull ObjectSceneSetupNavEntryDecorator()

A NavEntryDecorator that wraps each entry in a movableContentOf to allow nav displays to arbitrarily place entries in different places in the composable call hierarchy and ensures that the same entry content is not composed multiple times in different places of the hierarchy.

This should likely be the first NavEntryDecorator to ensure that other NavEntryDecorator calls that are stateful are moved properly inside the movableContentOf.

getLocalEntriesToRenderInCurrentScene

public static final @NonNull ProvidableCompositionLocal<@NonNull Set<@NonNull Object>> getLocalEntriesToRenderInCurrentScene()

The entry keys to render in the current Scene, in the sense of the target of the animation for an AnimatedContent that is transitioning between different scenes.

rememberSceneSetupNavEntryDecorator

@Composable
public static final @NonNull NavEntryDecorator<@NonNull ObjectrememberSceneSetupNavEntryDecorator()

Returns a SceneSetupNavEntryDecorator that is remembered across recompositions.