Skip to content

PageControl

Overview

An iOS-style page control. See the 'Navigation' section of the iOS Human Interface Guidelines. A page control indicates the number of pages and which one is currently visible.

@author Chris Malley (PixelZoom, Inc.)

Class PageControl

import { PageControl } from 'scenerystack/sun';

Constructor

new PageControl( pageNumberProperty : TProperty<number>, numberOfPagesProperty : TReadOnlyProperty<number>, providedOptions? : PageControlOptions )

Instance Methods

dispose()

Type PageControlOptions

import type { PageControlOptions } from 'scenerystack/sun';
  • interactive?: boolean
  • orientation?: LayoutOrientation
  • dotRadius?: number
  • lineWidth?: number
  • dotSpacing?: number
  • dotTouchAreaDilation?: number
  • dotMouseAreaDilation?: number
  • currentPageFill?: TPaint
    dots representing the current page
  • currentPageStroke?: TPaint
  • pageFill?: TPaint
    dots representing all pages except the current page
  • pageStroke?: TPaint
  • & StrictOmit<NodeOptions, "children">

Source Code

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