Skip to content

Jetpack Compose implementation of Discord's Overlapping Panels

License

Notifications You must be signed in to change notification settings

X1nto/OverlappingPanelsCompose

Repository files navigation

OverlappingPanelsCompose

Jetpack Compose implementation of Discord's Overlapping Panels

Installation

Groovy

Add JitPack repository to root build.gradle

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

Add OverlappingPanelsCompose dependency to app build.gradle

dependencies {
    implementation 'com.github.X1nto:OverlappingPanelsCompose:<version>'
}

Kotlin DSL

Add JitPack repository to root build.gradle

allprojects {
    repositories {
        ...
        maven(url = "https://jitpack.io")
    }
}

Add OverlappingPanelsCompose dependency to app build.gradle

dependencies {
    implementation("com.github.X1nto:OverlappingPanelsCompose:<version>")
}

Basic usage

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 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.