Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

<amp-selector> Add select{Up/Down} actions #13439

Merged
merged 5 commits into from
Feb 22, 2018
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions extensions/amp-selector/0.1/amp-selector.js
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,18 @@ export class AmpSelector extends AMP.BaseElement {
this.element.addEventListener('click', this.clickHandler_.bind(this));
this.element.addEventListener('keydown', this.keyDownHandler_.bind(this));
}

this.registerAction('selectUp', invocation => {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bikeshed naming - should the attribute be changed to skip and then the dev can pass in negative or positive values to the function select?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe count? skip could be confusing, like is skip=1 might imply moving and skipping over an option, instead of moving to it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed this to delta since I thought it best reflected the attribute and matched up with your suggestion for the input argument to select_()

const args = invocation.args;
const delta = (args && args['delta'] !== undefined) ? -args['delta'] : -1;
this.select_(delta);
}, ActionTrust.LOW);

this.registerAction('selectDown', invocation => {
const args = invocation.args;
const delta = (args && args['delta'] !== undefined) ? args['delta'] : 1;
this.select_(delta);
}, ActionTrust.LOW);
}

/** @override */
Expand Down Expand Up @@ -319,6 +331,28 @@ export class AmpSelector extends AMP.BaseElement {
}
}

/**
* Handles selectUp events.
* @param {number} delta
*/
select_(delta) {
// Change the selection to the next element in the specified direction.
// The selection should loop around if the user attempts to go one
// past the beginning or end.
const previousIndex = this.options_.indexOf(this.selectedOptions_[0]);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this still work if the user calls myAmpSelector.selectDown(-1000)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL: Javascript % is not true modulo.

Adapted the answer here to work: https://stackoverflow.com/a/47354356

I have also added tests to check select{Up,Down}(1001)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! This could be a good utility method to add to src/math.js since I'm sure it'd be generally useful.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Also added tests to test-math.js which helped me catch another issue in the code.

const index = previousIndex + delta;
const normalizedIndex = index > 0 ?
index % this.options_.length :
((index % this.options_.length) +
this.options_.length) % this.options_.length;

user().assert(normalizedIndex >= 0,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the true modulo change, is it mathematically possible that normalizedIndex could ever be negative? I'm not sure this user assert is necessary.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

'This should have been positive');

this.setSelection_(this.options_[normalizedIndex]);
this.clearSelection_(this.options_[previousIndex]);
}

/**
* Handles keyboard events.
* @param {!Event} event
Expand Down
90 changes: 90 additions & 0 deletions extensions/amp-selector/0.1/test/test-amp-selector.js
Original file line number Diff line number Diff line change
Expand Up @@ -651,6 +651,96 @@ describes.realWin('amp-selector', {
ampSelector, 'select', /* CustomEvent */ eventMatcher);
});

it('should trigger `select` action when user uses ' +
'`selectUp`/`selectDown` action with default delta value of 1', () => {
const ampSelector = getSelector({
attributes: {
id: 'ampSelector',
},
config: {
count: 6,
},
});
ampSelector.children[0].setAttribute('selected', '');
ampSelector.build();
const impl = ampSelector.implementation_;

expect(ampSelector.hasAttribute('multiple')).to.be.false;
expect(ampSelector.children[0].hasAttribute('selected')).to.be.true;

impl.executeAction({method: 'selectDown', satisfiesTrust: () => true});
expect(ampSelector.children[0].hasAttribute('selected')).to.be.false;
expect(ampSelector.children[1].hasAttribute('selected')).to.be.true;

impl.executeAction({method: 'selectUp', satisfiesTrust: () => true});

expect(ampSelector.children[1].hasAttribute('selected')).to.be.false;
expect(ampSelector.children[0].hasAttribute('selected')).to.be.true;

});

it('should trigger `select` action when user uses ' +
'`selectUp`/`selectDown` action with user specified delta value', () => {
const ampSelector = getSelector({
attributes: {
id: 'ampSelector',
},
config: {
count: 6,
},
});
ampSelector.children[0].setAttribute('selected', '');
ampSelector.build();
const impl = ampSelector.implementation_;

expect(ampSelector.hasAttribute('multiple')).to.be.false;
expect(ampSelector.children[0].hasAttribute('selected')).to.be.true;

let args = {'delta': 2};
impl.executeAction(
{method: 'selectDown', args, satisfiesTrust: () => true});
expect(ampSelector.children[0].hasAttribute('selected')).to.be.false;
expect(ampSelector.children[2].hasAttribute('selected')).to.be.true;

args = {'delta': 2};
impl.executeAction(
{method: 'selectUp', args, satisfiesTrust: () => true});
expect(ampSelector.children[2].hasAttribute('selected')).to.be.false;
expect(ampSelector.children[0].hasAttribute('selected')).to.be.true;
});

it('should trigger `select` action when user uses ' +
'`selectUp`/`selectDown` action with user specified delta value ' +
'(test large values)', () => {
const ampSelector = getSelector({
attributes: {
id: 'ampSelector',
},
config: {
count: 5,
},
});
ampSelector.children[1].setAttribute('selected', '');
ampSelector.build();
const impl = ampSelector.implementation_;

expect(ampSelector.hasAttribute('multiple')).to.be.false;
expect(ampSelector.children[1].hasAttribute('selected')).to.be.true;

let args = {'delta': 1001};
impl.executeAction(
{method: 'selectDown', args, satisfiesTrust: () => true});
expect(ampSelector.children[1].hasAttribute('selected')).to.be.false;
expect(ampSelector.children[2].hasAttribute('selected')).to.be.true;

args = {'delta': 1001};
impl.executeAction(
{method: 'selectUp', args, satisfiesTrust: () => true});
expect(ampSelector.children[2].hasAttribute('selected')).to.be.false;
expect(ampSelector.children[1].hasAttribute('selected')).to.be.true;
});


describe('keyboard-select-mode', () => {

it('should have `none` mode by default', () => {
Expand Down
16 changes: 16 additions & 0 deletions spec/amp-actions-and-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,22 @@ event.response</pre></td>
</tr>
</table>

### amp-selector
<table>
<tr>
<th>Action</th>
<th>Description</th>
</tr>
<tr>
<td><code>selectUp(delta=INTEGER)</code></td>
<td>Moves the selection up by the value of `delta`. The default `delta` is set to 1.</td>
</tr>
<tr>
<td><code>selectDown(delta=INTEGER)</code></td>
<td>Moves the selection down by the value of `delta`. The default `delta` is set to -1.</td>
</tr>
</table>

### amp-sidebar
<table>
<tr>
Expand Down