devview/com.worldline.devview.core

Package-level declarations

Types

data class DestinationMetadata(val title: String? = null, val actions: PersistentList<ModuleDestinationAction> = persistentListOf())

Metadata associated with a single navigation destination within a Module.

DestinationMetadataBuilder

class DestinationMetadataBuilder

DSL builder for constructing the actions list of a DestinationMetadata.

Module

interface Module

Base interface for all DevView modules.

ModuleDestinationAction

data class ModuleDestinationAction(val icon: ImageVector, val action: () -> Unit, val popup: ModuleDestinationActionPopup? = null)

ModuleDestinationActionPopup

data class ModuleDestinationActionPopup(val title: String, val subtitle: String? = null, val confirmButton: String, val dismissButton: String)

ModuleRegistry

class ModuleRegistry

Builder for configuring DevView modules using a clean DSL.

Poko

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Poko

Annotation for marking data classes that should be processed by the Poko compiler plugin.

Section

enum Section : Enum<Section>

Defines the organizational sections for grouping DevView modules.

Properties

icon

val Section.icon: ImageVector

Extension property providing the default icon for each section.

Functions

asDestination

fun NavKey.asDestination(): Pair<KClass<out NavKey>, DestinationMetadata>

Registers this NavKey as a destination with no title override and no actions.

fun KClass<out NavKey>.asDestination(): Pair<KClass<out NavKey>, DestinationMetadata>

Registers this KClass as a destination with no title override and no actions.

buildModules

fun buildModules(block: ModuleRegistry.() -> Unit): ImmutableList<Module>

DSL function for creating a module configuration.

rememberModules

@Composable

fun rememberModules(block: ModuleRegistry.() -> Unit): ImmutableList<Module>

Composable version of buildModules that remembers the module list.

withActions

fun NavKey.withActions(block: DestinationMetadataBuilder.() -> Unit): Pair<KClass<out NavKey>, DestinationMetadata>

Registers this NavKey as a destination with no title override and contextual actions defined via a DestinationMetadataBuilder DSL block.

fun KClass<out NavKey>.withActions(block: DestinationMetadataBuilder.() -> Unit): Pair<KClass<out NavKey>, DestinationMetadata>

Registers this KClass as a destination with no title override and contextual actions defined via a DestinationMetadataBuilder DSL block.

withTitle

fun NavKey.withTitle(title: String): Pair<KClass<out NavKey>, DestinationMetadata>

Registers this NavKey as a destination with a static title and no actions.

fun KClass<out NavKey>.withTitle(title: String): Pair<KClass<out NavKey>, DestinationMetadata>

Registers this KClass as a destination with a static title and no actions.

fun NavKey.withTitle(title: String, block: DestinationMetadataBuilder.() -> Unit): Pair<KClass<out NavKey>, DestinationMetadata>

Registers this NavKey as a destination with a static title and contextual actions defined via a DestinationMetadataBuilder DSL block.

fun KClass<out NavKey>.withTitle(title: String, block: DestinationMetadataBuilder.() -> Unit): Pair<KClass<out NavKey>, DestinationMetadata>

Registers this KClass as a destination with a static title and contextual actions defined via a DestinationMetadataBuilder DSL block.