# PreviewParameterProvider

Artifact: [androidx.compose.ui:ui-tooling-preview](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/tooling/preview/PreviewParameter.kt+class:androidx.compose.ui.tooling.preview.PreviewParameterProvider) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Common/All
- Cmn

  ```
  interface PreviewParameterProvider<T : Any?>
  ```
Known direct subclasses [BaseWidgetPreviewParams](https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/BaseWidgetPreviewParams), [CollectionPreviewParameterProvider](https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/datasource/CollectionPreviewParameterProvider), [LoremIpsum](https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/datasource/LoremIpsum)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/BaseWidgetPreviewParams` | A base `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider` for `https://developer.android.com/reference/kotlin/androidx/glance/wear/core/WearWidgetParams` that provides standardized metadata for Glance Wear widget previews in Android Studio. |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/datasource/CollectionPreviewParameterProvider` |   |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/datasource/LoremIpsum` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider` with 1 value containing Lorem Ipsum. |

Known indirect subclasses [RectangularAllWidgetPreviewParams](https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/RectangularAllWidgetPreviewParams), [RectangularLargeWidgetPreviewParams](https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/RectangularLargeWidgetPreviewParams), [RectangularSmallWidgetPreviewParams](https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/RectangularSmallWidgetPreviewParams), [RoundAllWidgetPreviewParams](https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/RoundAllWidgetPreviewParams), [RoundLargeWidgetPreviewParams](https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/RoundLargeWidgetPreviewParams), [RoundSmallWidgetPreviewParams](https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/RoundSmallWidgetPreviewParams), [SquircleAllWidgetPreviewParams](https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/SquircleAllWidgetPreviewParams), [SquircleLargeWidgetPreviewParams](https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/SquircleLargeWidgetPreviewParams), [SquircleSmallWidgetPreviewParams](https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/SquircleSmallWidgetPreviewParams)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/RectangularAllWidgetPreviewParams` | A `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider` that provides standard widget configurations to be used for preview image assets that are displayed as part of the system, such as a catalog, that are not cut to shape as it will be done by the system. |
| `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/RectangularLargeWidgetPreviewParams` | A `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider` that provides Large-type widget configurations from the rectangular specification with safe padding buffers. |
| `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/RectangularSmallWidgetPreviewParams` | A `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider` that provides Small-type widget configurations from the rectangular specification with safe padding buffers. |
| `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/RoundAllWidgetPreviewParams` | A `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider` that provides standard configurations based on the custom fully rounded specification. |
| `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/RoundLargeWidgetPreviewParams` | Provides Large-type widget configurations from the default round specification for both small and large screens. |
| `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/RoundSmallWidgetPreviewParams` | Provides Small-type widget configurations from the default round specification for both small and large screens. |
| `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/SquircleAllWidgetPreviewParams` | A `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider` that provides standard configurations based on the default squircle specifications from the wear widget host. |
| `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/SquircleLargeWidgetPreviewParams` | Provides Large-type widget configurations from the default squircle specification for both small and large screens. |
| `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/SquircleSmallWidgetPreviewParams` | Provides Small-type widget configurations from the default squircle specification for both small and large screens. |

*** ** * ** ***

Interface to be implemented by any provider of values that you want to be injected as @`https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/Preview` parameters. This allows providing sample information for previews.

## Summary

| ### Public functions |
|---|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider#getDisplayName(kotlin.Int)(index: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Returns a descriptive display name for the value at a given `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider#getDisplayName(kotlin.Int)` from the `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.sequences/-sequence/index.html`. | Cmn |

| ### Public properties |
|---|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider#count()` Returns the number of elements in the `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.sequences/-sequence/index.html`. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.sequences/-sequence/index.html<T>` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider#values()` `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.sequences/-sequence/index.html` of values of type `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider` to be passed as @`https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/Preview` parameter. | Cmn |

## Public functions

### getDisplayName

Cmn Added in [1.10.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.10.0)

```
open fun getDisplayName(index: Int): String?
```

Returns a descriptive display name for the value at a given `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider#getDisplayName(kotlin.Int)` from the `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.sequences/-sequence/index.html`.

This name is used in the preview UI to help identify individual preview cases generated by this provider. This allows for position-based naming schemes (e.g., "Step 1", "Step 2"). To create a name based on the value's content, the value would need to be retrieved from the `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider#values()` sequence within this method's implementation.

For example, for a `PreviewParameterProvider` representing steps in a flow, you might return `"Step ${index + 1}"`.

If `null` or an empty string is returned, the preview UI will fall back to a default name determined by Android Studio.

| Parameters |
|---|---|
| `index: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The position of the value in the `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.sequences/-sequence/index.html`. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | A custom name for the preview for the value at the given `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider#getDisplayName(kotlin.Int)`, or `null` or an empty string to use the default. |

## Public properties

### count

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
open val count: Int
```

Returns the number of elements in the `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.sequences/-sequence/index.html`.

### values

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val values: Sequence<T>
```

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.sequences/-sequence/index.html` of values of type `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider` to be passed as @`https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/Preview` parameter.