BaseWidgetPreviewParams
abstract class BaseWidgetPreviewParams : PreviewParameterProvider
SquircleAllWidgetPreviewParams |
A |
SquircleLargeWidgetPreviewParams |
Provides Large-type widget configurations from the default squircle specification for both small and large screens. |
SquircleSmallWidgetPreviewParams |
Provides Small-type widget configurations from the default squircle specification for both small and large screens. |
A base PreviewParameterProvider for 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 getDisplayName ensures that each preview tab in the IDE clearly identifies the widget type and its dimensions.
Summary
Public constructors |
|---|
BaseWidgetPreviewParams(values: Sequence<WearWidgetParams>) |
Public functions |
|
|---|---|
open String |
getDisplayName(index: Int)Returns a descriptive name for the preview configuration at the specified |
Public properties |
|
|---|---|
open Sequence<WearWidgetParams> |
The sequence of |
Public constructors
BaseWidgetPreviewParams
BaseWidgetPreviewParams(values: Sequence<WearWidgetParams>)
Public functions
getDisplayName
open fun getDisplayName(index: Int): String
Returns a descriptive name for the preview configuration at the specified index.
The returned string includes the widget's container type (Small or Large) and its specific dimensions in DP, following the format: "{Type} Widget {Width}x{Height}dp". For example: "Squircle Small 166x72dp".
| Returns | |
|---|---|
String |
A human-readable label for the Android Studio preview tool. |
Public properties
values
open val values: Sequence<WearWidgetParams>
The sequence of WearWidgetParams configurations to be supplied to the preview.