Surface Duo Jetpack Compose SDK

This repo contains components built with Jetpack Compose for the Microsoft Surface Duo and other large screen and foldable devices.

Please read the code of conduct and contribution guidelines.

Prerequisites

• Jetpack Compose version: 1.4.3
• Jetpack Window Manager version: 1.1.0-beta02
• Android Studio version: Flamingo 2022.2.1

Getting Started

When importing the component source code into Android Studio, use the specific component folder (ex: TwoPaneLayout) as the base directory of the 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.

Contents

TwoPaneLayout

A UI component that helps you build two-pane layout for dual-screen, foldable, and large-screen devices.

Latest Update: 1.0.1-alpha07 (May 23rd, 2023)

WindowState

A utility component that helps you easily get details about the window state of dual-screen, foldable, and large-screen devices.

Latest Update: 1.0.0-alpha09 (May 4th, 2023)

ComposeTesting

Helper functions that help you easily test your application on the dual-screen, foldable and large screen devices.

Latest Update: 1.0.0-alpha09 (May 5th, 2023)

DragAndDrop

A Compose component that helps you build drag and drop feature on any Android devices, especially dual-screen, foldable and large-screen devices.

Latest Update: 1.0.0-alpha05 (May 5th, 2023)

Social links

Blog post	Video
Improved navigation support in TwoPaneLayout	N/A
Blossoming love for Compose animation	Twitch #105: Jetpack Compose animations
Blooming love for Compose animation	see above
Budding love for Compose animation	see above
JetchatGPT improvements: error handling and animations	Twitch #104: Working with OpenAI on Android and building JetchatGPT
Jetchat with OpenAI on Android	see above
Relay Anchor Leg: Overall impressions	Twitch #102: Relay for Jetpack Compose
Relay Leg 2: Tips and tricks	see above
Pass the design baton with Relay	see above
Compose TwoPaneLayout updates	Twitch #100: Compose TwoPaneLayout updates
Jetpack Compose Accompanist TwoPane	Twitch #89: Jetpack Compose Accompanist TwoPane
Improving app accessibility with Jetpack Compose	Twitch #88: Jetpack Compose Accessibility
Dual-screen example adds Jetpack Compose to the experience	Twitch #86: Adding Jetpack Compose to existing apps
Source Editor & Diary samples for Jetpack Compose	Twitch #79: More new Jetpack Compose samples
Video+Chat and Calculator samples for Jetpack Compose	Twitch #77: New Jetpack Compose samples
Jetpack Compose TwoPaneLayout update	Twitch #76: Jetpack Compose TwoPaneLayout update
Write foldable tests quickly with Test Kit	Twitch #63: Test Kit for foldable apps
Jetpack Compose UI testing	Twitch #59: Jetpack Compose testing
Jetpack Compose WindowState preview	Twitch #53: Jetpack Compose WindowState for foldable devices
Get started with Jetpack Compose	Twitch #44: Get started with Jetpack Compose
Jetpack Compose Navigation Rail	Twitch #42: Jetpack Compose Navigation Rail
New TwoPaneLayout Compose library preview	Twitch #25: TwoPaneLayout preview for Jetpack Compose
Jetpack Compose foldable and dual-screen development	Twitch #9: Jetpack Compose samples
Jetpack Compose on Microsoft Surface Duo	N/A

Related links

• Compose samples
• 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.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.