d4cb092e21
* Create window-info module * Update build.gradle settings * Add helper classes * Update ComposeGallery to use module * Update to wm beta04 and twopanelayout alpha10 * Update Compose Gallery tests to follow new app structure * Rename module and classes * Update NavigationRail sample to use module * Add window mode (~device posture) to window state * Update companion pane to use module * Fix module manifest formatting * Update dual view to use module * Update list detail to use module * Update two page to use module * Refactor WindowState properties * Expose additional fold info in WindowState fold state, isSeparating, and occlusion type * Rename module to window state * Rename package to windowstate * Update large screen logic to only include expanded size class * Add tests for window state module * Remove FoldingFeature dependency in WindowState * Remove redundant JWM dependencies * Update ComposeGallery tests to use new fold state enum * Remove unnecessary JWM imports from ComposeGallery tests |
||
|---|---|---|
| .github/workflows | ||
| CompanionPane | ||
| ComposeGallery | ||
| DualView | ||
| ExtendedCanvas | ||
| ListDetail | ||
| NavigationRail | ||
| TestUtils | ||
| TwoPage | ||
| WindowState | ||
| gradle/wrapper | ||
| screenshots | ||
| .gitignore | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
| SECURITY.md | ||
| SUPPORT.md | ||
| build.gradle | ||
| dependencies.gradle | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| ktlint.gradle | ||
| settings.gradle | ||
README.md
| page_type | name | languages | products | description | urlFragment | ||
|---|---|---|---|---|---|---|---|
| sample | Surface Duo - Jetpack Compose samples |
|
|
Samples showing how to use Jetpack Compose to achieve dual-screen user interface patterns. | all |
Surface Duo Jetpack Compose Samples
This repo contains samples built with Jetpack Compose for the Microsoft Surface Duo and other large screen and foldable devices. These samples demonstrate our dual-screen user interface patterns with the new UI framework.
Please read the code of conduct and contribution guidelines.
Getting Started
When importing the code samples into Android Studio, use the repository directory as the base directory of the project. This lets you access and run all of the sample modules from within the same project.
To learn how to load apps on the Surface Duo emulator, see the documentation, and follow our blog.
Please check out our page on Jetpack Compose for Microsoft Surface Duo for more details.
Prerequisites
-
Jetpack Compose version:
1.0.5 -
Jetpack WindowManager version:
1.0.0-beta03
Contents
| Sample | Description | |
|---|---|---|
| ComposeGallery |  |
Sample with a Microsoft Surface Duo theme that shows how to use the List Detail app pattern. |
| CompanionPane |  |
Photo editor sample that shows how to build the Companion Pane app pattern in Jetpack Compose. |
| ExtendedCanvas |  |
Map sample that shows how to build the Extended Canvas app pattern in Jetpack Compose. |
| ListDetail |  |
Photo gallery sample that shows how to build the List Detail app pattern in Jetpack Compose. |
| DualView |  |
Restaurant finder sample that shows how to build the Dual View app pattern in Jetpack Compose. |
| Two Page |  |
E-reader sample that shows how to build the Two Page app pattern in Jetpack Compose. |
| NavigationRail |  |
Nature-themed sample that shows how to use a combination of NavigationRail and BottomNavigation when building apps for large screen and foldable devices in Jetpack Compose. |
Social links
- video: NavigationRail Compose sample Twitch
- blog: NavigationRail Compose sample
- video: TwoPaneLayout Compose library Twitch
- blog: New TwoPaneLayout Compose library preview
- video: Jetpack Compose samples Twitch
- blog: Jetpack Compose foldable and dual-screen development
- blog: Jetpack Compose on Microsoft Surface Duo
Related links
- Surface Duo Compose SDK
- Jetpack Window Manager samples
- SDK samples (Java)
- SDK samples (Kotlin)
- Unity samples
- Xamarin samples
- Flutter samples
- React Native samples
- Web samples
Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
License
Copyright (c) Microsoft Corporation.
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.