Scroll-able panel

Introduction¶

A container with a panel, slider, and scroller.

Author: Rex
Game object

Live demos¶

Usage¶

Sample code

Install plugin¶

Load minify file¶

Load plugin (minify file) in preload stage

scene.load.scenePlugin('rexuiplugin', 'https://raw.githubusercontent.com/rexrainbow/phaser3-rex-notes/master/dist/rexuiplugin.min.js', 'rexUI', 'rexUI');

Add scrollable-panel object

var panel = scene.rexUI.add.scrollablePanel(config);

Import plugin¶

Install rex plugins from npm
```
npm i phaser3-rex-plugins
```

Install plugin in configuration of game

import UIPlugin from 'phaser3-rex-plugins/templates/ui/ui-plugin.js';
var config = {
    // ...
    plugins: {
        scene: [{
            key: 'rexUI',
            plugin: UIPlugin,
            mapping: 'rexUI'
        },
        // ...
        ]
    }
    // ...
};
var game = new Phaser.Game(config);

Add scrollable-panel object

var panel = scene.rexUI.add.scrollablePanel(config);

Import class¶

Install rex plugins from npm
```
npm i phaser3-rex-plugins
```

Import class

import { ScrollablePanel } from 'phaser3-rex-plugins/templates/ui/ui-components.js';

Add scrollable-panel object

var panel = new ScrollablePanel(scene, config);
scene.add.existing(panel);

Add scroll-able panel object¶

var panel = scene.rexUI.add.scrollablePanel({
    // x: 0,
    // y: 0,
    // anchor: undefined,
    // width: undefined,
    // height: undefined,

    scrollMode: 0,

    // Elements
    background: backgroundGameObject,

    panel: {
        child: panelGameObject,
        mask: {
            padding: 0,
            // updateMode: 0,
        }
    }.

    slider: {
        // background: sliderBackgroundGameObject,
        track: trackGameObject,
        thumb: thumbGameObject,
        // input: 'drag',
        // position: 'right',
        // adaptThumbSize: false,
        // minThumbSize: undefined,

        // buttons: {
        //     top: topButtonGameObject, 
        //     bottom: bottomButtonGameObject,
        //     left: leftButtonGameObject, 
        //     right: rightButtonGameObject,
        //     step: 0.01,
        // }
    },

    scroller: {
        threshold: 10,
        slidingDeceleration: 5000,
        backDeceleration: 2000,
        pointerOutRelease: true,
    },

    mouseWheelScroller: false,
    // mouseWheelScroller: {
    //     focus: false,
    //     speed: 0.1
    // },

    clamplChildOY: false,

    header: headerGameObject,
    footer: footerGameObject,

    space: {
        left: 0,
        right: 0,
        top: 0,
        bottom: 0,

        panel: 0,
        // panel: {
        //    top: 0,
        //    bottom: 0,
        //    left: 0,
        //    right: 0,
        //},

        slider: 0,
        // slider: {
        //     top: 0,
        //     bottom: 0,
        //     left: 0,
        //     right: 0,
        // },

        header: 0,
        footer: 0,
    },

    expand: {
        header: true,
        footer: true,
    },

    align: {
        header: 'center',
        footer: 'center',
    },

    // name: '',
    // draggable: false,
    // enableLayer: false,
});

x, y : Position of this object, it is valid when this object is the top object.
anchor : See anchor.
- left, right, centerX, x, top, bottom, centerY, y : Position based on visible window, which composed of
  - Percentage of visible width/height : 'p%', p: 0 ~ 100.
    - 'left'(=0%), 'center'(=50%), 'right'(=100%)
    - 'top'(=0%), 'center'(=50%), 'bottom'(=100%)
  - Offset : '+n', or '-n'.
- width, height : Set size (invoke onResizeCallback) based on visible window, which composed of
  - Percentage of visible width/height : 'p%', p: 0 ~ 100.
  - Padding : '+n', or '-n'.
- onResizeCallback : A default resize callback will be assigned interanlly.
width, height : Minimum width, minimum height.
scrollMode : Scroll panel vertically, or horizontally.
- 0, 'vertical', or 'v' : Scroll panel vertically. Default value.
- 1, 'horizontal', or 'h' : Scroll panel horizontally.
background : Game object of background, optional. This background game object will be resized to fit the size of scroll-able panel.
panel : Configuration of panel game object.
- panel.child : Panel game object.
- panel.mask : Configuration of panel's mask.
  - panel.mask.padding : Extra left/right/top/bottom padding spacing of this rectangle mask. Default value is 0.
  - panel.mask.updateMode : When to update mask
    - 0, or 'update' : Apply mask only when scrolling. Default behavior.
    - 1, or 'everyTick' : Apply mask every tick. Use this mode if children game objects of panel are moved after scrolling and still been masked.
  - false : No mask
slider : Componments of slider, optional.
- slider.background : Game object of slider background, optional.
- slider.track : Game object of track.
- slider.thumb : Game object of thumb.
- slider.input :
  - 'pan', 'drag', or 0 : Control slider by panning/dragging thumb game object. Default setting.
  - 'click', or 1 : Control slider by touching track game object.
  - 'none', or -1 : Disable sider controlling.
- slider.position : Position of this sldier.
  - 0, 'right', 'bottom' : Sldier at right/bottom side. Default value.
  - 1, 'left', 'top' : Sldier at left/top side.
- slider.adaptThumbSize :
  - false : Don't adjust height/width of thumb. Default behavior.
  - true : Adjust height/width of thumb according to ratio of visible child.
    - Minimum height/width of thumb = slider.minThumbSize. If content is larger then a page.
    - Maximum height/width of thumb = height/width of slider.track. If content is less then a page.
- slider.minThumbSize : Minimum height/width of thumb used in slider.adaptThumbSize mode.
- slider.buttons : Press button to scroll content in each tick.
  - slider.buttons.top, slider.buttons.bottom : Top and bottom buttons.
  - slider.buttons.left, slider.buttons.right : Left and right buttons
  - slider.buttons.step : Scrolling step in each tick. Default value is 0.01.
- Set to false to skip creating slider.
scroller : Configuration of scroller behavior.
- scroller.threshold : Minimal movement to scroll. Set 0 to scroll immediately.
- scroller.slidingDeceleration : Deceleration of slow down when dragging released.
  - Set false to disable it.
- scroller.backDeceleration : Deceleration of pull back when out of bounds.
  - Set false to disable it.
- scroller.pointerOutRelease : Set to true to release input control when pointer out of gameObject.
- Set to false to skip creating scroller.
mouseWheelScroller : Configuration of mouse-wheel-scroller behavior.
- mouseWheelScroller.focus :
  - true : Only scrolling when cursor is over panel.
  - false : Scrolling without checking cursor. Default behavior.
- mouseWheelScroller.speed : Scrolling speed, default value is 0.1.
- Set to false to skip creating mouse-wheel-scroller. Default behavior.
clamplChildOY : Set true to clamp scrolling.
header : Game object of header, optional.
footer : Game object of footer, optional.
space : Pads spaces
- space.left, space.right, space.top, space.bottom : Space of bounds.
- space.panel :
  - A number: Space between panel object and slider object.
  - An object: Padding of panel object.
    - If scrollMode is 0 (vertical) :
      - space.panel.top, space.panel.bottom : Top, bottom padding space of panel object.
      - space.panel.right : Space between panel object and slider object.
    - If scrollMode is 1 (horizontal) :
      - space.panel.left, space.panel.right : Left, right padding space of panel object.
      - space.panel.bottom : Space between panel object and slider object.
- space.slider :
  - 0 : No space around slider.
  - space.slider.left, space.slider.right, space.slider.top, space.slider.bottom : Space around slider.
- space.header : Space between header and panel.
- space.footer : Space between footer and panel.
expand : Expand width or height of element
- expand.header : Set true to expand width or height of header game object.
- expand.footer : Set true to expand width or height of footer game object.
align : Align element
- align.header
  - 'center', or Phaser.Display.Align.CENTER : Align game object at center. Default value.
  - 'left', or Phaser.Display.Align.LEFT_CENTER : Align game object at left-center.
  - 'right', or Phaser.Display.Align.RIGHT_CENTER : Align game object at right-center.
- align.footer
name : Set name of this game object.
draggable : Set true to drag top-most object.
sizerEvents : Set true to fire sizer events. Default value is false.

Child bounds¶

Scrollable panel will mask child if child's bounds (child.getBounds()) is across mask area.

Bitmaptext game object does not have getBounds method. User can inject it by

const Components = Phaser.GameObjects.Components;
Phaser.Class.mixin(
    Phaser.GameObjects.BitmapText,
    [
        Components.ComputedSize,
        Components.GetBounds
    ]
);

Custom class¶

Define class

class MyPanel extends RexPlugins.UI.ScrollablePanel {
    constructor(scene, config) {
        super(scene, config);
        // ...
        scene.add.existing(this);
    }
    // ...
}

Create instance

var panel = new MyPanel(scene, config);

Layout children¶

Arrange position of all elements.

panel.layout();

Scroll content¶

Set

panel.childOY = oy;
// panel.setChildOY(oy);

Set and clamp
```
panel.setChildOY(oy, true);
```
Add
```
panel.addChildOY(oy);
```
Add and clamp
```
panel.addChildOY(oy, true);
```
Get
```
var childOY = panel.childOY;
```
Top OY
```
var topOY = panel.topChildOY;
```
Bottom OY
```
var bottomOY = panel.bottomChildOY;
```
Is overflow (height of content is larger than display height)
```
var isOverflow = panel.isOverflow;
```

Scroll by percentage¶

Set

panel.t = t;  // t: 0~1
// panel.setT(t);

Set and clamp
```
panel.setT(t, true);
```
Get
```
var t = panel.t;
```

Scroll to top/bottom¶

Scroll to top
```
panel.scrollToTop();
```
- Equal to panel.t = 0;
Scroll to bottom
```
panel.scrollToBottom();
```
- Equal to panel.t = 1;

Enable/disable scrolling¶

Slider

Set enable state

panel.setSliderEnable(enabled);

or

panel.sliderEnable = enabled;

Get enable state
```
var enable = panel.sliderEnable;
```

Scroller

Set enable state

panel.setScrollerEnable(enabled);

or

panel.scrollerEnable = enabled;

Get enable state
```
var enable = panel.scrollerEnable;
```

Event¶

Scroll

panel.on('scroll', function(panel) {
    // ...
})

Scroller drag start

panel.getElement('scroller').on('dragstart', function(panel) {
    // ...
})

Scroller drag end

panel.getElement('scroller').on('dragend', function(panel) {
    // ...
})

Other properties¶

See sizer object, base sizer object.

Get element¶

Get element

Background game object

var background = panel.getElement('background');

Panel game object
```
var panel = panel.getElement('panel');
```
Layer of panel, assigned at config panel.mask.layer.
```
var layer = panel.getElement('panelLayer');
```

Slider

Track

var track = panel.getElement('slider.track');

Thumb

var thumb = panel.getElement('slider.thumb');

Scroller

var scroller = panel.getElement('scroller');

Get by name

var gameObject = panel.getElement('#' + name);
// var gameObject = panel.getElement('#' + name, recursive);

or

var gameObject = panel.getByName(name);
// var gameObject = panel.getByName(name, recursive);

recursive : Set true to search all children recursively.

Input events¶

Two possible solution to register input events to children of scrollable panel.

Set children interactive¶

Applies click, tap, press, swipe behaviors on this scrollable panel, to detect input events of children.

panel.setChildrenInteractive({
    targets: targetSizers,

    // click: {mode: 'release', clickInterval: 100},

    // over: undefined,

    // press: {time: 251, threshold: 9},

    // tap: {time: 250, tapInterval: 200, threshold: 9, tapOffset: 10, 
    //       taps: undefined, minTaps: undefined, maxTaps: undefined,},

    // swipe: {threshold: 10, velocityThreshold: 1000, dir: '8dir'},

    // inputEventPrefix: 'child.',
})

targetSizers : Array of target children-sizer.
click : Configuration of Button behavior.
- false : Don't install Button behavior.
over :
- false : Don't fire over/out events
press : Configuration of Press behavior.
- false : Don't install Press behavior.
tap : Configuration of Tap behavior.
- false : Don't install Tap behavior.
swipe : Configuration of Swipe behavior.
- false : Don't install Swipe behavior.
inputEventPrefix : Prefix string of each event, default is 'child.'.

Events¶

See Base-sizer

Individual input events¶

When scene.input.topOnly is true (default value), input events of children elements will block the drag-scrolling of scrollable panel. (Assmue that the children elememts are above scrollable panel)

Set scene.input.topOnly to false to enable drag-scrolling and input events of children elememts both.
Test if pointer is under panel via panel.isInTouching(), during input events' callback.
To recognize pointer-down and dragging-start, use press's pressstart event.