Interface: AdwBottomSheetProps
Defined in: packages/react/src/generated/jsx.ts:1640
Props for the AdwBottomSheet widget.
Extends
Properties
accessibleActiveDescendant?
optionalaccessibleActiveDescendant:Widget
Defined in: packages/react/src/jsx.ts:1175
Inherited from
WidgetProps.accessibleActiveDescendant
accessibleAutocomplete?
optionalaccessibleAutocomplete:AccessibleAutocomplete
Defined in: packages/react/src/jsx.ts:1144
Inherited from
WidgetProps.accessibleAutocomplete
accessibleBusy?
optionalaccessibleBusy:boolean
Defined in: packages/react/src/jsx.ts:1165
Inherited from
accessibleChecked?
optionalaccessibleChecked:AccessibleTristate
Defined in: packages/react/src/jsx.ts:1166
Inherited from
accessibleColCount?
optionalaccessibleColCount:number
Defined in: packages/react/src/jsx.ts:1176
Inherited from
WidgetProps.accessibleColCount
accessibleColIndex?
optionalaccessibleColIndex:number
Defined in: packages/react/src/jsx.ts:1177
Inherited from
WidgetProps.accessibleColIndex
accessibleColIndexText?
optionalaccessibleColIndexText:string
Defined in: packages/react/src/jsx.ts:1178
Inherited from
WidgetProps.accessibleColIndexText
accessibleColSpan?
optionalaccessibleColSpan:number
Defined in: packages/react/src/jsx.ts:1179
Inherited from
accessibleControls?
optionalaccessibleControls:Widget[]
Defined in: packages/react/src/jsx.ts:1180
Inherited from
WidgetProps.accessibleControls
accessibleDescribedBy?
optionalaccessibleDescribedBy:Widget[]
Defined in: packages/react/src/jsx.ts:1181
Inherited from
WidgetProps.accessibleDescribedBy
accessibleDescription?
optionalaccessibleDescription:string
Defined in: packages/react/src/jsx.ts:1145
Inherited from
WidgetProps.accessibleDescription
accessibleDetails?
optionalaccessibleDetails:Widget[]
Defined in: packages/react/src/jsx.ts:1182
Inherited from
accessibleDisabled?
optionalaccessibleDisabled:boolean
Defined in: packages/react/src/jsx.ts:1167
Inherited from
WidgetProps.accessibleDisabled
accessibleErrorMessage?
optionalaccessibleErrorMessage:Widget[]
Defined in: packages/react/src/jsx.ts:1183
Inherited from
WidgetProps.accessibleErrorMessage
accessibleExpanded?
optionalaccessibleExpanded:boolean
Defined in: packages/react/src/jsx.ts:1168
Inherited from
WidgetProps.accessibleExpanded
accessibleFlowTo?
optionalaccessibleFlowTo:Widget[]
Defined in: packages/react/src/jsx.ts:1184
Inherited from
accessibleHasPopup?
optionalaccessibleHasPopup:boolean
Defined in: packages/react/src/jsx.ts:1146
Inherited from
WidgetProps.accessibleHasPopup
accessibleHelpText?
optionalaccessibleHelpText:string
Defined in: packages/react/src/jsx.ts:1163
Inherited from
WidgetProps.accessibleHelpText
accessibleHidden?
optionalaccessibleHidden:boolean
Defined in: packages/react/src/jsx.ts:1169
Inherited from
accessibleInvalid?
optionalaccessibleInvalid:AccessibleInvalidState
Defined in: packages/react/src/jsx.ts:1170
Inherited from
accessibleKeyShortcuts?
optionalaccessibleKeyShortcuts:string
Defined in: packages/react/src/jsx.ts:1147
Inherited from
WidgetProps.accessibleKeyShortcuts
accessibleLabel?
optionalaccessibleLabel:string
Defined in: packages/react/src/jsx.ts:1148
Inherited from
accessibleLabelledBy?
optionalaccessibleLabelledBy:Widget[]
Defined in: packages/react/src/jsx.ts:1185
Inherited from
WidgetProps.accessibleLabelledBy
accessibleLevel?
optionalaccessibleLevel:number
Defined in: packages/react/src/jsx.ts:1149
Inherited from
accessibleModal?
optionalaccessibleModal:boolean
Defined in: packages/react/src/jsx.ts:1150
Inherited from
accessibleMultiLine?
optionalaccessibleMultiLine:boolean
Defined in: packages/react/src/jsx.ts:1151
Inherited from
WidgetProps.accessibleMultiLine
accessibleMultiSelectable?
optionalaccessibleMultiSelectable:boolean
Defined in: packages/react/src/jsx.ts:1152
Inherited from
WidgetProps.accessibleMultiSelectable
accessibleOrientation?
optionalaccessibleOrientation:Orientation
Defined in: packages/react/src/jsx.ts:1153
Inherited from
WidgetProps.accessibleOrientation
accessibleOwns?
optionalaccessibleOwns:Widget[]
Defined in: packages/react/src/jsx.ts:1186
Inherited from
accessiblePlaceholder?
optionalaccessiblePlaceholder:string
Defined in: packages/react/src/jsx.ts:1154
Inherited from
WidgetProps.accessiblePlaceholder
accessiblePosInSet?
optionalaccessiblePosInSet:number
Defined in: packages/react/src/jsx.ts:1187
Inherited from
WidgetProps.accessiblePosInSet
accessiblePressed?
optionalaccessiblePressed:AccessibleTristate
Defined in: packages/react/src/jsx.ts:1171
Inherited from
accessibleReadOnly?
optionalaccessibleReadOnly:boolean
Defined in: packages/react/src/jsx.ts:1155
Inherited from
WidgetProps.accessibleReadOnly
accessibleRequired?
optionalaccessibleRequired:boolean
Defined in: packages/react/src/jsx.ts:1156
Inherited from
WidgetProps.accessibleRequired
accessibleRole?
optionalaccessibleRole:AccessibleRole
Defined in: packages/react/src/generated/jsx.ts:187
The accessible role of the given GtkAccessible implementation.
The accessible role cannot be changed once set.
Inherited from
accessibleRoleDescription?
optionalaccessibleRoleDescription:string
Defined in: packages/react/src/jsx.ts:1157
Inherited from
WidgetProps.accessibleRoleDescription
accessibleRowCount?
optionalaccessibleRowCount:number
Defined in: packages/react/src/jsx.ts:1188
Inherited from
WidgetProps.accessibleRowCount
accessibleRowIndex?
optionalaccessibleRowIndex:number
Defined in: packages/react/src/jsx.ts:1189
Inherited from
WidgetProps.accessibleRowIndex
accessibleRowIndexText?
optionalaccessibleRowIndexText:string
Defined in: packages/react/src/jsx.ts:1190
Inherited from
WidgetProps.accessibleRowIndexText
accessibleRowSpan?
optionalaccessibleRowSpan:number
Defined in: packages/react/src/jsx.ts:1191
Inherited from
accessibleSelected?
optionalaccessibleSelected:boolean
Defined in: packages/react/src/jsx.ts:1172
Inherited from
WidgetProps.accessibleSelected
accessibleSetSize?
optionalaccessibleSetSize:number
Defined in: packages/react/src/jsx.ts:1192
Inherited from
accessibleSort?
optionalaccessibleSort:AccessibleSort
Defined in: packages/react/src/jsx.ts:1158
Inherited from
accessibleValueMax?
optionalaccessibleValueMax:number
Defined in: packages/react/src/jsx.ts:1159
Inherited from
WidgetProps.accessibleValueMax
accessibleValueMin?
optionalaccessibleValueMin:number
Defined in: packages/react/src/jsx.ts:1160
Inherited from
WidgetProps.accessibleValueMin
accessibleValueNow?
optionalaccessibleValueNow:number
Defined in: packages/react/src/jsx.ts:1161
Inherited from
WidgetProps.accessibleValueNow
accessibleValueText?
optionalaccessibleValueText:string
Defined in: packages/react/src/jsx.ts:1162
Inherited from
WidgetProps.accessibleValueText
accessibleVisited?
optionalaccessibleVisited:boolean
Defined in: packages/react/src/jsx.ts:1173
Inherited from
align?
optionalalign:number
Defined in: packages/react/src/generated/jsx.ts:1649
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.
bottomBar?
optionalbottomBar:Widget|null
Defined in: packages/react/src/generated/jsx.ts:1659
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.
canClose?
optionalcanClose:boolean
Defined in: packages/react/src/generated/jsx.ts:1668
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.
canFocus?
optionalcanFocus:boolean
Defined in: packages/react/src/generated/jsx.ts:24
Whether the widget or any of its descendents can accept the input focus.
This property is meant to be set by widget implementations, typically in their instance init function.
Inherited from
canOpen?
optionalcanOpen:boolean
Defined in: packages/react/src/generated/jsx.ts:1678
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.
canTarget?
optionalcanTarget:boolean
Defined in: packages/react/src/generated/jsx.ts:26
Whether the widget can receive pointer events.
Inherited from
children?
optionalchildren:ReactNode
Defined in: packages/react/src/generated/jsx.ts:314
Children elements (child widgets or event controllers).
Inherited from
content?
optionalcontent:Widget|null
Defined in: packages/react/src/generated/jsx.ts:1684
The content widget.
It's always shown, and the bottom sheet is overlaid over it.
cssClasses?
optionalcssClasses:string[]
Defined in: packages/react/src/generated/jsx.ts:28
A list of css classes applied to this widget.
Inherited from
cssName?
optionalcssName:string
Defined in: packages/react/src/generated/jsx.ts:35
The name of this widget in the CSS tree.
This property is meant to be set by widget implementations, typically in their instance init function.
Inherited from
cursor?
optionalcursor:Cursor|null
Defined in: packages/react/src/generated/jsx.ts:37
The cursor used by widget.
Inherited from
focusable?
optionalfocusable:boolean
Defined in: packages/react/src/generated/jsx.ts:45
Whether this widget itself will accept the input focus.
Inherited from
focusOnClick?
optionalfocusOnClick:boolean
Defined in: packages/react/src/generated/jsx.ts:43
Whether the widget should grab focus when it is clicked with the mouse.
This property is only relevant for widgets that can take focus.
Inherited from
fullWidth?
optionalfullWidth:boolean
Defined in: packages/react/src/generated/jsx.ts:1690
Whether the bottom sheet takes the full width.
When full width, AdwBottomSheet.align is ignored.
halign?
optionalhalign:Align
Defined in: packages/react/src/generated/jsx.ts:47
How to distribute horizontal space if widget gets extra space.
Inherited from
hasTooltip?
optionalhasTooltip:boolean
Defined in: packages/react/src/generated/jsx.ts:56
Enables or disables the emission of the Widget.:query-tooltip
signal on widget.
A true value indicates that widget can have a tooltip, in this case
the widget will be queried using Widget.:query-tooltip to
determine whether it will provide a tooltip or not.
Inherited from
heightRequest?
optionalheightRequest:number
Defined in: packages/react/src/generated/jsx.ts:62
Overrides for height request of the widget.
If this is -1, the natural request will be used.
Inherited from
hexpand?
optionalhexpand:boolean
Defined in: packages/react/src/generated/jsx.ts:64
Whether to expand horizontally.
Inherited from
hexpandSet?
optionalhexpandSet:boolean
Defined in: packages/react/src/generated/jsx.ts:66
Whether to use the hexpand property.
Inherited from
layoutManager?
optionallayoutManager:LayoutManager|null
Defined in: packages/react/src/generated/jsx.ts:74
The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.
This property is meant to be set by widget implementations, typically in their instance init function.
Inherited from
limitEvents?
optionallimitEvents:boolean
Defined in: packages/react/src/generated/jsx.ts:83
Makes this widget act like a modal dialog, with respect to event delivery.
Global event controllers will not handle events with targets inside the widget, unless they are set up to ignore propagation limits. See EventController.set_propagation_limit.
Inherited from
marginBottom?
optionalmarginBottom:number
Defined in: packages/react/src/generated/jsx.ts:91
Margin on bottom side of widget.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Widget.set_size_request for example.
Inherited from
marginEnd?
optionalmarginEnd:number
Defined in: packages/react/src/generated/jsx.ts:102
Margin on end of widget, horizontally.
This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Widget.set_size_request for example.
Inherited from
marginStart?
optionalmarginStart:number
Defined in: packages/react/src/generated/jsx.ts:113
Margin on start of widget, horizontally.
This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Widget.set_size_request for example.
Inherited from
marginTop?
optionalmarginTop:number
Defined in: packages/react/src/generated/jsx.ts:121
Margin on top side of widget.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Widget.set_size_request for example.
Inherited from
modal?
optionalmodal:boolean
Defined in: packages/react/src/generated/jsx.ts:1700
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.
name?
optionalname:string
Defined in: packages/react/src/generated/jsx.ts:123
The name of the widget.
Inherited from
onCloseAttempt?
optionalonCloseAttempt: (self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:1734
Emitted when the close button or shortcut is used while
AdwDialog.can-close is set to FALSE.
onDestroy?
optionalonDestroy: (self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:196
Signals that all holders of a reference to the widget should release the reference that they hold.
May result in finalization of the widget if all references are released.
This signal is not suitable for saving widget state.
Inherited from
onDirectionChanged?
optionalonDirectionChanged: (previousDirection,self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:198
Emitted when the text direction of a widget changes.
Inherited from
WidgetProps.onDirectionChanged
onHide?
optionalonHide: (self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:200
Emitted when widget is hidden.
Inherited from
onKeynavFailed?
optionalonKeynavFailed: (direction,self) =>boolean|null
Defined in: packages/react/src/generated/jsx.ts:206
Emitted if keyboard navigation fails.
See Widget.keynav_failed for details.
Inherited from
onMap?
optionalonMap: (self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:218
Emitted when widget is going to be mapped.
A widget is mapped when the widget is visible (which is controlled with Widget.visible) and all its parents up to the toplevel widget are also visible.
The ::map signal can be used to determine whether a widget will be drawn,
for instance it can resume an animation that was stopped during the
emission of Widget.:unmap.
Inherited from
onMnemonicActivate?
optionalonMnemonicActivate: (groupCycling,self) =>boolean|null
Defined in: packages/react/src/generated/jsx.ts:225
Emitted when a widget is activated via a mnemonic.
The default handler for this signal activates widget if group_cycling
is false, or just makes widget grab focus if group_cycling is true.
Inherited from
WidgetProps.onMnemonicActivate
onMoveFocus?
optionalonMoveFocus: (direction,self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:234
Emitted when the focus is moved.
The ::move-focus signal is a keybinding signal.
The default bindings for this signal are Tab to move forward,
and Shift+Tab to move backward.
Inherited from
onNotify?
optionalonNotify: (pspec,self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:312
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with %G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in ::notify being emitted, even if the new value is the same as the old. If they did pass %G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.
This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:
|[ g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view) ]|
It is important to note that you must use [canonical parameter names]GObjectParamSpec#parameter-names as detail strings for the notify signal.
Inherited from
onQueryTooltip?
optionalonQueryTooltip: (x,y,keyboardMode,tooltip,self) =>boolean|null
Defined in: packages/react/src/generated/jsx.ts:250
Emitted when the widget’s tooltip is about to be shown.
This happens when the Widget.has-tooltip property
is true and the hover timeout has expired with the cursor hovering
above widget; or emitted when widget got focus in keyboard mode.
Using the given coordinates, the signal handler should determine
whether a tooltip should be shown for widget. If this is the case
true should be returned, false otherwise. Note that if keyboard_mode
is true, the values of x and y are undefined and should not be used.
The signal handler is free to manipulate tooltip with the therefore
destined function calls.
Inherited from
onRealize?
optionalonRealize: (self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:259
Emitted when widget is associated with a GdkSurface.
This means that Widget.realize has been called or the widget has been mapped (that is, it is going to be drawn).
Inherited from
onShow?
optionalonShow: (self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:261
Emitted when widget is shown.
Inherited from
onStateFlagsChanged?
optionalonStateFlagsChanged: (flags,self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:267
Emitted when the widget state changes.
See Widget.get_state_flags.
Inherited from
WidgetProps.onStateFlagsChanged
onUnmap?
optionalonUnmap: (self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:277
Emitted when widget is going to be unmapped.
A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.
As ::unmap indicates that a widget will not be shown any longer,
it can be used to, for example, stop an animation on the widget.
Inherited from
onUnrealize?
optionalonUnrealize: (self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:284
Emitted when the GdkSurface associated with widget is destroyed.
This means that Widget.unrealize has been called or the widget has been unmapped (that is, it is going to be hidden).
Inherited from
opacity?
optionalopacity:number
Defined in: packages/react/src/generated/jsx.ts:125
The requested opacity of the widget.
Inherited from
open?
optionalopen:boolean
Defined in: packages/react/src/generated/jsx.ts:1702
Whether the bottom sheet is open.
overflow?
optionaloverflow:Overflow
Defined in: packages/react/src/generated/jsx.ts:132
How content outside the widget's content area is treated.
This property is meant to be set by widget implementations, typically in their instance init function.
Inherited from
receivesDefault?
optionalreceivesDefault:boolean
Defined in: packages/react/src/generated/jsx.ts:134
Whether the widget will receive the default action when it is focused.
Inherited from
ref?
optionalref:Ref<BottomSheet>
Defined in: packages/react/src/generated/jsx.ts:1735
revealBottomBar?
optionalrevealBottomBar:boolean
Defined in: packages/react/src/generated/jsx.ts:1711
Whether to reveal the bottom bar.
The transition will be animated.
See AdwBottomSheet.bottom-bar and AdwBottomSheet.bottom-bar-height.
sensitive?
optionalsensitive:boolean
Defined in: packages/react/src/generated/jsx.ts:136
Whether the widget responds to input.
Inherited from
sheet?
optionalsheet:Widget|null
Defined in: packages/react/src/generated/jsx.ts:1717
The bottom sheet widget.
Only shown when AdwBottomSheet.open is TRUE.
showDragHandle?
optionalshowDragHandle:boolean
Defined in: packages/react/src/generated/jsx.ts:1729
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.
tooltipMarkup?
optionaltooltipMarkup:string|null
Defined in: packages/react/src/generated/jsx.ts:152
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Also see Tooltip.set_markup.
This is a convenience property which will take care of getting the
tooltip shown if the given string is not NULL:
Widget.has-tooltip will automatically be set to true
and there will be taken care of Widget.:query-tooltip in
the default signal handler.
Note that if both Widget.tooltip-text and Widget.tooltip-markup are set, the last one wins.
Inherited from
tooltipText?
optionaltooltipText:string|null
Defined in: packages/react/src/generated/jsx.ts:167
Sets the text of tooltip to be the given string.
Also see Tooltip.set_text.
This is a convenience property which will take care of getting the
tooltip shown if the given string is not NULL:
Widget.has-tooltip will automatically be set to true
and there will be taken care of Widget.:query-tooltip in
the default signal handler.
Note that if both Widget.tooltip-text and Widget.tooltip-markup are set, the last one wins.
Inherited from
valign?
optionalvalign:Align
Defined in: packages/react/src/generated/jsx.ts:169
How to distribute vertical space if widget gets extra space.
Inherited from
vexpand?
optionalvexpand:boolean
Defined in: packages/react/src/generated/jsx.ts:171
Whether to expand vertically.
Inherited from
vexpandSet?
optionalvexpandSet:boolean
Defined in: packages/react/src/generated/jsx.ts:173
Whether to use the vexpand property.
Inherited from
visible?
optionalvisible:boolean
Defined in: packages/react/src/generated/jsx.ts:175
Whether the widget is visible.
Inherited from
widthRequest?
optionalwidthRequest:number
Defined in: packages/react/src/generated/jsx.ts:181
Overrides for width request of the widget.
If this is -1, the natural request will be used.