Compose 4 GTK/io.github.compose4gtk.adw.components

Package-level declarations

Types

data class AlertDialogResponse(val id: String, val label: String, val appearance: ResponseAppearance = ResponseAppearance.DEFAULT, val isEnabled: Boolean = true)

Represents a response option (button) in an AlertDialog.

ApplicationWindowScope

interface ApplicationWindowScope

CarouselState

sealed interface CarouselState

OverlaySplitViewScope

interface OverlaySplitViewScope

ToastOverlayScope

interface ToastOverlayScope

Receiver scope for the content lambda of ToastOverlay.

Functions

AboutDialog

@Composable

fun AboutDialog(title: String?, applicationName: String, modifier: Modifier = Modifier, applicationIcon: String = "", artists: List<String> = emptyList(), comments: String = "", contentHeight: Int = 0, contentWidth: Int = 0, copyright: String = "", debugInfo: String = "", debugInfoFilename: String = "", designers: List<String> = emptyList(), developerName: String = "", developers: List<String> = emptyList(), documenters: List<String> = emptyList(), issueUrl: String = "", followsContentSize: Boolean = false, license: String = "", licenseType: License = License.UNKNOWN, presentationMode: DialogPresentationMode = DialogPresentationMode.AUTO, releaseNotes: String = "", releaseNotesVersion: String = "", supportUrl: String = "", translatorCredits: String = "", version: String = "", website: String = "", onClose: () -> Unit = {}, content: @Composable () -> Unit = {})

Creates a org.gnome.adw.AboutDialog, a standardized dialog for displaying application metadata and credits.

AlertDialog

@Composable

fun AlertDialog(heading: String, body: String, responses: List<AlertDialogResponse>, onResponse: (AlertDialogResponse) -> Unit, onClose: () -> Unit, modifier: Modifier = Modifier, contentHeight: Int = -1, contentWidth: Int = -1, followsContentSize: Boolean = false, presentationMode: DialogPresentationMode = DialogPresentationMode.AUTO, defaultResponse: AlertDialogResponse? = null)

Creates a org.gnome.adw.AlertDialog, a dialog presenting a message or a question.

ApplicationWindow

@Composable

fun ApplicationWindow(title: String?, onClose: () -> Unit, modifier: Modifier = Modifier, styles: List<CssProvider> = emptyList(), decorated: Boolean = true, defaultHeight: Int = 0, defaultWidth: Int = 0, deletable: Boolean = true, fullscreen: Boolean = false, maximized: Boolean = false, handleMenubarAccel: Boolean = true, modal: Boolean = false, resizable: Boolean = true, init: ApplicationWindow.() -> Unit = {}, content: @Composable ApplicationWindowScope.() -> Unit)

Creates a org.gnome.adw.ApplicationWindow, a freeform application window.

Avatar

@Composable

fun Avatar(image: ImageSource?, text: String, modifier: Modifier = Modifier, showInitials: Boolean = false, size: Int = -1)

Creates a org.gnome.adw.Avatar that displays an image, with a generated fallback.

Banner

@Composable

fun Banner(modifier: Modifier = Modifier, title: String? = null, buttonLabel: String? = null, onButtonClick: () -> Unit? = null, revealed: Boolean = true, useMarkup: Boolean = true)

Creates a org.gnome.adw.Banner, a bar with contextual information.

BottomSheet

@Composable

fun BottomSheet(open: Boolean, modifier: Modifier = Modifier, align: Float = 0.5f, canClose: Boolean = true, canOpen: Boolean = true, fullWidth: Boolean = true, modal: Boolean = true, showDragHandle: Boolean = true, onClose: () -> Unit = {}, onOpen: () -> Unit = {}, bottomBar: @Composable () -> Unit = {}, sheet: @Composable () -> Unit = {}, content: @Composable () -> Unit = {})

Creates a org.gnome.adw.BottomSheet which displays a bottom sheet with an optional bottom bar.

ButtonContent

@Composable

fun ButtonContent(label: String, icon: ImageSource.Icon, modifier: Modifier = Modifier, useUnderline: Boolean = false, canShrink: Boolean = false)

Creates a org.gnome.adw.ButtonContent, a container used to display a label and an icon inside buttons.

Carousel

@Composable

fun Carousel(state: CarouselState, modifier: Modifier = Modifier, allowLongSwipes: Boolean = false, allowMouseDrag: Boolean = true, allowScrollWheel: Boolean = true, interactive: Boolean = true, revealDuration: Int = 0, scrollParams: SpringParams = DEFAULT_SPRING_PARAMS, spacing: Int = 0, onPageChange: (Int) -> Unit? = null, content: @Composable (page: Int) -> Unit)

Creates a org.gnome.adw.Carousel, a paginated scrolling widget.

CarouselIndicatorDots

@Composable

fun CarouselIndicatorDots(carouselState: CarouselState, modifier: Modifier = Modifier)

Creates a org.gnome.adw.CarouselIndicatorDots, a dots indicator for Carousel.

CarouselIndicatorLines

@Composable

fun CarouselIndicatorLines(carouselState: CarouselState, modifier: Modifier = Modifier)

Creates a org.gnome.adw.CarouselIndicatorLines, a lines indicator for Carousel.

Clamp

@Composable

fun Clamp(modifier: Modifier = Modifier, orientation: Orientation = Orientation.HORIZONTAL, maximumSize: Int = 600, tighteningThreshold: Int = 400, content: @Composable () -> Unit)

Creates a org.gnome.adw.Clamp that constrains its child to a given size.

Dialog

@Composable

fun Dialog(title: String?, modifier: Modifier = Modifier, contentHeight: Int = 0, contentWidth: Int = 0, followsContentSize: Boolean = false, presentationMode: DialogPresentationMode = DialogPresentationMode.AUTO, onClose: () -> Unit = {}, content: @Composable () -> Unit = {})

Creates a org.gnome.adw.Dialog, an adaptive dialog container.

HeaderBar

@Composable

fun HeaderBar(modifier: Modifier = Modifier, centeringPolicy: CenteringPolicy = CenteringPolicy.LOOSE, showEndTitleButtons: Boolean = true, showStartTitleButtons: Boolean = true, title: @Composable () -> Unit? = null, startWidgets: @Composable () -> Unit = {}, endWidgets: @Composable () -> Unit = {})

Creates a org.gnome.adw.HeaderBar used as a title bar widget.

HorizontalClamp

@Composable

fun HorizontalClamp(modifier: Modifier = Modifier, maximumSize: Int = 600, tighteningThreshold: Int = 400, content: @Composable () -> Unit)

A horizontally oriented Clamp

OverlaySplitView

@Composable

fun OverlaySplitView(sidebar: @Composable () -> Unit, modifier: Modifier = Modifier, collapsed: Boolean = false, pinSidebar: Boolean = false, sidebarPosition: PackType = PackType.START, sidebarWidthFraction: Double = 0.25, enableHideGesture: Boolean = true, enableShowGesture: Boolean = true, content: @Composable OverlaySplitViewScope.() -> Unit)

Creates a org.gnome.adw.OverlaySplitView that presents a sidebar and content side by side or as an overlay.

rememberCarouselState

@Composable

fun rememberCarouselState(pageCount: Int, orientation: Orientation = Orientation.HORIZONTAL): CarouselState

Creates and remembers a CarouselState for controlling a Carousel composable.

StatusPage

@Composable

fun StatusPage(title: String, modifier: Modifier = Modifier, description: String? = null, icon: ImageSource? = null, content: @Composable () -> Unit = {})

Creates a org.gnome.adw.StatusPage used for empty/error states and similar use-cases.

ToastOverlay

@Composable

fun ToastOverlay(modifier: Modifier = Modifier, content: @Composable ToastOverlayScope.() -> Unit)

Creates a org.gnome.adw.ToastOverlay that shows toasts above its content.

ToolbarView

@Composable

fun ToolbarView(modifier: Modifier = Modifier, topBarStyle: ToolbarStyle = ToolbarStyle.FLAT, revealTopBars: Boolean = true, extendContentToTopEdge: Boolean = false, topBar: @Composable () -> Unit = {}, bottomBarStyle: ToolbarStyle = ToolbarStyle.FLAT, revealBottomBars: Boolean = true, extendContentToBottomEdge: Boolean = false, bottomBar: @Composable () -> Unit = {}, content: @Composable () -> Unit)

Creates a org.gnome.adw.ToolbarView that contains a page, as well as top and/or bottom bars.

VerticalClamp

@Composable

fun VerticalClamp(modifier: Modifier = Modifier, maximumSize: Int = 600, tighteningThreshold: Int = 400, content: @Composable () -> Unit)

A vertically oriented Clamp.

WindowTitle

@Composable

fun WindowTitle(title: String, modifier: Modifier = Modifier, subtitle: String? = null)

Creates a org.gnome.adw.WindowTitle that helps to set a window’s title and subtitle.