Skip to content

feat(FilterItem): Add MultiSelect option to FilterTypes #79

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Aug 2, 2019
Merged

feat(FilterItem): Add MultiSelect option to FilterTypes #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
663a1f4
feat(FilterItem): add FilterType MultiSelect
vbersch Aug 2, 2019
5863488
WIP: update tests
vbersch Aug 2, 2019
311bbe9
Merge branch 'master' into feature/filterItem-enhancement
vbersch Aug 2, 2019
db9ddd0
Merge branch 'master' into feature/filterItem-enhancement
vbersch Aug 2, 2019
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
25 changes: 25 additions & 0 deletions packages/main/__karma_snapshots__/FilterBar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,31 @@
</div>
</div>
</FilterItem>
<FilterItem filterItems={{...}} label="Classification" type="MultiSelect" placeholder="" renderText={[Function: renderText]} onChange={[Function: onChange]} loading={false}>
<div className="FilterItem--filterItem---" style={[undefined]} title={[undefined]}>
<div className="FilterItem--innerFilterItemContainer---">
<Label for="">
<ui5-label for="" class="">
Classification
</ui5-label>
</Label>
<MultiComboBox onSelectionChange={[Function: onMultiCbChange]} value="" placeholder="" valueState="None">
<ui5-multi-combobox value="" placeholder="" value-state="None" class="">
<StandardListItem data-key="1" type="Active" infoState="None">
<ui5-li data-key="1" type="Active" info-state="None" class="">
Text 1
</ui5-li>
</StandardListItem>
<StandardListItem data-key="2" type="Active" infoState="None">
<ui5-li data-key="2" type="Active" info-state="None" class="">
Text 2
</ui5-li>
</StandardListItem>
</ui5-multi-combobox>
</MultiComboBox>
</div>
</div>
</FilterItem>
</div>
</div>
</FilterBar>
Expand Down
9 changes: 8 additions & 1 deletion packages/main/src/components/FilterBar/FilterBar.karma.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,19 @@ describe('FilterBar', () => {
key="classification3"
type={FilterType.Default}
/>
<FilterItem
// onChange={(e) => alert(e.getParameter('selectedItem').key)}
filterItems={filterItems}
label="Classification"
key="classification3"
type={FilterType.MultiSelect}
/>
</FilterBar>
);
// console.log(wrapper.debug());
// console.log(wrapper.find('Select').debug());
wrapper
.find('ui5-li')
.find('ui5-option')
.at(1)
.simulate('change');

Expand Down
23 changes: 12 additions & 11 deletions packages/main/src/components/FilterBar/demo.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import { PlacementType } from '../../lib/PlacementType';
import { Switch } from '../../lib/Switch';
import { TitleLevel } from '../../lib/TitleLevel';
import { VariantManagement } from '../../lib/VariantManagement';
import { action } from '@storybook/addon-actions';

const flavours = [];
for (let i = 1; i <= 9; i++) {
Expand Down Expand Up @@ -57,17 +58,17 @@ function renderStory() {
>
<Switch />
</FilterItem>
{/*<FilterItem*/}
{/*key={'filter2'}*/}
{/*type={FilterType.Custom}*/}
{/*label={'Custom Filter 2'}*/}
{/*changeEventName={'onSelect'}*/}
{/*valueParamName={'state'}*/}
{/*>*/}
{/*<RadioButton text={"Custom Radio Button filter"} onSelect={(e) => {*/}
{/*alert(e.parameters.selectedItem);*/}
{/*}}/>*/}
{/*</FilterItem>*/}
<FilterItem
onChange={action('onChange')}
filterItems={filterItems}
style={{
maxWidth: '200px'
}}
label="Multi"
key="Multi"
type={FilterType.MultiSelect}
loading={boolean('loading', false)}
/>
</FilterBar>
);
}
Expand Down
25 changes: 24 additions & 1 deletion packages/main/src/components/FilterItem/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
import { Event, StyleClassHelper } from '@ui5/webcomponents-react-base';
import React, { forwardRef, ReactNode, RefObject, useMemo, FC } from 'react';
import React, { FC, forwardRef, ReactNode, RefObject, useMemo } from 'react';
import { CommonProps } from '../../interfaces/CommonProps';
import { BusyIndicator } from '../../lib/BusyIndicator';
import { FilterType } from '../../lib/FilterType';
import { Input } from '../../lib/Input';
import { Label } from '../../lib/Label';
import { createUseStyles } from 'react-jss';
import { Select } from '../../lib/Select';
import { MultiComboBox } from '../../lib/MultiComboBox';
import { StandardListItem } from '../../lib/StandardListItem';
import { Option } from '../../lib/Option';
import styles from './FilterItem.jss';
import { BusyIndicatorType } from '../../lib/BusyIndicatorType';
Expand Down Expand Up @@ -52,6 +54,17 @@ const FilterItem: FC<FilterItemPropTypes> = forwardRef((props: FilterItemPropTyp
onChange(Event.of(null, e.getOriginalEvent(), { selectedItem: item }));
}

function onMultiCbChange(e) {
Copy link
Contributor

Choose a reason for hiding this comment

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

would it make sense to use useCallback here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thought about it as well...
I think it would be a micro optimization because the only place where its used is in filterComponent which gets memoized anyway (the memoization won´t run again if onSelect or onMultiCbChange get a new reference). Therefore there is no unnecessary rerender when the reference of onMultiCbChange and onSelect changes. Thats exactly the goal of useCallback. So almost no difference with or without useCallback.

const selectedItems = e.getParameter('items');
onChange(
Event.of(null, e.getOriginalEvent(), {
selectedItems: selectedItems.map((item) => {
return getItemByKey(item.getAttribute('data-key'));
})
})
);
}

const filterComponent = useMemo(() => {
if (loading) {
return (
Expand All @@ -68,6 +81,16 @@ const FilterItem: FC<FilterItemPropTypes> = forwardRef((props: FilterItemPropTyp
switch (type) {
case FilterType.Default:
return <Input placeholder={placeholder} onChange={onSelect} style={{ width: '100%' }} />;
case FilterType.MultiSelect:
return (
<MultiComboBox onSelectionChange={onMultiCbChange}>
{filterItems.map((item) => (
<StandardListItem data-key={item.key} key={item.key}>
{item.text}
</StandardListItem>
))}
</MultiComboBox>
);
case FilterType.Select:
return (
<Select onChange={onSelect} style={{ width: '100%' }}>
Expand Down
1 change: 1 addition & 0 deletions packages/main/src/enums/FilterType.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
export enum FilterType {
Default = 'Default',
Select = 'Select',
MultiSelect = 'MultiSelect',
Custom = 'Custom'
}