https://github.com/x1nto/overlappingpanelscompose
Jetpack Compose implementation of Discord's Overlapping Panels
https://github.com/x1nto/overlappingpanelscompose
android android-library android-navigation jetpack-compose jetpack-compose-navigation kotlin kotlin-library navigation
Last synced: about 2 months ago
JSON representation
Jetpack Compose implementation of Discord's Overlapping Panels
- Host: GitHub
- URL: https://github.com/x1nto/overlappingpanelscompose
- Owner: X1nto
- License: apache-2.0
- Created: 2021-09-26T11:59:39.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-12-31T18:44:23.000Z (over 3 years ago)
- Last Synced: 2023-03-05T08:23:07.437Z (about 2 years ago)
- Topics: android, android-library, android-navigation, jetpack-compose, jetpack-compose-navigation, kotlin, kotlin-library, navigation
- Language: Kotlin
- Homepage:
- Size: 119 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OverlappingPanelsCompose
Jetpack Compose implementation of [Discord's Overlapping Panels](https://github.com/discord/OverlappingPanels)
Installation
-------
### Groovy
Add JitPack repository to root build.gradle
```groovy
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
Add OverlappingPanelsCompose dependency to app build.gradle
```groovy
dependencies {
implementation 'com.github.X1nto:OverlappingPanelsCompose:'
}
```
### Kotlin DSL
Add JitPack repository to root build.gradle
```kotlin
allprojects {
repositories {
...
maven(url = "https://jitpack.io")
}
}
```
Add OverlappingPanelsCompose dependency to app build.gradle
```kotlin
dependencies {
implementation("com.github.X1nto:OverlappingPanelsCompose:")
}
```
Basic usage
-------
```kotlin
val panelsState = rememberOverlappingPanelsState()
OverlappingPanels(
modifier = Modifier.fillMaxSize(),
panelsState = panelsState,
panelStart = { /* Start Panel content */ },
panelCenter = { /* Center Panel content */ },
panelEnd = { /* End Panel content */ },
)
```
Check out the [sample app](/app) for examples on how to use the library.
License
-------
```
Copyright (C) 2021 X1nto.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```