@@ -21,40 +21,49 @@ sample together with the
2121
2222# Getting Started
2323
24- ## Widget Samples
24+ ## Canonical Widget Layout Samples
2525
26- The sample contains 3 type of widgets:
26+ These [ layouts] ( ./src/main/java/com/example/platform/ui/appwidgets/glance/layout ) demonstrate how
27+ to write responsive, high-quality layouts for use with your Glance widgets.
2728
28- - ToDo list: showcasing how to create a list of items
29- - Buttons: showcasing how to use the new CompoundedButtons and handle click events
30- - Weather: showcasing a "real-life" weather widget.
29+ The ` layouts ` directory contains following layout categories:
3130
32- Those are implemented in two packages:
31+ * [ collections] ( ./src/main/java/com/example/platform/ui/appwidgets/glance/layout/collections )
32+ * [ Action list] ( ./src/main/java/com/example/platform/ui/appwidgets/glance/layout/collections/ActionListAppWidget.kt )
33+ * [ Check list] ( ./src/main/java/com/example/platform/ui/appwidgets/glance/layout/collections/CheckListAppWidget.kt )
34+ * [ Image grid] ( ./src/main/java/com/example/platform/ui/appwidgets/glance/layout/collections/ImageGridAppWidget.kt )
35+ * [ Image text list] ( ./src/main/java/com/example/platform/ui/appwidgets/glance/layout/collections/ImageTextListAppWidget.kt )
3336
34- - [ rv] ( src/main/java/com/example/platform/ui/appwidgets/rv ) for RemoteViews implementation
35- - [ glance] ( src/main/java/com/example/platform/ui/appwidgets/glance ) for Glance implementation
37+ * [ text] ( ./src/main/java/com/example/platform/ui/appwidgets/glance/layout/text )
38+ * [ Long Text] ( ./src/main/java/com/example/platform/ui/appwidgets/glance/layout/text/LongTextAppWidget.kt )
39+ * [ Text with image] ( ./src/main/java/com/example/platform/ui/appwidgets/glance/layout/text/TextWithImageAppWidget.kt )
3640
37- ## Widget Pinning
41+ * [ toolbars] ( ./src/main/java/com/example/platform/ui/appwidgets/glance/layout/toolbars )
42+ * [ Toolbar with app name] ( ./src/main/java/com/example/platform/ui/appwidgets/glance/layout/toolbars/ToolBarAppWidget.kt )
43+ * [ Toolbar with search bar] ( ./src/main/java/com/example/platform/ui/appwidgets/glance/layout/toolbars/SearchToolBarAppWidget.kt )
3844
39- In addition, the [ AppWidgets.kt] ( src/main/java/com/example/platform/ui/appwidgets/AppWidgets.kt )
40- showcases how to request the launcher to "pin" an appwidget.
45+ Each of these layout categories contains a ` layout ` sub-directory that can be copied to your project
46+ to reuse the layouts in your code.
47+
48+ The ` {layoutType}Layout ` file e.g. ` ToolBarLayout ` contains:
49+ * A top level composable e.g. ` ToolBarLayout ` ,
50+ * Sub components,
51+ * A breakpoints definition e.g. ` ToolBarLayoutSize ` ,
52+ * Constants / dimensions e.g. ` ToolBarLayoutDimens ` ,
53+ * Followed by Android Studio Preview for the layout.
4154
42- <img src="screenshots/todo-gif.gif" width="256px"
43- alt="TODO widget showcase"
44- title="Showcase of the TODO widget implementation" />
45- <img src="screenshots/weather-gif.gif" width="256px"
46- alt="Weather widget showcase"
47- title="Showcase of the Weather widget implementation" />
48- <img src="screenshots/images-gif.gif" width="256px"
49- alt="Images widget showcase"
50- title="Showcase of the Images widget implementation" />
55+ Read more about the layouts: https://developer.android.com/design/ui/mobile/guides/widgets/layouts
56+
57+ <img src="screenshots/CanonicalLayouts.png" width="256px"
58+ alt="Canonical Widget Layouts Showcase"
59+ title="Showcase of canonical widget layouts" />
5160
5261> More showcasing resources in the [ screenshots folder] ( screenshots )
5362
54- ## Canonical Layouts
63+ ## Widget Pinning
5564
56- These [ layouts ] ( ./ src/main/java/com/example/platform/ui/appwidgets/glance/layout ) demonstrate how to write responsive, high-quality layouts for use with your
57- Glance widgets.
65+ In addition, the [ AppWidgets.kt ] ( src/main/java/com/example/platform/ui/appwidgets/AppWidgets.kt )
66+ showcases how to request the launcher to "pin" an appwidget.
5867
5968## Run a new configuration
6069
0 commit comments