{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

InspectableValueKt

public final class InspectableValueKt


Summary

Public methods

static final @ExtensionFunctionType @NonNull Function1<@NonNull InspectorInfoUnit>

Use this to specify modifier information for compose tooling.

static final @ExtensionFunctionType @NonNull Function1<@NonNull InspectorInfoUnit>

An empty InspectorInfo DSL.

static final @NonNull Modifier
inspectable(
    @NonNull Modifier receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull InspectorInfoUnit> inspectorInfo,
    @ExtensionFunctionType @NonNull Function1<@NonNull Modifier, @NonNull Modifier> factory
)

Use this to group a common set of modifiers and provide InspectorInfo for the resulting modifier.

static final boolean

Turn on inspector debug information.

static final void
setDebugInspectorInfoEnabled(boolean isDebugInspectorInfoEnabled)

Turn on inspector debug information.

Public methods

debugInspectorInfo

public static final @ExtensionFunctionType @NonNull Function1<@NonNull InspectorInfoUnitdebugInspectorInfo(
    @ExtensionFunctionType @NonNull Function1<@NonNull InspectorInfoUnit> definitions
)

Use this to specify modifier information for compose tooling.

This factory method allows the specified information to be stripped out by ProGuard in release builds.

import androidx.compose.foundation.background
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.platform.debugInspectorInfo
import androidx.compose.ui.platform.inspectable
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.dp

/**
 * Sample with a single parameter
 */
fun Modifier.simpleFrame(color: Color) = inspectable(
    inspectorInfo = debugInspectorInfo {
        name = "simpleFrame"
        value = color
    }
) {
    background(color, RoundedCornerShape(5.0.dp))
}

/**
 * Sample with multiple parameters
 */
fun Modifier.fancyFrame(size: Dp, color: Color) = inspectable(
    inspectorInfo = debugInspectorInfo {
        name = "fancyFrame"
        properties["size"] = size
        properties["color"] = color
    }
) {
    background(color, RoundedCornerShape(size))
}

getNoInspectorInfo

public static final @ExtensionFunctionType @NonNull Function1<@NonNull InspectorInfoUnitgetNoInspectorInfo()

An empty InspectorInfo DSL.

inspectable

public static final @NonNull Modifier inspectable(
    @NonNull Modifier receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull InspectorInfoUnit> inspectorInfo,
    @ExtensionFunctionType @NonNull Function1<@NonNull Modifier, @NonNull Modifier> factory
)

Use this to group a common set of modifiers and provide InspectorInfo for the resulting modifier.

import androidx.compose.foundation.background
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.platform.debugInspectorInfo
import androidx.compose.ui.platform.inspectable
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.dp

/**
 * Sample with a single parameter
 */
fun Modifier.simpleFrame(color: Color) = inspectable(
    inspectorInfo = debugInspectorInfo {
        name = "simpleFrame"
        value = color
    }
) {
    background(color, RoundedCornerShape(5.0.dp))
}

/**
 * Sample with multiple parameters
 */
fun Modifier.fancyFrame(size: Dp, color: Color) = inspectable(
    inspectorInfo = debugInspectorInfo {
        name = "fancyFrame"
        properties["size"] = size
        properties["color"] = color
    }
) {
    background(color, RoundedCornerShape(size))
}

isDebugInspectorInfoEnabled

public static final boolean isDebugInspectorInfoEnabled()

Turn on inspector debug information. Used internally during inspection.

setDebugInspectorInfoEnabled

public static final void setDebugInspectorInfoEnabled(boolean isDebugInspectorInfoEnabled)

Turn on inspector debug information. Used internally during inspection.