Skip to content

Commit

Permalink
feat(select): add property for selecting multiple values
Browse files Browse the repository at this point in the history 
Refactored select component to use native select on mobile devices, and a menu surface with a list
on desktop

fix #203
  • Loading branch information
@jgroth @adrianschmidt
jgroth authored and adrianschmidt committed Sep 10, 2019
1 parent f222957 commit c7114c8
Show file tree
Hide file tree
Showing 9 changed files with 886 additions and 85 deletions.
307 changes: 299 additions & 8 deletions src/components/select/select.e2e.ts
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { newE2EPage } from '@stencil/core/testing';
import { Option } from './option.types';

// Since we are currently using a pre-release of Stencil to get access
// to Puppeteer, documentation is lacking.
Expand All @@ -9,14 +10,14 @@ import { newE2EPage } from '@stencil/core/testing';
// Matchers (expect-methods) for E2EElement (v0.13.0-9):
// https://github.com/ionic-team/stencil/blob/a0250ffcbf5a2c657475a05052eac3a4690809d2/src/declarations/testing.ts#L5

describe('limel-select', () => {
describe('limel-select (native)', () => {
let page;
describe('with a label', () => {
let limelSelect;
let label;
beforeEach(async () => {
page = await createPage(`
<limel-select label="Favourite Doctor"></limel-select>
<limel-select native label="Favourite Doctor"></limel-select>
`);
limelSelect = await page.find('limel-select');
label = await page.find('limel-select>>>.mdc-floating-label');
Expand All @@ -43,7 +44,7 @@ describe('limel-select', () => {
let innerSelect;
beforeEach(async () => {
page = await createPage(`
<limel-select label="Favourite Doctor"></limel-select>
<limel-select native label="Favourite Doctor"></limel-select>
`);
limelSelect = await page.find('limel-select');
mdcSelect = await page.find('limel-select>>>.mdc-select');
Expand Down Expand Up @@ -80,7 +81,7 @@ describe('limel-select', () => {
let innerSelect;
beforeEach(async () => {
page = await createPage(`
<limel-select label="Favourite Doctor" disabled="false"></limel-select>
<limel-select native label="Favourite Doctor" disabled="false"></limel-select>
`);
limelSelect = await page.find('limel-select');
mdcSelect = await page.find('limel-select>>>.mdc-select');
Expand Down Expand Up @@ -117,7 +118,7 @@ describe('limel-select', () => {
let innerSelect;
beforeEach(async () => {
page = await createPage(`
<limel-select label="Favourite Doctor" disabled="true"></limel-select>
<limel-select native label="Favourite Doctor" disabled="true"></limel-select>
`);
limelSelect = await page.find('limel-select');
mdcSelect = await page.find('limel-select>>>.mdc-select');
Expand Down Expand Up @@ -157,12 +158,12 @@ describe('limel-select', () => {
let label;
beforeEach(async () => {
page = await createPage(`
<select-test-wrapper></select-test-wrapper>
<select-test-wrapper native></select-test-wrapper>
`);
testWrapper = await page.find('select-test-wrapper');
limelSelect = await page.find('limel-select');
innerSelect = await page.find('limel-select>>>select');
label = await page.find('limel-select>>>.mdc-floating-label');
innerSelect = await page.find('limel-select >>> select');
label = await page.find('limel-select >>> .mdc-floating-label');
});
it('has no options', async () => {
const child = await innerSelect.find('option');
Expand Down Expand Up @@ -294,6 +295,296 @@ describe('limel-select', () => {
}
});
});

describe('when multiple is set', () => {
let limelSelect;
let innerSelect;
const options: Option[] = [
{
text: 'Apple',
value: 'apple',
},
{
text: 'Lime',
value: 'lime',
},
{
text: 'Banana',
value: 'banana',
},
];

beforeEach(async () => {
page = await createPage(`
<limel-select native multiple label="Favourite Fruit"></limel-select>
`);
limelSelect = await page.find('limel-select');
innerSelect = await page.find('limel-select>>>select');

await limelSelect.setProperty('options', options);
await page.waitForChanges();
});

describe('when selecting a value', () => {
let spy;

beforeEach(async () => {
spy = await page.spyOnEvent('change');
const appleOption = await innerSelect.find(
'option[value="apple"]'
);
await appleOption.click();
});

it('emits one change event', () => {
expect(spy).toHaveReceivedEventTimes(1);
});

it('passes the selected option as the event details', () => {
expect(spy).toHaveReceivedEventDetail([options[0]]);
});

describe('when selecting another value', () => {
beforeEach(async () => {
spy = await page.spyOnEvent('change');
const appleOption = await innerSelect.find(
'option[value="lime"]'
);
await page.keyboard.down('Shift');
await appleOption.click();
});

it('emits one change event', () => {
expect(spy).toHaveReceivedEventTimes(1);
});

it('passes the selected option as the event details', () => {
expect(spy).toHaveReceivedEventDetail([
options[0],
options[1],
]);
});
});
});
});
});

describe('limel-select (menu)', () => {
let page;
describe('with a label', () => {
let limelSelect;
let label;
beforeEach(async () => {
page = await createPage(`
<limel-select label="Favourite Doctor"></limel-select>
`);
limelSelect = await page.find('limel-select');
label = await page.find('limel-select>>>.mdc-floating-label');
});
it('displays the correct label', () => {
expect(label).toEqualText('Favourite Doctor');
});

describe('when changing the label', () => {
beforeEach(async () => {
limelSelect.setProperty('label', 'new label');
await page.waitForChanges();
});
it('displays the new label', async () => {
expect(label).toEqualText('new label');
});
});
});

describe('when the attribute `disabled`', () => {
describe('is not set', () => {
let limelSelect;
let mdcSelect;
beforeEach(async () => {
page = await createPage(`
<limel-select label="Favourite Doctor"></limel-select>
`);
limelSelect = await page.find('limel-select');
mdcSelect = await page.find('limel-select>>>.limel-select');
});
it('is enabled', () => {
expect(mdcSelect).not.toHaveClass('mdc-select--disabled');
});
it('the property is falsy', async () => {
const propValue = await limelSelect.getProperty('disabled');
expect(propValue).toBeFalsy();
});

describe('when then set to `true`', () => {
beforeEach(async () => {
await limelSelect.setProperty('disabled', true);
await page.waitForChanges();
});
it('is disabled', () => {
expect(mdcSelect).toHaveClass('mdc-select--disabled');
});
it('the property is `true`', async () => {
const propValue = await limelSelect.getProperty('disabled');
expect(propValue).toEqual(true);
});
});
});

describe('is set to `false`', () => {
let limelSelect;
let mdcSelect;
beforeEach(async () => {
page = await createPage(`
<limel-select label="Favourite Doctor" disabled="false"></limel-select>
`);
limelSelect = await page.find('limel-select');
mdcSelect = await page.find('limel-select>>>.limel-select');
});
it('is enabled', () => {
expect(mdcSelect).not.toHaveClass('mdc-select--disabled');
});
it('the property is falsy', async () => {
const propValue = await limelSelect.getProperty('disabled');
expect(propValue).toBeFalsy();
});

describe('when then set to `true`', () => {
beforeEach(async () => {
await limelSelect.setProperty('disabled', true);
await page.waitForChanges();
});
it('is disabled', () => {
expect(mdcSelect).toHaveClass('mdc-select--disabled');
});
it('the property is `true`', async () => {
const propValue = await limelSelect.getProperty('disabled');
expect(propValue).toEqual(true);
});
});
});

describe('is set to `true`', () => {
let limelSelect;
let mdcSelect;
beforeEach(async () => {
page = await createPage(`
<limel-select label="Favourite Doctor" disabled="true"></limel-select>
`);
limelSelect = await page.find('limel-select');
mdcSelect = await page.find('limel-select>>>.limel-select');
});
it('is disabled', () => {
expect(mdcSelect).toHaveClass('mdc-select--disabled');
});
it('the property is `true`', async () => {
const propValue = await limelSelect.getProperty('disabled');
expect(propValue).toEqual(true);
});

describe('when then set to `false`', () => {
beforeEach(async () => {
await limelSelect.setProperty('disabled', false);
await page.waitForChanges();
});
it('is enabled', () => {
expect(mdcSelect).not.toHaveClass('mdc-select--disabled');
});
it('the property is falsy', async () => {
const propValue = await limelSelect.getProperty('disabled');
expect(propValue).toBeFalsy();
});
});
});
});

describe('when the attribute `options`', () => {
describe('is not set', () => {
let testWrapper;
let limelSelect;
let limelList;
let label;
beforeEach(async () => {
page = await createPage(`
<select-test-wrapper></select-test-wrapper>
`);
testWrapper = await page.find('select-test-wrapper');
limelSelect = await page.find('limel-select');
limelList = await page.find('limel-select >>> limel-list');
label = await page.find('limel-select >>> .mdc-floating-label');
});
it('has no options', async () => {
const child = await limelList.find('* >>> li');
expect(child).toBeFalsy();
});
it('label is not floating', () => {
expect(label).not.toHaveClass(
'mdc-floating-label--float-above'
);
});

describe.skip('when then set to an empty array', () => {
beforeEach(async () => {
await limelSelect.setProperty('options', []);
await page.waitForChanges();
});
it('has no options', async () => {
const child = await limelList.find('* >>> li');
expect(child).toBeFalsy();
});
it('label is not floating', () => {
expect(label).not.toHaveClass(
'mdc-floating-label--float-above'
);
});
});

describe('when then set to a populated array', () => {
describe('with a value as the first option', () => {
testSettingOptions([
{ text: 'David Tennant', value: '10' },
{ text: 'Matt Smith', value: '11' },
]);

describe('and then changed to a different populated array', () => {
describe('with a value as the first option', () => {
testSettingOptions([
{ text: 'Peter Capaldi', value: '12' },
{ text: 'Jodie Witthaker', value: '13' },
]);
});
describe('with an empty first option', () => {
testSettingOptions([
{ text: '', value: '' },
{ text: 'Matt Smith', value: '11' },
{ text: 'Peter Capaldi', value: '12' },
]);
});
describe('with an empty and disabled first option', () => {
testSettingOptions([
{ text: '', value: '', disabled: true },
{ text: 'Jodie Witthaker', value: '13' },
]);
});
});
});
});

function testSettingOptions(options) {
beforeEach(async () => {
await testWrapper.setProperty('onChangeCalledTimes', 0);
await page.waitForChanges();
await limelSelect.setProperty('options', options);
await page.waitForChanges();
});
it('has options', async () => {
const child = await page.find(
'limel-select >>> limel-list >>> li'
);
expect(child).toBeTruthy();
});
}
});
});
});

async function createPage(content) {
Expand Down
4 changes: 4 additions & 0 deletions src/components/select/select.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ When importing Option, see [Import Statements](/#import-statements).

<limel-example name="limel-example-select" />

### Select multiple values

<limel-example name="limel-example-select-multiple" path="select" />

### Initially Empty

<limel-example name="limel-example-select-initially-empty" path="select" />
Expand Down
Loading

0 comments on commit c7114c8

Please sign in to comment.