/**
@license
Copyright (c) 2016 The Polymer Project Authors. All rights reserved.
This code may only be used under the BSD style license found at
http://polymer.github.io/LICENSE.txt The complete set of authors may be found at
http://polymer.github.io/AUTHORS.txt The complete set of contributors may be
found at http://polymer.github.io/CONTRIBUTORS.txt Code distributed by Google as
part of the polymer project is also subject to an additional IP rights grant
found at http://polymer.github.io/PATENTS.txt
*/
import '../polymer/polymer_bundled.min.js';
import '../iron-a11y-keys-behavior/iron-a11y-keys-behavior.js';
import {IronResizableBehavior} from '../iron-resizable-behavior/iron-resizable-behavior.js';
import {IronScrollTargetBehavior} from '../iron-scroll-target-behavior/iron-scroll-target-behavior.js';
import {OptionalMutableDataBehavior} from '../polymer/polymer_bundled.min.js';
import {Polymer as Polymer} from '../polymer/polymer_bundled.min.js';
import {dom} from '../polymer/polymer_bundled.min.js';
import {Templatizer} from '../polymer/polymer_bundled.min.js';
import {animationFrame, idlePeriod, microTask} from '../polymer/polymer_bundled.min.js';
import {Debouncer} from '../polymer/polymer_bundled.min.js';
import {enqueueDebouncer, flush} from '../polymer/polymer_bundled.min.js';
import {html} from '../polymer/polymer_bundled.min.js';
import {matches, translate} from '../polymer/polymer_bundled.min.js';
import {TemplateInstanceBase} from '../polymer/polymer_bundled.min.js';
var IOS = navigator.userAgent.match(/iP(?:hone|ad;(?: U;)? CPU) OS (\d+)/);
var IOS_TOUCH_SCROLLING = IOS && IOS[1] >= 8;
var DEFAULT_PHYSICAL_COUNT = 3;
var HIDDEN_Y = '-10000px';
var SECRET_TABINDEX = -100;
/**
`iron-list` displays a virtual, 'infinite' list. The template inside
the iron-list element represents the DOM to create for each list item.
The `items` property specifies an array of list item data.
For performance reasons, not every item in the list is rendered at once;
instead a small subset of actual template elements *(enough to fill the
viewport)* are rendered and reused as the user scrolls. As such, it is important
that all state of the list template is bound to the model driving it, since the
view may be reused with a new model at any time. Particularly, any state that
may change as the result of a user interaction with the list item must be bound
to the model to avoid view state inconsistency.
### Sizing iron-list
`iron-list` must either be explicitly sized, or delegate scrolling to an
explicitly sized parent. By "explicitly sized", we mean it either has an
explicit CSS `height` property set via a class or inline style, or else is sized
by other layout means (e.g. the `flex` or `fit` classes).
#### Flexbox - [jsbin](https://jsbin.com/vejoni/edit?html,output)
```html
<template is="x-list">
<style>
:host {
display: block;
height: 100vh;
display: flex;
flex-direction: column;
}
iron-list {
flex: 1 1 auto;
}
</style>
<app-toolbar>App name</app-toolbar>
<iron-list items="[[items]]">
<template>
<div>
...
</div>
</template>
</iron-list>
</template>
```
#### Explicit size - [jsbin](https://jsbin.com/vopucus/edit?html,output)
```html
<template is="x-list">
<style>
:host {
display: block;
}
iron-list {
height: 100vh; /* don't use % values unless the parent element is sized.
*\/
}
</style>
<iron-list items="[[items]]">
<template>
<div>
...
</div>
</template>
</iron-list>
</template>
```
#### Main document scrolling -
[jsbin](https://jsbin.com/wevirow/edit?html,output)
```html
<head>
<style>
body {
height: 100vh;
margin: 0;
display: flex;
flex-direction: column;
}
app-toolbar {
position: fixed;
top: 0;
left: 0;
right: 0;
}
iron-list {
/* add padding since the app-toolbar is fixed at the top *\/
padding-top: 64px;
}
</style>
</head>
<body>
<app-toolbar>App name</app-toolbar>
<iron-list scroll-target="document">
<template>
<div>
...
</div>
</template>
</iron-list>
</body>
```
`iron-list` must be given a `<template>` which contains exactly one element. In
the examples above we used a `<div>`, but you can provide any element (including
custom elements).
### Template model
List item templates should bind to template models of the following structure:
```js
{
index: 0, // index in the item array
selected: false, // true if the current item is selected
tabIndex: -1, // a dynamically generated tabIndex for focus management
item: {} // user data corresponding to items[index]
}
```
Alternatively, you can change the property name used as data index by changing
the `indexAs` property. The `as` property defines the name of the variable to
add to the binding scope for the array.
For example, given the following `data` array:
##### data.json
```js
[
{"name": "Bob"},
{"name": "Tim"},
{"name": "Mike"}
]
```
The following code would render the list (note the name property is bound from
the model object provided to the template scope):
```html
<iron-ajax url="data.json" last-response="{{data}}" auto></iron-ajax>
<iron-list items="[[data]]" as="item">
<template>
<div>
Name: [[item.name]]
</div>
</template>
</iron-list>
```
### Grid layout
`iron-list` supports a grid layout in addition to linear layout by setting
the `grid` attribute. In this case, the list template item must have both fixed
width and height (e.g. via CSS). Based on this, the number of items
per row are determined automatically based on the size of the list viewport.
### Accessibility
`iron-list` automatically manages the focus state for the items. It also
provides a `tabIndex` property within the template scope that can be used for
keyboard navigation. For example, users can press the up and down keys to move
to previous and next items in the list:
```html
<iron-list items="[[data]]" as="item">
<template>
<div tabindex$="[[tabIndex]]">
Name: [[item.name]]
</div>
</template>
</iron-list>
```
### Resizing
`iron-list` lays out the items when it receives a notification via the
`iron-resize` event. This event is fired by any element that implements
`IronResizableBehavior`.
By default, elements such as `iron-pages`, `paper-tabs` or `paper-dialog` will
trigger this event automatically. If you hide the list manually (e.g. you use
`display: none`) you might want to implement `IronResizableBehavior` or fire
this event manually right after the list became visible again. For example:
```js
document.querySelector('iron-list').fire('iron-resize');
```
### When should `<iron-list>` be used?
`iron-list` should be used when a page has significantly more DOM nodes than the
ones visible on the screen. e.g. the page has 500 nodes, but only 20 are visible
at a time. This is why we refer to it as a `virtual` list. In this case, a
`dom-repeat` will still create 500 nodes which could slow down the web app, but
`iron-list` will only create 20.
However, having an `iron-list` does not mean that you can load all the data at
once. Say you have a million records in the database, you want to split the data
into pages so you can bring in a page at the time. The page could contain 500
items, and iron-list will only render 20.
@element iron-list
@demo demo/index.html
*/
Polymer({
/** @override */
_template: html`
<style>
:host {
display: block;
}
@media only screen and (-webkit-max-device-pixel-ratio: 1) {
:host {
will-change: transform;
}
}
#items {
position: relative;
}
:host(:not([grid])) #items > ::slotted(*) {
width: 100%;
}
#items > ::slotted(*) {
box-sizing: border-box;
margin: 0;
position: absolute;
top: 0;
will-change: transform;
}
</style>
<array-selector id="selector" items="{{items}}" selected="{{selectedItems}}" selected-item="{{selectedItem}}"></array-selector>
<div id="items">
<slot></slot>
</div>
`,
is: 'iron-list',
properties: {
/**
* An array containing items determining how many instances of the template
* to stamp and that that each template instance should bind to.
*/
items: {type: Array},
/**
* The name of the variable to add to the binding scope for the array
* element associated with a given template instance.
*/
as: {type: String, value: 'item'},
/**
* The name of the variable to add to the binding scope with the index
* for the row.
*/
indexAs: {type: String, value: 'index'},
/**
* The name of the variable to add to the binding scope to indicate
* if the row is selected.
*/
selectedAs: {type: String, value: 'selected'},
/**
* When true, the list is rendered as a grid. Grid items must have
* fixed width and height set via CSS. e.g.
*
* ```html
* <iron-list grid>
* <template>
* <div style="width: 100px; height: 100px;"> 100x100 </div>
* </template>
* </iron-list>
* ```
*/
grid: {
type: Boolean,
value: false,
reflectToAttribute: true,
observer: '_gridChanged'
},
/**
* When true, tapping a row will select the item, placing its data model
* in the set of selected items retrievable via the selection property.
*
* Note that tapping focusable elements within the list item will not
* result in selection, since they are presumed to have their * own action.
*/
selectionEnabled: {type: Boolean, value: false},
/**
* When `multiSelection` is false, this is the currently selected item, or
* `null` if no item is selected.
*/
selectedItem: {type: Object, notify: true},
/**
* When `multiSelection` is true, this is an array that contains the
* selected items.
*/
selectedItems: {type: Object, notify: true},
/**
* When `true`, multiple items may be selected at once (in this case,
* `selected` is an array of currently selected items). When `false`,
* only one item may be selected at a time.
*/
multiSelection: {type: Boolean, value: false},
/**
* The offset top from the scrolling element to the iron-list element.
* This value can be computed using the position returned by
* `getBoundingClientRect()` although it's preferred to use a constant value
* when possible.
*
* This property is useful when an external scrolling element is used and
* there's some offset between the scrolling element and the list. For
* example: a header is placed above the list.
*/
scrollOffset: {type: Number, value: 0},
/**
* If set to true, focus on an element will be preserved after rerender.
*/
preserveFocus: {
type: Boolean,
value: false
}
},
observers: [
'_itemsChanged(items.*)',
'_selectionEnabledChanged(selectionEnabled)',
'_multiSelectionChanged(multiSelection)',
'_setOverflow(scrollTarget, scrollOffset)'
],
behaviors: [
Templatizer,
IronResizableBehavior,
IronScrollTargetBehavior,
OptionalMutableDataBehavior
],
/**
* The ratio of hidden tiles that should remain in the scroll direction.
* Recommended value ~0.5, so it will distribute tiles evenly in both
* directions.
*/
_ratio: 0.5,
/**
* The padding-top value for the list.
*/
_scrollerPaddingTop: 0,
/**
* This value is a cached value of `scrollTop` from the last `scroll` event.
*/
_scrollPosition: 0,
/**
* The sum of the heights of all the tiles in the DOM.
*/
_physicalSize: 0,
/**
* The average `offsetHeight` of the tiles observed till now.
*/
_physicalAverage: 0,
/**
* The number of tiles which `offsetHeight` > 0 observed until now.
*/
_physicalAverageCount: 0,
/**
* The Y position of the item rendered in the `_physicalStart`
* tile relative to the scrolling list.
*/
_physicalTop: 0,
/**
* The number of items in the list.
*/
_virtualCount: 0,
/**
* The estimated scroll height based on `_physicalAverage`
*/
_estScrollHeight: 0,
/**
* The scroll height of the dom node
*/
_scrollHeight: 0,
/**
* The height of the list. This is referred as the viewport in the context of
* list.
*/
_viewportHeight: 0,
/**
* The width of the list. This is referred as the viewport in the context of
* list.
*/
_viewportWidth: 0,
/**
* An array of DOM nodes that are currently in the tree
* @type {?Array<!HTMLElement>}
*/
_physicalItems: null,
/**
* An array of heights for each item in `_physicalItems`
* @type {?Array<number>}
*/
_physicalSizes: null,
/**
* A cached value for the first visible index.
* See `firstVisibleIndex`
* @type {?number}
*/
_firstVisibleIndexVal: null,
/**
* A cached value for the last visible index.
* See `lastVisibleIndex`
* @type {?number}
*/
_lastVisibleIndexVal: null,
/**
* The max number of pages to render. One page is equivalent to the height of
* the list.
*/
_maxPages: 2,
/**
* The currently focused physical item.
*/
_focusedItem: null,
/**
* The virtual index of the focused item.
*/
_focusedVirtualIndex: -1,
/**
* The physical index of the focused item.
*/
_focusedPhysicalIndex: -1,
/**
* The the item that is focused if it is moved offscreen.
* @private {?HTMLElement}
*/
_offscreenFocusedItem: null,
/**
* The item that backfills the `_offscreenFocusedItem` in the physical items
* list when that item is moved offscreen.
* @type {?HTMLElement}
*/
_focusBackfillItem: null,
/**
* The maximum items per row
*/
_itemsPerRow: 1,
/**
* The width of each grid item
*/
_itemWidth: 0,
/**
* The height of the row in grid layout.
*/
_rowHeight: 0,
/**
* The cost of stamping a template in ms.
*/
_templateCost: 0,
/**
* Needed to pass event.model property to declarative event handlers -
* see polymer/polymer#4339.
*/
_parentModel: true,
/**
* The bottom of the physical content.
*/
get _physicalBottom() {
return this._physicalTop + this._physicalSize;
},
/**
* The bottom of the scroll.
*/
get _scrollBottom() {
return this._scrollPosition + this._viewportHeight;
},
/**
* The n-th item rendered in the last physical item.
*/
get _virtualEnd() {
return this._virtualStart + this._physicalCount - 1;
},
/**
* The height of the physical content that isn't on the screen.
*/
get _hiddenContentSize() {
var size =
this.grid ? this._physicalRows * this._rowHeight : this._physicalSize;
return size - this._viewportHeight;
},
/**
* The parent node for the _userTemplate.
*/
get _itemsParent() {
return dom(dom(this._userTemplate).parentNode);
},
/**
* The maximum scroll top value.
*/
get _maxScrollTop() {
return this._estScrollHeight - this._viewportHeight + this._scrollOffset;
},
/**
* The largest n-th value for an item such that it can be rendered in
* `_physicalStart`.
*/
get _maxVirtualStart() {
var virtualCount = this._convertIndexToCompleteRow(this._virtualCount);
return Math.max(0, virtualCount - this._physicalCount);
},
set _virtualStart(val) {
val = this._clamp(val, 0, this._maxVirtualStart);
if (this.grid) {
val = val - (val % this._itemsPerRow);
}
this._virtualStartVal = val;
},
get _virtualStart() {
return this._virtualStartVal || 0;
},
/**
* The k-th tile that is at the top of the scrolling list.
*/
set _physicalStart(val) {
val = val % this._physicalCount;
if (val < 0) {
val = this._physicalCount + val;
}
if (this.grid) {
val = val - (val % this._itemsPerRow);
}
this._physicalStartVal = val;
},
get _physicalStart() {
return this._physicalStartVal || 0;
},
/**
* The k-th tile that is at the bottom of the scrolling list.
*/
get _physicalEnd() {
return (this._physicalStart + this._physicalCount - 1) %
this._physicalCount;
},
set _physicalCount(val) {
this._physicalCountVal = val;
},
get _physicalCount() {
return this._physicalCountVal || 0;
},
/**
* An optimal physical size such that we will have enough physical items
* to fill up the viewport and recycle when the user scrolls.
*
* This default value assumes that we will at least have the equivalent
* to a viewport of physical items above and below the user's viewport.
*/
get _optPhysicalSize() {
return this._viewportHeight === 0 ? Infinity :
this._viewportHeight * this._maxPages;
},
/**
* True if the current list is visible.
*/
get _isVisible() {
return Boolean(this.offsetWidth || this.offsetHeight);
},
/**
* Gets the index of the first visible item in the viewport.
*
* @type {number}
*/
get firstVisibleIndex() {
var idx = this._firstVisibleIndexVal;
if (idx == null) {
var physicalOffset = this._physicalTop + this._scrollOffset;
idx = this._iterateItems(function(pidx, vidx) {
physicalOffset += this._getPhysicalSizeIncrement(pidx);
if (physicalOffset > this._scrollPosition) {
return this.grid ? vidx - (vidx % this._itemsPerRow) : vidx;
}
// Handle a partially rendered final row in grid mode
if (this.grid && this._virtualCount - 1 === vidx) {
return vidx - (vidx % this._itemsPerRow);
}
}) ||
0;
this._firstVisibleIndexVal = idx;
}
return idx;
},
/**
* Gets the index of the last visible item in the viewport.
*
* @type {number}
*/
get lastVisibleIndex() {
var idx = this._lastVisibleIndexVal;
if (idx == null) {
if (this.grid) {
idx = Math.min(
this._virtualCount,
this.firstVisibleIndex + this._estRowsInView * this._itemsPerRow -
1);
} else {
var physicalOffset = this._physicalTop + this._scrollOffset;
this._iterateItems(function(pidx, vidx) {
if (physicalOffset < this._scrollBottom) {
idx = vidx;
}
physicalOffset += this._getPhysicalSizeIncrement(pidx);
});
}
this._lastVisibleIndexVal = idx;
}
return idx;
},
get _defaultScrollTarget() {
return this;
},
get _virtualRowCount() {
return Math.ceil(this._virtualCount / this._itemsPerRow);
},
get _estRowsInView() {
return Math.ceil(this._viewportHeight / this._rowHeight);
},
get _physicalRows() {
return Math.ceil(this._physicalCount / this._itemsPerRow);
},
get _scrollOffset() {
return this._scrollerPaddingTop + this.scrollOffset;
},
/** @override */
ready: function() {
this.addEventListener('focus', this._didFocus.bind(this), true);
},
/** @override */
attached: function() {
this._debounce('_render', this._render, animationFrame);
// `iron-resize` is fired when the list is attached if the event is added
// before attached causing unnecessary work.
this.listen(this, 'iron-resize', '_resizeHandler');
this.listen(this, 'keydown', '_keydownHandler');
},
/** @override */
detached: function() {
this.unlisten(this, 'iron-resize', '_resizeHandler');
this.unlisten(this, 'keydown', '_keydownHandler');
},
/**
* Set the overflow property if this element has its own scrolling region
*/
_setOverflow: function(scrollTarget) {
this.style.webkitOverflowScrolling = scrollTarget === this ? 'touch' : '';
this.style.overflowY = scrollTarget === this ? 'auto' : '';
// Clear cache.
this._lastVisibleIndexVal = null;
this._firstVisibleIndexVal = null;
this._debounce('_render', this._render, animationFrame);
},
/**
* Invoke this method if you dynamically update the viewport's
* size or CSS padding.
*
* @method updateViewportBoundaries
*/
updateViewportBoundaries: function() {
var styles = window.getComputedStyle(this);
this._scrollerPaddingTop =
this.scrollTarget === this ? 0 : parseInt(styles['padding-top'], 10);
this._isRTL = Boolean(styles.direction === 'rtl');
this._viewportWidth = this.$.items.offsetWidth;
this._viewportHeight = this._scrollTargetHeight;
this.grid && this._updateGridMetrics();
},
/**
* Recycles the physical items when needed.
*/
_scrollHandler: function() {
var scrollTop = Math.max(0, Math.min(this._maxScrollTop, this._scrollTop));
var delta = scrollTop - this._scrollPosition;
var isScrollingDown = delta >= 0;
// Track the current scroll position.
this._scrollPosition = scrollTop;
// Clear indexes for first and last visible indexes.
this._firstVisibleIndexVal = null;
this._lastVisibleIndexVal = null;
// Random access.
if (Math.abs(delta) > this._physicalSize && this._physicalSize > 0) {
delta = delta - this._scrollOffset;
var idxAdjustment =
Math.round(delta / this._physicalAverage) * this._itemsPerRow;
this._virtualStart = this._virtualStart + idxAdjustment;
this._physicalStart = this._physicalStart + idxAdjustment;
// Estimate new physical offset based on the virtual start index.
// adjusts the physical start position to stay in sync with the clamped
// virtual start index. It's critical not to let this value be
// more than the scroll position however, since that would result in
// the physical items not covering the viewport, and leading to
// _increasePoolIfNeeded to run away creating items to try to fill it.
this._physicalTop = Math.min(
Math.floor(this._virtualStart / this._itemsPerRow) *
this._physicalAverage,
this._scrollPosition);
this._update();
} else if (this._physicalCount > 0) {
var reusables = this._getReusables(isScrollingDown);
if (isScrollingDown) {
this._physicalTop = reusables.physicalTop;
this._virtualStart = this._virtualStart + reusables.indexes.length;
this._physicalStart = this._physicalStart + reusables.indexes.length;
} else {
this._virtualStart = this._virtualStart - reusables.indexes.length;
this._physicalStart = this._physicalStart - reusables.indexes.length;
}
this._update(
reusables.indexes, isScrollingDown ? null : reusables.indexes);
this._debounce(
'_increasePoolIfNeeded',
this._increasePoolIfNeeded.bind(this, 0),
microTask);
}
},
/**
* Returns an object that contains the indexes of the physical items
* that might be reused and the physicalTop.
*
* @param {boolean} fromTop If the potential reusable items are above the scrolling region.
*/
_getReusables: function(fromTop) {
var ith, lastIth, offsetContent, physicalItemHeight;
var idxs = [];
var protectedOffsetContent = this._hiddenContentSize * this._ratio;
var virtualStart = this._virtualStart;
var virtualEnd = this._virtualEnd;
var physicalCount = this._physicalCount;
var top = this._physicalTop + this._scrollOffset;
var bottom = this._physicalBottom + this._scrollOffset;
// This may be called outside of a scrollHandler, so use last cached position
var scrollTop = this._scrollPosition;
var scrollBottom = this._scrollBottom;
if (fromTop) {
ith = this._physicalStart;
lastIth = this._physicalEnd;
offsetContent = scrollTop - top;
} else {
ith = this._physicalEnd;
lastIth = this._physicalStart;
offsetContent = bottom - scrollBottom;
}
while (true) {
physicalItemHeight = this._getPhysicalSizeIncrement(ith);
offsetContent = offsetContent - physicalItemHeight;
if (idxs.length >= physicalCount ||
offsetContent <= protectedOffsetContent) {
break;
}
if (fromTop) {
// Check that index is within the valid range.
if (virtualEnd + idxs.length + 1 >= this._virtualCount) {
break;
}
// Check that the index is not visible.
if (top + physicalItemHeight >= scrollTop - this._scrollOffset) {
break;
}
idxs.push(ith);
top = top + physicalItemHeight;
ith = (ith + 1) % physicalCount;
} else {
// Check that index is within the valid range.
if (virtualStart - idxs.length <= 0) {
break;
}
// Check that the index is not visible.
if (top + this._physicalSize - physicalItemHeight <= scrollBottom) {
break;
}
idxs.push(ith);
top = top - physicalItemHeight;
ith = (ith === 0) ? physicalCount - 1 : ith - 1;
}
}
return {indexes: idxs, physicalTop: top - this._scrollOffset};
},
/**
* Update the list of items, starting from the `_virtualStart` item.
* @param {!Array<number>=} itemSet
* @param {!Array<number>=} movingUp
*/
_update: function(itemSet, movingUp) {
if ((itemSet && itemSet.length === 0) || this._physicalCount === 0) {
return;
}
this._manageFocus();
this._assignModels(itemSet);
this._updateMetrics(itemSet);
// Adjust offset after measuring.
if (movingUp) {
while (movingUp.length) {
var idx = movingUp.pop();
this._physicalTop -= this._getPhysicalSizeIncrement(idx);
}
}
this._positionItems();
this._updateScrollerSize();
},
/**
* Creates a pool of DOM elements and attaches them to the local dom.
*
* @param {number} size Size of the pool
*/
_createPool: function(size) {
this._ensureTemplatized();
var i, inst;
var physicalItems = new Array(size);
for (i = 0; i < size; i++) {
inst = this.stamp(null);
// TODO(blasten):
// First element child is item; Safari doesn't support children[0]
// on a doc fragment. Test this to see if it still matters.
physicalItems[i] = inst.root.querySelector('*');
this._itemsParent.appendChild(inst.root);
}
return physicalItems;
},
_isClientFull: function() {
return this._scrollBottom != 0 &&
this._physicalBottom - 1 >= this._scrollBottom &&
this._physicalTop <= this._scrollPosition;
},
/**
* Increases the pool size.
*/
_increasePoolIfNeeded: function(count) {
var nextPhysicalCount = this._clamp(
this._physicalCount + count,
DEFAULT_PHYSICAL_COUNT,
this._virtualCount - this._virtualStart);
nextPhysicalCount = this._convertIndexToCompleteRow(nextPhysicalCount);
if (this.grid) {
var correction = nextPhysicalCount % this._itemsPerRow;
if (correction && nextPhysicalCount - correction <= this._physicalCount) {
nextPhysicalCount += this._itemsPerRow;
}
nextPhysicalCount -= correction;
}
var delta = nextPhysicalCount - this._physicalCount;
var nextIncrease = Math.round(this._physicalCount * 0.5);
if (delta < 0) {
return;
}
if (delta > 0) {
var ts = window.performance.now();
// Concat arrays in place.
[].push.apply(this._physicalItems, this._createPool(delta));
// Push 0s into physicalSizes. Can't use Array.fill because IE11 doesn't
// support it.
for (var i = 0; i < delta; i++) {
this._physicalSizes.push(0);
}
this._physicalCount = this._physicalCount + delta;
// Update the physical start if it needs to preserve the model of the
// focused item. In this situation, the focused item is currently rendered
// and its model would have changed after increasing the pool if the
// physical start remained unchanged.
if (this._physicalStart > this._physicalEnd &&
this._isIndexRendered(this._focusedVirtualIndex) &&
this._getPhysicalIndex(this._focusedVirtualIndex) <
this._physicalEnd) {
this._physicalStart = this._physicalStart + delta;
}
this._update();
this._templateCost = (window.performance.now() - ts) / delta;
nextIncrease = Math.round(this._physicalCount * 0.5);
}
// The upper bounds is not fixed when dealing with a grid that doesn't
// fill it's last row with the exact number of items per row.
if (this._virtualEnd >= this._virtualCount - 1 || nextIncrease === 0) {
// Do nothing.
} else if (!this._isClientFull()) {
this._debounce(
'_increasePoolIfNeeded',
this._increasePoolIfNeeded.bind(this, nextIncrease),
microTask);
} else if (this._physicalSize < this._optPhysicalSize) {
// Yield and increase the pool during idle time until the physical size is
// optimal.
this._debounce(
'_increasePoolIfNeeded',
this._increasePoolIfNeeded.bind(
this,
this._clamp(
Math.round(50 / this._templateCost), 1, nextIncrease)),
idlePeriod);
}
},
/**
* Renders the a new list.
*/
_render: function() {
if (!this.isAttached || !this._isVisible) {
return;
}
if (this._physicalCount !== 0) {
var reusables = this._getReusables(true);
this._physicalTop = reusables.physicalTop;
this._virtualStart = this._virtualStart + reusables.indexes.length;
this._physicalStart = this._physicalStart + reusables.indexes.length;
this._update(reusables.indexes);
this._update();
this._increasePoolIfNeeded(0);
} else if (this._virtualCount > 0) {
// Initial render
this.updateViewportBoundaries();
this._increasePoolIfNeeded(DEFAULT_PHYSICAL_COUNT);
}
},
/**
* Templetizes the user template.
*/
_ensureTemplatized: function() {
if (this.ctor) {
return;
}
this._userTemplate = /** @type {!HTMLTemplateElement} */ (
this.queryEffectiveChildren('template'));
if (!this._userTemplate) {
console.warn('iron-list requires a template to be provided in light-dom');
}
var instanceProps = {};
instanceProps.__key__ = true;
instanceProps[this.as] = true;
instanceProps[this.indexAs] = true;
instanceProps[this.selectedAs] = true;
instanceProps.tabIndex = true;
this._instanceProps = instanceProps;
this.templatize(this._userTemplate, this.mutableData);
},
_gridChanged: function(newGrid, oldGrid) {
if (typeof oldGrid === 'undefined')
return;
this.notifyResize();
flush();
newGrid && this._updateGridMetrics();
},
/**
* Finds and returns the focused element (both within self and children's
* Shadow DOM).
* @return {?HTMLElement}
*/
_getFocusedElement: function() {
function doSearch(node, query) {
let result = null;
let type = node.nodeType;
if (type == Node.ELEMENT_NODE || type == Node.DOCUMENT_FRAGMENT_NODE)
result = node.querySelector(query);
if (result)
return result;
let child = node.firstChild;
while (child !== null && result === null) {
result = doSearch(child, query);
child = child.nextSibling;
}
if (result)
return result;
const shadowRoot = node.shadowRoot;
return shadowRoot ? doSearch(shadowRoot, query) : null;
}
// Find out if any of the items are focused first, and only search
// recursively in the item that contains focus, to avoid a slow
// search of the entire list.
const focusWithin = doSearch(this, ':focus-within');
return focusWithin ? doSearch(focusWithin, ':focus') : null;
},
/**
* Called when the items have changed. That is, reassignments
* to `items`, splices or updates to a single item.
*/
_itemsChanged: function(change) {
var rendering = /^items(\.splices){0,1}$/.test(change.path);
var lastFocusedIndex, focusedElement;
if (rendering && this.preserveFocus) {
lastFocusedIndex = this._focusedVirtualIndex;
focusedElement = this._getFocusedElement();
}
var preservingFocus = rendering && this.preserveFocus && focusedElement;
if (change.path === 'items') {
this._virtualStart = 0;
this._physicalTop = 0;
this._virtualCount = this.items ? this.items.length : 0;
this._physicalIndexForKey = {};
this._firstVisibleIndexVal = null;
this._lastVisibleIndexVal = null;
this._physicalCount = this._physicalCount || 0;
this._physicalItems = this._physicalItems || [];
this._physicalSizes = this._physicalSizes || [];
this._physicalStart = 0;
if (this._scrollTop > this._scrollOffset && !preservingFocus) {
this._resetScrollPosition(0);
}
this._removeFocusedItem();
this._debounce('_render', this._render, animationFrame);
} else if (change.path === 'items.splices') {
this._adjustVirtualIndex(change.value.indexSplices);
this._virtualCount = this.items ? this.items.length : 0;
// Only blur if at least one item is added or removed.
var itemAddedOrRemoved = change.value.indexSplices.some(function(splice) {
return splice.addedCount > 0 || splice.removed.length > 0;
});
if (itemAddedOrRemoved) {
// Only blur activeElement if it is a descendant of the list (#505,
// #507).
var activeElement = this._getActiveElement();
if (this.contains(activeElement)) {
activeElement.blur();
}
}
// Render only if the affected index is rendered.
var affectedIndexRendered =
change.value.indexSplices.some(function(splice) {
return splice.index + splice.addedCount >= this._virtualStart &&
splice.index <= this._virtualEnd;
}, this);
if (!this._isClientFull() || affectedIndexRendered) {
this._debounce('_render', this._render, animationFrame);
}
} else if (change.path !== 'items.length') {
this._forwardItemPath(change.path, change.value);
}
// If the list was in focus when updated, preserve the focus on item.
if (preservingFocus) {
flush();
focusedElement.blur(); // paper- elements breaks when focused twice.
this._focusPhysicalItem(
Math.min(this.items.length - 1, lastFocusedIndex));
if (!this._isIndexVisible(this._focusedVirtualIndex)) {
this.scrollToIndex(this._focusedVirtualIndex);
}
}
},
_forwardItemPath: function(path, value) {
path = path.slice(6); // 'items.'.length == 6
var dot = path.indexOf('.');
if (dot === -1) {
dot = path.length;
}
var isIndexRendered;
var pidx;
var inst;
var offscreenInstance = this.modelForElement(this._offscreenFocusedItem);
var vidx = parseInt(path.substring(0, dot), 10);
isIndexRendered = this._isIndexRendered(vidx);
if (isIndexRendered) {
pidx = this._getPhysicalIndex(vidx);
inst = this.modelForElement(this._physicalItems[pidx]);
} else if (offscreenInstance) {
inst = offscreenInstance;
}
if (!inst || inst[this.indexAs] !== vidx) {
return;
}
path = path.substring(dot + 1);
path = this.as + (path ? '.' + path : '');
inst._setPendingPropertyOrPath(path, value, false, true);
inst._flushProperties && inst._flushProperties();
// TODO(blasten): V1 doesn't do this and it's a bug
if (isIndexRendered) {
this._updateMetrics([pidx]);
this._positionItems();
this._updateScrollerSize();
}
},
/**
* @param {!Array<!Object>} splices
*/
_adjustVirtualIndex: function(splices) {
splices.forEach(function(splice) {
// deselect removed items
splice.removed.forEach(this._removeItem, this);
// We only need to care about changes happening above the current position
if (splice.index < this._virtualStart) {
var delta = Math.max(
splice.addedCount - splice.removed.length,
splice.index - this._virtualStart);
this._virtualStart = this._virtualStart + delta;
if (this._focusedVirtualIndex >= 0) {
this._focusedVirtualIndex = this._focusedVirtualIndex + delta;
}
}
}, this);
},
_removeItem: function(item) {
this.$.selector.deselect(item);
// remove the current focused item
if (this._focusedItem &&
this.modelForElement(this._focusedItem)[this.as] === item) {
this._removeFocusedItem();
}
},
/**
* Executes a provided function per every physical index in `itemSet`
* `itemSet` default value is equivalent to the entire set of physical
* indexes.
*
* @param {!function(number, number)} fn
* @param {!Array<number>=} itemSet
*/
_iterateItems: function(fn, itemSet) {
var pidx, vidx, rtn, i;
if (arguments.length === 2 && itemSet) {
for (i = 0; i < itemSet.length; i++) {
pidx = itemSet[i];
vidx = this._computeVidx(pidx);
if ((rtn = fn.call(this, pidx, vidx)) != null) {
return rtn;
}
}
} else {
pidx = this._physicalStart;
vidx = this._virtualStart;
for (; pidx < this._physicalCount; pidx++, vidx++) {
if ((rtn = fn.call(this, pidx, vidx)) != null) {
return rtn;
}
}
for (pidx = 0; pidx < this._physicalStart; pidx++, vidx++) {
if ((rtn = fn.call(this, pidx, vidx)) != null) {
return rtn;
}
}
}
},
/**
* Returns the virtual index for a given physical index
*
* @param {number} pidx Physical index
* @return {number}
*/
_computeVidx: function(pidx) {
if (pidx >= this._physicalStart) {
return this._virtualStart + (pidx - this._physicalStart);
}
return this._virtualStart + (this._physicalCount - this._physicalStart) +
pidx;
},
/**
* Assigns the data models to a given set of items.
* @param {!Array<number>=} itemSet
*/
_assignModels: function(itemSet) {
this._iterateItems(function(pidx, vidx) {
var el = this._physicalItems[pidx];
var item = this.items && this.items[vidx];
if (item != null) {
var inst = this.modelForElement(el);
inst.__key__ = null;
this._forwardProperty(inst, this.as, item);
this._forwardProperty(
inst, this.selectedAs, this.$.selector.isSelected(item));
this._forwardProperty(inst, this.indexAs, vidx);
this._forwardProperty(
inst, 'tabIndex', this._focusedVirtualIndex === vidx ? 0 : -1);
this._physicalIndexForKey[inst.__key__] = pidx;
inst._flushProperties && inst._flushProperties(true);
el.removeAttribute('hidden');
} else {
el.setAttribute('hidden', '');
}
}, itemSet);
},
/**
* Updates the height for a given set of items.
*
* @param {!Array<number>=} itemSet
*/
_updateMetrics: function(itemSet) {
// Make sure we distributed all the physical items
// so we can measure them.
flush();
var newPhysicalSize = 0;
var oldPhysicalSize = 0;
var prevAvgCount = this._physicalAverageCount;
var prevPhysicalAvg = this._physicalAverage;
this._iterateItems(function(pidx, vidx) {
oldPhysicalSize += this._physicalSizes[pidx];
this._physicalSizes[pidx] = this._physicalItems[pidx].offsetHeight;
newPhysicalSize += this._physicalSizes[pidx];
this._physicalAverageCount += this._physicalSizes[pidx] ? 1 : 0;
}, itemSet);
if (this.grid) {
this._updateGridMetrics();
this._physicalSize =
Math.ceil(this._physicalCount / this._itemsPerRow) * this._rowHeight;
} else {
oldPhysicalSize = (this._itemsPerRow === 1) ?
oldPhysicalSize :
Math.ceil(this._physicalCount / this._itemsPerRow) * this._rowHeight;
this._physicalSize =
this._physicalSize + newPhysicalSize - oldPhysicalSize;
this._itemsPerRow = 1;
}
// Update the average if it measured something.
if (this._physicalAverageCount !== prevAvgCount) {
this._physicalAverage = Math.round(
((prevPhysicalAvg * prevAvgCount) + newPhysicalSize) /
this._physicalAverageCount);
}
},
_updateGridMetrics: function() {
this._itemWidth = this._physicalCount > 0 ?
this._physicalItems[0].getBoundingClientRect().width :
200;
this._rowHeight =
this._physicalCount > 0 ? this._physicalItems[0].offsetHeight : 200;
this._itemsPerRow = this._itemWidth ?
Math.floor(this._viewportWidth / this._itemWidth) :
this._itemsPerRow;
},
/**
* Updates the position of the physical items.
*/
_positionItems: function() {
this._adjustScrollPosition();
var y = this._physicalTop;
if (this.grid) {
var totalItemWidth = this._itemsPerRow * this._itemWidth;
var rowOffset = (this._viewportWidth - totalItemWidth) / 2;
this._iterateItems(function(pidx, vidx) {
var modulus = vidx % this._itemsPerRow;
var x = Math.floor((modulus * this._itemWidth) + rowOffset);
if (this._isRTL) {
x = x * -1;
}
this.translate3d(x + 'px', y + 'px', 0, this._physicalItems[pidx]);
if (this._shouldRenderNextRow(vidx)) {
y += this._rowHeight;
}
});
} else {
const order = [];
this._iterateItems(function(pidx, vidx) {
const item = this._physicalItems[pidx];
this.translate3d(0, y + 'px', 0, item);
y += this._physicalSizes[pidx];
const itemId = item.id;
if (itemId) {
order.push(itemId);
}
});
if (order.length) {
this.setAttribute('aria-owns', order.join(' '));
}
}
},
_getPhysicalSizeIncrement: function(pidx) {
if (!this.grid) {
return this._physicalSizes[pidx];
}
if (this._computeVidx(pidx) % this._itemsPerRow !== this._itemsPerRow - 1) {
return 0;
}
return this._rowHeight;
},
/**
* Returns, based on the current index,
* whether or not the next index will need
* to be rendered on a new row.
*
* @param {number} vidx Virtual index
* @return {boolean}
*/
_shouldRenderNextRow: function(vidx) {
return vidx % this._itemsPerRow === this._itemsPerRow - 1;
},
/**
* Adjusts the scroll position when it was overestimated.
*/
_adjustScrollPosition: function() {
var deltaHeight = this._virtualStart === 0 ?
this._physicalTop :
Math.min(this._scrollPosition + this._physicalTop, 0);
// Note: the delta can be positive or negative.
if (deltaHeight !== 0) {
this._physicalTop = this._physicalTop - deltaHeight;
// This may be called outside of a scrollHandler, so use last cached position
var scrollTop = this._scrollPosition;
// juking scroll position during interial scrolling on iOS is no bueno
if (!IOS_TOUCH_SCROLLING && scrollTop > 0) {
this._resetScrollPosition(scrollTop - deltaHeight);
}
}
},
/**
* Sets the position of the scroll.
*/
_resetScrollPosition: function(pos) {
if (this.scrollTarget && pos >= 0) {
this._scrollTop = pos;
this._scrollPosition = this._scrollTop;
}
},
/**
* Sets the scroll height, that's the height of the content,
*
* @param {boolean=} forceUpdate If true, updates the height no matter what.
*/
_updateScrollerSize: function(forceUpdate) {
if (this.grid) {
this._estScrollHeight = this._virtualRowCount * this._rowHeight;
} else {
this._estScrollHeight =
(this._physicalBottom +
Math.max(
this._virtualCount - this._physicalCount - this._virtualStart,
0) *
this._physicalAverage);
}
forceUpdate = forceUpdate || this._scrollHeight === 0;
forceUpdate = forceUpdate ||
this._scrollPosition >= this._estScrollHeight - this._physicalSize;
forceUpdate = forceUpdate ||
this.grid && this.$.items.style.height < this._estScrollHeight;
// Amortize height adjustment, so it won't trigger large repaints too often.
if (forceUpdate ||
Math.abs(this._estScrollHeight - this._scrollHeight) >=
this._viewportHeight) {
this.$.items.style.height = this._estScrollHeight + 'px';
this._scrollHeight = this._estScrollHeight;
}
},
/**
* Scroll to a specific item in the virtual list regardless
* of the physical items in the DOM tree.
*
* @method scrollToItem
* @param {(Object)} item The item to be scrolled to
*/
scrollToItem: function(item) {
return this.scrollToIndex(this.items.indexOf(item));
},
/**
* Scroll to a specific index in the virtual list regardless
* of the physical items in the DOM tree.
*
* @method scrollToIndex
* @param {number} idx The index of the item
*/
scrollToIndex: function(idx) {
if (typeof idx !== 'number' || idx < 0 || idx > this.items.length - 1) {
return;
}
flush();
// Items should have been rendered prior scrolling to an index.
if (this._physicalCount === 0) {
return;
}
idx = this._clamp(idx, 0, this._virtualCount - 1);
// Update the virtual start only when needed.
if (!this._isIndexRendered(idx) || idx >= this._maxVirtualStart) {
this._virtualStart =
this.grid ? (idx - this._itemsPerRow * 2) : (idx - 1);
}
this._manageFocus();
this._assignModels();
this._updateMetrics();
// Estimate new physical offset.
this._physicalTop = Math.floor(this._virtualStart / this._itemsPerRow) *
this._physicalAverage;
var currentTopItem = this._physicalStart;
var currentVirtualItem = this._virtualStart;
var targetOffsetTop = 0;
var hiddenContentSize = this._hiddenContentSize;
// scroll to the item as much as we can.
while (currentVirtualItem < idx && targetOffsetTop <= hiddenContentSize) {
targetOffsetTop =
targetOffsetTop + this._getPhysicalSizeIncrement(currentTopItem);
currentTopItem = (currentTopItem + 1) % this._physicalCount;
currentVirtualItem++;
}
this._updateScrollerSize(true);
this._positionItems();
this._resetScrollPosition(
this._physicalTop + this._scrollOffset + targetOffsetTop);
this._increasePoolIfNeeded(0);
// clear cached visible index.
this._firstVisibleIndexVal = null;
this._lastVisibleIndexVal = null;
},
/**
* Reset the physical average and the average count.
*/
_resetAverage: function() {
this._physicalAverage = 0;
this._physicalAverageCount = 0;
},
/**
* A handler for the `iron-resize` event triggered by `IronResizableBehavior`
* when the element is resized.
*/
_resizeHandler: function() {
this._debounce('_render', function() {
// clear cached visible index.
this._firstVisibleIndexVal = null;
this._lastVisibleIndexVal = null;
if (this._isVisible) {
this.updateViewportBoundaries();
// Reinstall the scroll event listener.
this.toggleScrollListener(true);
this._resetAverage();
this._render();
} else {
// Uninstall the scroll event listener.
this.toggleScrollListener(false);
}
}, animationFrame);
},
/**
* Selects the given item.
*
* @method selectItem
* @param {Object} item The item instance.
*/
selectItem: function(item) {
return this.selectIndex(this.items.indexOf(item));
},
/**
* Selects the item at the given index in the items array.
*
* @method selectIndex
* @param {number} index The index of the item in the items array.
*/
selectIndex: function(index) {
if (index < 0 || index >= this._virtualCount) {
return;
}
if (!this.multiSelection && this.selectedItem) {
this.clearSelection();
}
if (this._isIndexRendered(index)) {
var model = this.modelForElement(
this._physicalItems[this._getPhysicalIndex(index)]);
if (model) {
model[this.selectedAs] = true;
}
this.updateSizeForIndex(index);
}
this.$.selector.selectIndex(index);
},
/**
* Deselects the given item.
*
* @method deselect
* @param {Object} item The item instance.
*/
deselectItem: function(item) {
return this.deselectIndex(this.items.indexOf(item));
},
/**
* Deselects the item at the given index in the items array.
*
* @method deselectIndex
* @param {number} index The index of the item in the items array.
*/
deselectIndex: function(index) {
if (index < 0 || index >= this._virtualCount) {
return;
}
if (this._isIndexRendered(index)) {
var model = this.modelForElement(
this._physicalItems[this._getPhysicalIndex(index)]);
model[this.selectedAs] = false;
this.updateSizeForIndex(index);
}
this.$.selector.deselectIndex(index);
},
/**
* Selects or deselects a given item depending on whether the item
* has already been selected.
*
* @method toggleSelectionForItem
* @param {Object} item The item object.
*/
toggleSelectionForItem: function(item) {
return this.toggleSelectionForIndex(this.items.indexOf(item));
},
/**
* Selects or deselects the item at the given index in the items array
* depending on whether the item has already been selected.
*
* @method toggleSelectionForIndex
* @param {number} index The index of the item in the items array.
*/
toggleSelectionForIndex: function(index) {
var isSelected = this.$.selector.isIndexSelected ?
this.$.selector.isIndexSelected(index) :
this.$.selector.isSelected(this.items[index]);
isSelected ? this.deselectIndex(index) : this.selectIndex(index);
},
/**
* Clears the current selection in the list.
*
* @method clearSelection
*/
clearSelection: function() {
this._iterateItems(function(pidx, vidx) {
this.modelForElement(this._physicalItems[pidx])[this.selectedAs] = false;
});
this.$.selector.clearSelection();
},
/**
* Add an event listener to `tap` if `selectionEnabled` is true,
* it will remove the listener otherwise.
*/
_selectionEnabledChanged: function(selectionEnabled) {
var handler = selectionEnabled ? this.listen : this.unlisten;
handler.call(this, this, 'tap', '_selectionHandler');
},
/**
* Select an item from an event object.
*/
_selectionHandler: function(e) {
var model = this.modelForElement(e.target);
if (!model) {
return;
}
var modelTabIndex, activeElTabIndex;
var target = dom(e).path[0];
var activeEl = this._getActiveElement();
var physicalItem =
this._physicalItems[this._getPhysicalIndex(model[this.indexAs])];
// Safari does not focus certain form controls via mouse
// https://bugs.webkit.org/show_bug.cgi?id=118043
if (target.localName === 'input' || target.localName === 'button' ||
target.localName === 'select') {
return;
}
// Set a temporary tabindex
modelTabIndex = model.tabIndex;
model.tabIndex = SECRET_TABINDEX;
activeElTabIndex = activeEl ? activeEl.tabIndex : -1;
model.tabIndex = modelTabIndex;
// Only select the item if the tap wasn't on a focusable child
// or the element bound to `tabIndex`
if (activeEl && physicalItem !== activeEl &&
physicalItem.contains(activeEl) &&
activeElTabIndex !== SECRET_TABINDEX) {
return;
}
this.toggleSelectionForItem(model[this.as]);
},
_multiSelectionChanged: function(multiSelection) {
this.clearSelection();
this.$.selector.multi = multiSelection;
},
/**
* Updates the size of a given list item.
*
* @method updateSizeForItem
* @param {Object} item The item instance.
*/
updateSizeForItem: function(item) {
return this.updateSizeForIndex(this.items.indexOf(item));
},
/**
* Updates the size of the item at the given index in the items array.
*
* @method updateSizeForIndex
* @param {number} index The index of the item in the items array.
*/
updateSizeForIndex: function(index) {
if (!this._isIndexRendered(index)) {
return null;
}
this._updateMetrics([this._getPhysicalIndex(index)]);
this._positionItems();
return null;
},
/**
* Creates a temporary backfill item in the rendered pool of physical items
* to replace the main focused item. The focused item has tabIndex = 0
* and might be currently focused by the user.
*
* This dynamic replacement helps to preserve the focus state.
*/
_manageFocus: function() {
var fidx = this._focusedVirtualIndex;
if (fidx >= 0 && fidx < this._virtualCount) {
// if it's a valid index, check if that index is rendered
// in a physical item.
if (this._isIndexRendered(fidx)) {
this._restoreFocusedItem();
} else {
this._createFocusBackfillItem();
}
} else if (this._virtualCount > 0 && this._physicalCount > 0) {
// otherwise, assign the initial focused index.
this._focusedPhysicalIndex = this._physicalStart;
this._focusedVirtualIndex = this._virtualStart;
this._focusedItem = this._physicalItems[this._physicalStart];
}
},
/**
* Converts a random index to the index of the item that completes it's row.
* Allows for better order and fill computation when grid == true.
*/
_convertIndexToCompleteRow: function(idx) {
// when grid == false _itemPerRow can be unset.
this._itemsPerRow = this._itemsPerRow || 1;
return this.grid ? Math.ceil(idx / this._itemsPerRow) * this._itemsPerRow :
idx;
},
_isIndexRendered: function(idx) {
return idx >= this._virtualStart && idx <= this._virtualEnd;
},
_isIndexVisible: function(idx) {
return idx >= this.firstVisibleIndex && idx <= this.lastVisibleIndex;
},
_getPhysicalIndex: function(vidx) {
return (this._physicalStart + (vidx - this._virtualStart)) %
this._physicalCount;
},
focusItem: function(idx) {
this._focusPhysicalItem(idx);
},
_focusPhysicalItem: function(idx) {
if (idx < 0 || idx >= this._virtualCount) {
return;
}
this._restoreFocusedItem();
// scroll to index to make sure it's rendered
if (!this._isIndexRendered(idx)) {
this.scrollToIndex(idx);
}
var physicalItem = this._physicalItems[this._getPhysicalIndex(idx)];
var model = this.modelForElement(physicalItem);
var focusable;
// set a secret tab index
model.tabIndex = SECRET_TABINDEX;
// check if focusable element is the physical item
if (physicalItem.tabIndex === SECRET_TABINDEX) {
focusable = physicalItem;
}
// search for the element which tabindex is bound to the secret tab index
if (!focusable) {
focusable = dom(physicalItem)
.querySelector('[tabindex="' + SECRET_TABINDEX + '"]');
}
// restore the tab index
model.tabIndex = 0;
// focus the focusable element
this._focusedVirtualIndex = idx;
focusable && focusable.focus();
},
_removeFocusedItem: function() {
if (this._offscreenFocusedItem) {
this._itemsParent.removeChild(this._offscreenFocusedItem);
}
this._offscreenFocusedItem = null;
this._focusBackfillItem = null;
this._focusedItem = null;
this._focusedVirtualIndex = -1;
this._focusedPhysicalIndex = -1;
},
_createFocusBackfillItem: function() {
var fpidx = this._focusedPhysicalIndex;
if (this._offscreenFocusedItem || this._focusedVirtualIndex < 0) {
return;
}
if (!this._focusBackfillItem) {
// Create a physical item.
var inst = this.stamp(null);
this._focusBackfillItem =
/** @type {!HTMLElement} */ (inst.root.querySelector('*'));
this._itemsParent.appendChild(inst.root);
}
// Set the offcreen focused physical item.
this._offscreenFocusedItem = this._physicalItems[fpidx];
this.modelForElement(this._offscreenFocusedItem).tabIndex = 0;
this._physicalItems[fpidx] = this._focusBackfillItem;
this._focusedPhysicalIndex = fpidx;
// Hide the focused physical.
this.translate3d(0, HIDDEN_Y, 0, this._offscreenFocusedItem);
},
_restoreFocusedItem: function() {
if (!this._offscreenFocusedItem || this._focusedVirtualIndex < 0) {
return;
}
// Assign models to the focused index.
this._assignModels();
// Get the new physical index for the focused index.
var fpidx = this._focusedPhysicalIndex =
this._getPhysicalIndex(this._focusedVirtualIndex);
var onScreenItem = this._physicalItems[fpidx];
if (!onScreenItem) {
return;
}
var onScreenInstance = this.modelForElement(onScreenItem);
var offScreenInstance = this.modelForElement(this._offscreenFocusedItem);
// Restores the physical item only when it has the same model
// as the offscreen one. Use key for comparison since users can set
// a new item via set('items.idx').
if (onScreenInstance[this.as] === offScreenInstance[this.as]) {
// Flip the focus backfill.
this._focusBackfillItem = onScreenItem;
onScreenInstance.tabIndex = -1;
// Restore the focused physical item.
this._physicalItems[fpidx] = this._offscreenFocusedItem;
// Hide the physical item that backfills.
this.translate3d(0, HIDDEN_Y, 0, this._focusBackfillItem);
} else {
this._removeFocusedItem();
this._focusBackfillItem = null;
}
this._offscreenFocusedItem = null;
},
_didFocus: function(e) {
var targetModel = this.modelForElement(e.target);
var focusedModel = this.modelForElement(this._focusedItem);
var hasOffscreenFocusedItem = this._offscreenFocusedItem !== null;
var fidx = this._focusedVirtualIndex;
if (!targetModel) {
return;
}
if (focusedModel !== targetModel) {
this._restoreFocusedItem();
// Restore tabIndex for the currently focused item.
if (focusedModel) {
focusedModel.tabIndex = -1;
}
// Set the tabIndex for the next focused item.
targetModel.tabIndex = 0;
fidx = targetModel[this.indexAs];
this._focusedVirtualIndex = fidx;
this._focusedPhysicalIndex = this._getPhysicalIndex(fidx);
this._focusedItem = this._physicalItems[this._focusedPhysicalIndex];
if (hasOffscreenFocusedItem && !this._offscreenFocusedItem) {
this._update();
}
}
},
_keydownHandler: function(e) {
switch (e.keyCode) {
case /* ARROW_DOWN */ 40:
if (this._focusedVirtualIndex < this._virtualCount - 1)
e.preventDefault();
this._focusPhysicalItem(
this._focusedVirtualIndex + (this.grid ? this._itemsPerRow : 1));
break;
case /* ARROW_RIGHT */ 39:
if (this.grid)
this._focusPhysicalItem(
this._focusedVirtualIndex + (this._isRTL ? -1 : 1));
break;
case /* ARROW_UP */ 38:
if (this._focusedVirtualIndex > 0)
e.preventDefault();
this._focusPhysicalItem(
this._focusedVirtualIndex - (this.grid ? this._itemsPerRow : 1));
break;
case /* ARROW_LEFT */ 37:
if (this.grid)
this._focusPhysicalItem(
this._focusedVirtualIndex + (this._isRTL ? 1 : -1));
break;
case /* ENTER */ 13:
this._focusPhysicalItem(this._focusedVirtualIndex);
if (this.selectionEnabled)
this._selectionHandler(e);
break;
}
},
_clamp: function(v, min, max) {
return Math.min(max, Math.max(min, v));
},
_debounce: function(name, cb, asyncModule) {
this._debouncers = this._debouncers || {};
this._debouncers[name] =
Debouncer.debounce(this._debouncers[name], asyncModule, cb.bind(this));
enqueueDebouncer(this._debouncers[name]);
},
_forwardProperty: function(inst, name, value) {
inst._setPendingProperty(name, value);
},
/* Templatizer bindings for v2 */
_forwardHostPropV2: function(prop, value) {
(this._physicalItems || [])
.concat([this._offscreenFocusedItem, this._focusBackfillItem])
.forEach(function(item) {
if (item) {
this.modelForElement(item).forwardHostProp(prop, value);
}
}, this);
},
_notifyInstancePropV2: function(inst, prop, value) {
if (matches(this.as, prop)) {
var idx = inst[this.indexAs];
if (prop == this.as) {
this.items[idx] = value;
}
this.notifyPath(translate(this.as, 'items.' + idx, prop), value);
}
},
/* Templatizer bindings for v1 */
_getStampedChildren: function() {
return this._physicalItems;
},
_forwardInstancePath: function(inst, path, value) {
if (path.indexOf(this.as + '.') === 0) {
this.notifyPath(
'items.' + inst.__key__ + '.' + path.slice(this.as.length + 1),
value);
}
},
_forwardParentPath: function(path, value) {
(this._physicalItems || [])
.concat([this._offscreenFocusedItem, this._focusBackfillItem])
.forEach(function(item) {
if (item) {
this.modelForElement(item).notifyPath(path, value);
}
}, this);
},
_forwardParentProp: function(prop, value) {
(this._physicalItems || [])
.concat([this._offscreenFocusedItem, this._focusBackfillItem])
.forEach(function(item) {
if (item) {
this.modelForElement(item)[prop] = value;
}
}, this);
},
/* Gets the activeElement of the shadow root/host that contains the list. */
_getActiveElement: function() {
var itemsHost = this._itemsParent.node.domHost;
return dom(itemsHost ? itemsHost.root : document).activeElement;
}
});
Codebase Browser
chromium