84fa87338d
* Introduce ComposeTesting * Add sample * Add test sample * Add missing files * Update dependencies * Add more comments * Update FoldHelper to use TestRule * Add ktlint and update config * Clean up the dependencies * Rename the APIs * Update README * Add simple SwipeHelper example tests * Update dependencies and README * Update pipeline to include ComposeTesting * Delete local.properties * Delete local.properties * Delete local.properties * Add more missing files * Move ktlint back to 0.40.0 * Address the comments * Update the name in yml files * Add more tests * Rename the package name Co-authored-by: Kristen Halper <khalp@vt.edu> |
||
|---|---|---|
| .github/workflows | ||
| ComposeTesting | ||
| TwoPaneLayout | ||
| WindowState | ||
| .gitignore | ||
| CODE_OF_CONDUCT.md | ||
| LICENSE | ||
| README.md | ||
| SECURITY.md | ||
| SUPPORT.md | ||
README.md
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.1.0-rc03 - Jetpack Window Manager version:
1.0.0 - Android Studio version: Bumblebee
2021.1.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.
WindowState
A utility component that helps you easily get details about the window state of dual-screen, foldable, and large-screen devices.
ComposeTesting
Helper functions that help you easily test your application on the dual-screen, foldable and large screen devices.
Social links
- video: Jetpack Compose WindowState preview
- blog: Jetpack Compose WindowState preview
- video: Get started with Jetpack Compose Twitch
- blog: Get started with Jetpack Compose
- 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
- 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.