androidx.glance.template

Classes

ActionBlock

Block of action list of text or image buttons.

AspectRatio

The aspect ratio type of an image.

ButtonType

The type of button such as FAB/Icon/Text/IconText types

FreeformTemplateData

The semantic data required to build Freeform Template layouts

GalleryTemplateData

The semantic data required to build Gallery Template layouts

GlanceTemplateAppWidget

A GlanceAppWidget that provides template local values.

HeaderBlock

A header for the whole template.

ImageBlock

A block of image sequence by certain size and aspect ratio preferences and display priority relative to other blocks such as a TextBlock.

ImageSize

The image size describes image scale category in sizing.

ListStyle

The List Styles supported by the list template elements.

ListTemplateData

The semantic data required to build List Template layouts.

ListTemplateItem

The data required to display a list item.

SingleEntityTemplateData

The semantic data required to build Single Entity Template layouts.

TemplateButton

Base class for a button taking an Action without display oriented information.

TemplateImageButton

An image based TemplateButton.

TemplateImageWithDescription

Contains the information required to display an image on a template.

TemplateText

Contains the information required to display a string on a template.

TemplateTextButton

A text based TemplateButton.

TextBlock

A block of text with up to three different TextType of text lines that are displayed by the text index order (for example, text1 is displayed first) by design.

TextType

The text types that can be used with templates such as set in TemplateText items to determine text styling.

Enums

TemplateMode

The glanceable display orientation

Top-level functions summary

Unit

Composable layout for a freeform template app widget.

Unit

Composable layout for a gallery template app widget.

Unit

Composable layout for a list template app widget.

Unit

Composable layout for a single entity template app widget.

Top-level properties summary

Top-level functions

FreeformTemplate

@Composable
fun FreeformTemplate(data: FreeformTemplateData): Unit

Composable layout for a freeform template app widget. The freeform template is optimized to highlight a single piece of data.

Parameters
data: FreeformTemplateData

the data that defines the widget

GalleryTemplate

@Composable
fun GalleryTemplate(data: GalleryTemplateData): Unit

Composable layout for a gallery template app widget. The template is optimized to show images.

Parameters
data: GalleryTemplateData

the data that defines the widget

@Composable
fun ListTemplate(data: ListTemplateData): Unit

Composable layout for a list template app widget. The template is optimized to display a list of items.

Parameters
data: ListTemplateData

the data that defines the widget

SingleEntityTemplate

@Composable
fun SingleEntityTemplate(data: SingleEntityTemplateData): Unit

Composable layout for a single entity template app widget. The template describes a widget layout based around a single entity.

Parameters
data: SingleEntityTemplateData

the data that defines the widget

Top-level properties