ComposeDialogs
4.0.0indexedEnhances user interfaces with customizable dialogs, offering flexible configurations and seamless integration for simplified dialog management and user interaction.
91
Stars
2
Used by
dependents
—
Health
/ 100
ComposeDialogs
This library offers you an easily extendible compose framework for modal dialogs and allows to show them as a dialog, bottom sheet or even as full screen dialog.
[!NOTE] All features are splitted into separate modules, just include the modules you want to use!
Table of Contents
:camera: Screenshots
color
 |  |  |
date
 |  |  |
frequency
 |  |  |
info
 |  |  |
input
 |  |
list
 |
menu
 |
number
 |  |  |
progress
 |  |
time
 |  |
:computer: Supported Platforms
:arrow_right: Versions
| Dependency | Version |
|---|---|
| Kotlin | 2.4.0 |
| Jetbrains Compose | 1.11.1 |
:warning: Following experimental annotations are used:
- OptIn
androidx.compose.material3.ExperimentalMaterial3Api(5x)androidx.compose.ui.ExperimentalComposeUiApi(5x)I try to use as less experimental features as possible, but in this case the ones above are needed!
:wrench: Setup
:rocket: Usage
Basic examples
// create and remember a state
val state = rememberDialogState()
// Create a dialog composable
if (state.visible) {
DialogInfo(
state = state,
info = "Some "
)
}
// show the dialog inside a button press event or similar
Button(onClick = { state.show() }) {
Text("Show Dialog")
}
Alternatively you can hold any saveable state inside dialog state. If the dialog state holds any data, it will consider itself as visible.
// create and remember a state (e.g. selected list index as in this example)
val state = rememberDialogState<Int>(data = null)
// show a dialog if necessary
if (state.showing)
{
val data = state.requireData()
DialogInfo(
state = state,
info =
)
}
items =
LazyColumn {
items.forEach {
item(key = it) {
Button(onClick = { state.show(it) }) {
Text()
}
}
}
}
ViewModel / usage outside of composable
If you want to hold the dialog state inside a ViewModel or similar you can use the dialogStateOf functions.
// simple usage
val dialog = dialogStateOf() // a state that holds no data, just visibility information
val dialog = dialogStateOf<String>(data = null) // a state that holds some data
// if the state should survive process death, you can use following pattern with `SavedStateHandle`
private val KEY = "dialog_data"
val dialog = dialogStateOf(
data = savedStateHandle.get<String?>(KEY),
onStateChanged = { savedStateHandle[KEY] = it }
)
Styling/Customisation and events
All dialog (also custom ones) do support styling like:
- optional icon (including style like
CenterTopandBegin) - dialog style (dialog, bottom sheet, fullscreen)
- custom buttons (zero, one or two) with custom texts
- a options variable to set up features like
dismissOnButtonClick,dismissOnBackPressand
Check out the advanced region on the side for more details.
Dialogs
Check out all the modules to find out more about the available implementations.
:file_folder: Modules
:sparkles: Demo
A full demo is included inside the demo module, it shows nearly every usage with working examples.
:information_source: More
- Advanced
- Migration
:books: API
Check out the API documentation.
:bulb: Other Libraries
You can find more libraries (all multiplatform) of mine that all do work together nicely here.
