# BaseWidgetPreviewParams

Artifact: [androidx.glance.wear:wear-tooling-preview](https://developer.android.com/jetpack/androidx/releases/glance-wear) [View Source](https://cs.android.com/search?q=file:androidx/glance/wear/tooling/preview/BaseWidgetPreviewParams.kt+class:androidx.glance.wear.tooling.preview.BaseWidgetPreviewParams) Added in [1.0.0-alpha22](https://developer.android.com/jetpack/androidx/releases/glance-wear#1.0.0-alpha22)


```
abstract class BaseWidgetPreviewParams : PreviewParameterProvider<WearWidgetParams>
```

<br />

Known direct 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. |

*** ** * ** ***

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.

This class consolidates the logic for generating human-readable display names for preview variants. It is intended to be subclassed by specific parameter providers that define the sequence of configurations to preview.

The implementation of `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/BaseWidgetPreviewParams#getDisplayName(kotlin.Int)` ensures that each preview tab in the IDE clearly identifies the widget type and its dimensions.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/BaseWidgetPreviewParams#BaseWidgetPreviewParams(kotlin.sequences.Sequence,kotlin.String)( values: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.sequences/-sequence/index.html<https://developer.android.com/reference/kotlin/androidx/glance/wear/core/WearWidgetParams>, previewPrefix: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html )` |

| ### Public functions |
|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/BaseWidgetPreviewParams#getDisplayName(kotlin.Int)(index: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Returns a descriptive name for the preview configuration at the specified `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/BaseWidgetPreviewParams#getDisplayName(kotlin.Int)`. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/BaseWidgetPreviewParams#previewPrefix()` The prefix to use for the display name of the preview parameters. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.sequences/-sequence/index.html<https://developer.android.com/reference/kotlin/androidx/glance/wear/core/WearWidgetParams>` | `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/BaseWidgetPreviewParams#values()` The sequence of `https://developer.android.com/reference/kotlin/androidx/glance/wear/core/WearWidgetParams` configurations to be supplied to the preview. |

### Inherited properties

From [androidx.compose.ui.tooling.preview.PreviewParameterProvider](https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider) `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()`

## Public constructors

### BaseWidgetPreviewParams

Added in [1.0.0-alpha22](https://developer.android.com/jetpack/androidx/releases/glance-wear#1.0.0-alpha22)

```
BaseWidgetPreviewParams(
    values: Sequence<WearWidgetParams>,
    previewPrefix: String
)
```

## Public functions

### getDisplayName

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

Returns a descriptive name for the preview configuration at the specified `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/BaseWidgetPreviewParams#getDisplayName(kotlin.Int)`.

The returned string includes the widget's container type (Small or Large) and its specific dimensions in DP, following the format: "{previewPrefix} {Type} {Width}x{Height}dp". For example: "Squircle Small 166x72dp".

| Parameters |
|---|---|
| `index: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The index of the parameter in the `https://developer.android.com/reference/kotlin/androidx/glance/wear/tooling/preview/BaseWidgetPreviewParams#values()` sequence. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | A human-readable label for the Android Studio preview tool. |

## Public properties

### previewPrefix

Added in [1.0.0-alpha22](https://developer.android.com/jetpack/androidx/releases/glance-wear#1.0.0-alpha22)

```
val previewPrefix: String
```

The prefix to use for the display name of the preview parameters.

### values

Added in [1.0.0-alpha22](https://developer.android.com/jetpack/androidx/releases/glance-wear#1.0.0-alpha22)

```
open val values: Sequence<WearWidgetParams>
```

The sequence of `https://developer.android.com/reference/kotlin/androidx/glance/wear/core/WearWidgetParams` configurations to be supplied to the preview.