DecoratedNavEntryProviderKt

Added in 1.0.0-alpha02

public final class DecoratedNavEntryProviderKt

Summary

Public methods
static final void
@Composable
<T extends Object> DecoratedNavEntryProvider(
    @NonNull List<@NonNull T> backStack,
    @NonNull Function1<@NonNull key, @NonNull NavEntry<@NonNull T>> entryProvider,
    @NonNull List<@NonNull NavEntryDecorator<@NonNull ?>> entryDecorators,
    @Composable @NonNull Function1<@NonNull List<@NonNull NavEntry<@NonNull T>>, Unit> content
)

Function that provides all of the NavEntrys wrapped with the given NavEntryDecorators.

Public methods

DecoratedNavEntryProvider

@Composable
public static final void <T extends Object> DecoratedNavEntryProvider(
    @NonNull List<@NonNull T> backStack,
    @NonNull Function1<@NonNull key, @NonNull NavEntry<@NonNull T>> entryProvider,
    @NonNull List<@NonNull NavEntryDecorator<@NonNull ?>> entryDecorators,
    @Composable @NonNull Function1<@NonNull List<@NonNull NavEntry<@NonNull T>>, Unit> content
)

Function that provides all of the NavEntrys wrapped with the given NavEntryDecorators. It is responsible for executing the functions provided by each NavEntryDecorator appropriately.

Note: the order in which the NavEntryDecorators are added to the list determines their scope, i.e. a NavEntryDecorator added earlier in a list has its data available to those added later.

Parameters
@NonNull List<@NonNull T> backStack

the list of keys that represent the backstack
@NonNull Function1<@NonNull key, @NonNull NavEntry<@NonNull T>> entryProvider

a function that returns the NavEntry for a given key
@NonNull List<@NonNull NavEntryDecorator<@NonNull ?>> entryDecorators

the NavEntryDecorators that are providing data to the content
@Composable @NonNull Function1<@NonNull List<@NonNull NavEntry<@NonNull T>>, Unit> content

the content to be displayed