Skip to content

CarouselButton

Under Construction

This documentation is auto-generated, and is a work in progress. Please see the source code at https://github.com/phetsims/sun/blob/main/js/buttons/CarouselButton.ts for the most up-to-date information.

Overview

Next/previous button in a Carousel.

@author Chris Malley (PixelZoom, Inc.)

Class CarouselButton

import { CarouselButton } from 'scenerystack/sun';

Constructor

new CarouselButton( providedOptions? : CarouselButtonOptions )

Instance Methods

dispose()

Type CarouselButtonOptions

import type { CarouselButtonOptions } from 'scenerystack/sun';
  • arrowPathOptions?: PathOptions
  • arrowDirection?: ArrowDirection
  • arrowSize?: Dimension2
  • & StrictOmit<RectangularPushButtonOptions, "content" | "leftTopCornerRadius" | "rightTopCornerRadius" | "leftBottomCornerRadius" | "rightBottomCornerRadius" | "touchAreaXShift" | "touchAreaYShift" | "mouseAreaXShift" | "mouseAreaYShift">

Source Code

See the source for CarouselButton.ts in the sun repository.