Type Alias: AdwBottomSheetProps
AdwBottomSheetProps =
WidgetProps&object
Defined in: generated/jsx.ts:1882
Props for the AdwBottomSheet widget.
Type Declaration
| Name | Type | Description | Defined in |
|---|---|---|---|
align? | number | Horizontal alignment of the bottom sheet. 0 means the bottom sheet is flush with the start edge, 1 means it's flush with the end edge. 0.5 means it's centered. Only used when AdwBottomSheet.full-width is set to FALSE. | generated/jsx.ts:1891 |
bottomBar? | Gtk.Widget | null | The bottom bar widget. Shown when AdwBottomSheet.open is FALSE. When open, morphs into the AdwBottomSheet.sheet. Bottom bar can be temporarily hidden using the AdwBottomSheet.reveal-bottom-bar property. | generated/jsx.ts:1901 |
canClose? | boolean | Whether the bottom sheet can be closed by user. It can be closed via the close button, swiping down, pressing Escape or clicking the content dimming (when modal). Bottom sheet can still be closed using AdwBottomSheet.open. | generated/jsx.ts:1910 |
canOpen? | boolean | Whether the bottom sheet can be opened by user. It can be opened via clicking or swiping up from the bottom bar. Does nothing if AdwBottomSheet.bottom-bar is not set. Bottom sheet can still be opened using AdwBottomSheet.open. | generated/jsx.ts:1920 |
children? | ReactNode | - | generated/jsx.ts:1977 |
content? | Gtk.Widget | null | The content widget. It's always shown, and the bottom sheet is overlaid over it. | generated/jsx.ts:1926 |
fullWidth? | boolean | Whether the bottom sheet takes the full width. When full width, AdwBottomSheet.align is ignored. | generated/jsx.ts:1932 |
modal? | boolean | Whether the bottom sheet is modal. When modal, AdwBottomSheet.content will be dimmed when the bottom sheet is open, and clicking it will close the bottom sheet. It also cannot be focused with keyboard. Otherwise, the content is accessible even when the bottom sheet is open. | generated/jsx.ts:1942 |
onCloseAttempt()? | (self) => void | null | Emitted when the close button or shortcut is used while AdwDialog.can-close is set to FALSE. | generated/jsx.ts:1976 |
onNotify? | (self, propName) => void | null | Called when any property on this widget changes. Param The widget that emitted the notification Param The name of the property that changed (in kebab-case) | generated/jsx.ts:1983 |
open? | boolean | Whether the bottom sheet is open. | generated/jsx.ts:1944 |
ref? | Ref<Adw.BottomSheet> | - | generated/jsx.ts:2000 |
revealBottomBar? | boolean | Whether to reveal the bottom bar. The transition will be animated. See AdwBottomSheet.bottom-bar and AdwBottomSheet.bottom-bar-height. | generated/jsx.ts:1953 |
sheet? | Gtk.Widget | null | The bottom sheet widget. Only shown when AdwBottomSheet.open is TRUE. | generated/jsx.ts:1959 |
showDragHandle? | boolean | Whether to overlay a drag handle in the bottom sheet. The handle will be overlaid over AdwBottomSheet.sheet. When the handle is shown, AdwHeaderBar will hide its default title, and AdwToolbarView will reserve space if there are no top bars. Showing drag handle also allows to swipe the bottom sheet down (and to swipe the bottom bar up) with a pointer, instead of just touchscreen. | generated/jsx.ts:1971 |