Type Alias: AdwCarouselProps
AdwCarouselProps =
WidgetProps&object
Defined in: generated/jsx.ts:2214
Props for the AdwCarousel widget.
Type Declaration
| Name | Type | Description | Defined in |
|---|---|---|---|
allowLongSwipes? | boolean | Whether to allow swiping for more than one page at a time. If the value is FALSE, each swipe can only move to the adjacent pages. | generated/jsx.ts:2220 |
allowMouseDrag? | boolean | Sets whether the AdwCarousel can be dragged with mouse pointer. If the value is FALSE, dragging is only available on touch. | generated/jsx.ts:2226 |
allowScrollWheel? | boolean | Whether the widget will respond to scroll wheel events. If the value is FALSE, wheel events will be ignored. | generated/jsx.ts:2232 |
children? | ReactNode | - | generated/jsx.ts:2270 |
interactive? | boolean | Whether the carousel can be navigated. This can be used to temporarily disable the carousel to only allow navigating it in a certain state. | generated/jsx.ts:2239 |
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:2276 |
onPageChanged()? | (self, index) => void | null | This signal is emitted after a page has been changed. It can be used to implement "infinite scrolling" by amending the pages after every scroll. ::: note An empty carousel is indicated by (int)index == -1. | generated/jsx.ts:2269 |
orientation? | Gtk.Orientation | The orientation of the orientable. | generated/jsx.ts:2259 |
ref? | Ref<Adw.Carousel> | - | generated/jsx.ts:2290 |
revealDuration? | number | Page reveal duration, in milliseconds. Reveal duration is used when animating adding or removing pages. | generated/jsx.ts:2245 |
scrollParams? | Adw.SpringParams | Scroll animation spring parameters. The default value is equivalent to: adw_spring_params_new (1, 0.5, 500) | generated/jsx.ts:2255 |
spacing? | number | Spacing between pages in pixels. | generated/jsx.ts:2257 |