Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/microsoft/surface-duo-compose-sdk

This repo contains components built with Jetpack Compose for the Microsoft Surface Duo.
https://github.com/microsoft/surface-duo-compose-sdk
android jetpack-compose surface-duo
Last synced: about 1 month ago
JSON representation
This repo contains components built with Jetpack Compose for the Microsoft Surface Duo.
Host: GitHub
URL: https://github.com/microsoft/surface-duo-compose-sdk
Owner: microsoft
License: mit
Created: 2021-11-10T15:21:10.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2023-06-13T23:12:17.000Z (over 1 year ago)
Last Synced: 2024-12-04T17:49:13.904Z (about 1 month ago)
Topics: android, jetpack-compose, surface-duo
Language: Kotlin
Homepage:
Size: 18.3 MB
Stars: 104
Watchers: 10
Forks: 5
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project

README

        ![build-test-check](https://github.com/microsoft/surface-duo-compose-sdk/actions/workflows/build_test_check.yml/badge.svg) ![Compose Version](https://img.shields.io/badge/Jetpack%20Compose-1.4.3-brightgreen)

# 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](CODE_OF_CONDUCT.md) and [contribution guidelines](CONTRIBUTING.md).

## 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](https://docs.microsoft.com/dual-screen/android), and follow [our blog](https://devblogs.microsoft.com/surface-duo).

Please check out our page on [Jetpack Compose for Microsoft Surface Duo](https://docs.microsoft.com/dual-screen/android/jetpack/compose/) for more details.

## Contents

### [TwoPaneLayout](https://github.com/microsoft/surface-duo-compose-sdk/tree/main/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](https://github.com/microsoft/surface-duo-compose-sdk/releases/tag/twopanelayout_20230523_1.0.1-alpha07) (May 23rd, 2023)

### [WindowState](https://github.com/microsoft/surface-duo-compose-sdk/tree/main/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](https://github.com/microsoft/surface-duo-compose-sdk/releases/tag/windowstate_20230504_alpha09) (May 4th, 2023)

### [ComposeTesting](https://github.com/microsoft/surface-duo-compose-sdk/tree/main/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](https://github.com/microsoft/surface-duo-compose-sdk/releases/tag/composetesting_20230505_alpha09) (May 5th, 2023)

### [DragAndDrop](https://github.com/microsoft/surface-duo-compose-sdk/tree/main/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](https://github.com/microsoft/surface-duo-compose-sdk/releases/tag/draganddrop_20230505_alpha05) (May 5th, 2023)

## Social links

| Blog post | Video |

|---|---|

| [Improved navigation support in TwoPaneLayout](https://devblogs.microsoft.com/surface-duo/twopanelayout-navigation/) | N/A |

| [Blossoming love for Compose animation](https://devblogs.microsoft.com/surface-duo/jetpack-compose-animation-3/) | [Twitch #105: Jetpack Compose animations](https://www.youtube.com/watch?v=8ql2CDpx6lk) |

| [Blooming love for Compose animation](https://devblogs.microsoft.com/surface-duo/jetpack-compose-animation-2/) | _see above_ |

| [Budding love for Compose animation](https://devblogs.microsoft.com/surface-duo/jetpack-compose-animation-1/) | _see above_ |

| [JetchatGPT improvements: error handling and animations](https://devblogs.microsoft.com/surface-duo/android-openai-chatgpt-6/) | [Twitch #104: Working with OpenAI on Android and building JetchatGPT](https://www.youtube.com/watch?v=-J4eb7j25Qg) |

| [Jetchat with OpenAI on Android](https://devblogs.microsoft.com/surface-duo/android-openai-chatgpt-5/) | _see above_ |

| [Relay Anchor Leg: Overall impressions](https://devblogs.microsoft.com/surface-duo/jetpack-compose-relay-3/) | [Twitch #102: Relay for Jetpack Compose](https://www.youtube.com/watch?v=Gnf8NJQwENU) |

| [Relay Leg 2: Tips and tricks](https://devblogs.microsoft.com/surface-duo/jetpack-compose-relay-2/) | _see above_ |

| [Pass the design baton with Relay](https://devblogs.microsoft.com/surface-duo/jetpack-compose-relay-1/) | _see above_ |

| [Compose TwoPaneLayout updates](https://devblogs.microsoft.com/surface-duo/jetpack-compose-twopanelayout-updates/) | [Twitch #100: Compose TwoPaneLayout updates](https://www.youtube.com/watch?v=ZeqJThroeUw) |

| [Jetpack Compose Accompanist TwoPane](https://devblogs.microsoft.com/surface-duo/jetpack-compose-accompanist-twopane/) | [Twitch #89: Jetpack Compose Accompanist TwoPane](https://www.youtube.com/watch?v=xt-iJCStEy0) |

| [Improving app accessibility with Jetpack Compose](https://devblogs.microsoft.com/surface-duo/jetpack-compose-accessibility/) | [Twitch #88: Jetpack Compose Accessibility](https://www.youtube.com/watch?v=BNy9jwTyRco) |

| [Dual-screen example adds Jetpack Compose to the experience](https://devblogs.microsoft.com/surface-duo/jetpack-compose-existing-app/) | [Twitch #86: Adding Jetpack Compose to existing apps](https://www.youtube.com/watch?v=9c7s0I6VcFU) |

| [Source Editor & Diary samples for Jetpack Compose](https://devblogs.microsoft.com/surface-duo/jetpack-compose-source-editor-diary-samples/) | [Twitch #79: More new Jetpack Compose samples](https://www.youtube.com/watch?v=eO0D3MHvKLA) |

| [Video+Chat and Calculator samples for Jetpack Compose](https://devblogs.microsoft.com/surface-duo/jetpack-compose-video-calculator-samples/) | [Twitch #77: New Jetpack Compose samples](https://www.youtube.com/watch?v=b4WG3moVriA) |

| [Jetpack Compose TwoPaneLayout update](https://devblogs.microsoft.com/surface-duo/jetpack-compose-foldable-twopanelayout/) | [Twitch #76: Jetpack Compose TwoPaneLayout update](https://www.youtube.com/watch?v=cI73qh_mTOo) |

| [Write foldable tests quickly with Test Kit](https://devblogs.microsoft.com/surface-duo/foldable-ui-test-kit/) | [Twitch #63: Test Kit for foldable apps](https://www.youtube.com/watch?v=3I0qU5SeUBM) |

| [Jetpack Compose UI testing](https://devblogs.microsoft.com/surface-duo/jetpack-compose-ui-test/) | [Twitch #59: Jetpack Compose testing](https://www.youtube.com/watch?v=Q3lDz7PjO7U) |

| [Jetpack Compose WindowState preview](https://devblogs.microsoft.com/surface-duo/jetpack-compose-windowstate-preview/) | [Twitch #53: Jetpack Compose WindowState for foldable devices](https://www.youtube.com/watch?v=qOIliow-uS4) |

| [Get started with Jetpack Compose](https://devblogs.microsoft.com/surface-duo/get-started-with-jetpack-compose/) | [Twitch #44: Get started with Jetpack Compose](https://www.youtube.com/watch?v=ijXDWDtdiIE) |

| [Jetpack Compose Navigation Rail](https://devblogs.microsoft.com/surface-duo/jetpack-compose-navigation-rail/) | [Twitch #42: Jetpack Compose Navigation Rail](https://www.youtube.com/watch?v=pdoIyOU7Suk) |

| [New TwoPaneLayout Compose library preview](https://devblogs.microsoft.com/surface-duo/jetpack-compose-twopanelayout-preview/) | [Twitch #25: TwoPaneLayout preview for Jetpack Compose](https://www.youtube.com/watch?v=Q66bR2jKdrg) |

| [Jetpack Compose foldable and dual-screen development](https://devblogs.microsoft.com/surface-duo/jetpack-compose-foldable-samples) | [Twitch #9: Jetpack Compose samples](https://www.youtube.com/watch?v=m8bMjFhBbN8) |

| [Jetpack Compose on Microsoft Surface Duo](https://devblogs.microsoft.com/surface-duo/jetpack-compose-dual-screen-sample/) | N/A |

## Related links

- [Compose samples](https://github.com/microsoft/surface-duo-compose-samples/)

- [Jetpack Window Manager samples](https://github.com/microsoft/surface-duo-window-manager-samples)

- [SDK samples (Java)](https://github.com/microsoft/surface-duo-sdk-samples)

- [SDK samples (Kotlin)](https://github.com/microsoft/surface-duo-sdk-samples-kotlin)

- [Unity samples](https://github.com/microsoft/surface-duo-sdk-unity-samples)

- [Xamarin samples](https://github.com/microsoft/surface-duo-sdk-xamarin-samples)

- [Flutter samples](https://github.com/microsoft/surface-duo-sdk-samples-flutter)

- [React Native samples](https://github.com/microsoft/react-native-dualscreen)

- [Web samples](https://docs.microsoft.com/dual-screen/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](https://opensource.microsoft.com/codeofconduct/).

For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or

contact [[email protected]](mailto:[email protected]) 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](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).

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.