Skip to content

Add getDisplayName example for @PreviewParameter #730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jordansilva merged 1 commit into from
Dec 8, 2025
Merged

Add getDisplayName example for @PreviewParameter #730

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion ...ippets/src/main/java/com/example/compose/snippets/tooling/AndroidStudioComposeSnippets.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ import androidx.compose.ui.tooling.preview.Preview
import androidx.compose.ui.tooling.preview.PreviewParameter
import androidx.compose.ui.tooling.preview.PreviewParameterProvider
import com.example.compose.snippets.R
import com.example.compose.snippets.interop.User

// [START android_compose_tooling_simple_composable]
@Composable
Expand Down Expand Up @@ -167,6 +166,31 @@ fun UserProfilePreview2(
UserProfile(user)
}
// [END android_compose_tooling_preview_parameter_provider_composable2]


// [START android_compose_tooling_preview_parameter_provider_composable3]
class UserAgePreviewParameterProvider : PreviewParameterProvider<User> {
// Using a List internally for efficient index-based access
private val userList = listOf(
User(name = "Elise", age = 30),
User(name = "Frank", age = 31),
User(name = "Julia", age = 40)
)

override val values = userList.asSequence()

override fun getDisplayName(index: Int): String? {
// Return null or an empty string to use the default index-based name
val user = userList.getOrNull(index) ?: return null
return "${user.name} - ${user.age}"
}
}
// [END android_compose_tooling_preview_parameter_provider_composable3]

// [START_EXCLUDE silent]
data class User(val name: String, val age: Int = 0)
// [END_EXCLUDE]

/*
private object PreviewAnnotationEx {
// [START android_compose_tooling_preview_annotation]
Expand Down