Skip to content

Improvements for auto-select opt-in mode #4914

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
ThomasMichon merged 3 commits into from
May 23, 2018
Merged

Improvements for auto-select opt-in mode #4914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
941b78c
Pass SelectionZone props through DetailsList
ThomasMichon May 18, 2018
2511415
Rename 'data-selection-select' to 'data-selection-auto-select' to mat…
ThomasMichon May 18, 2018
8824ed1
Update change output
ThomasMichon May 18, 2018
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
11 changes: 11 additions & 0 deletions common/changes/office-ui-fabric-react/auto-select_2018-05-18-15-47.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"changes": [
{
"packageName": "office-ui-fabric-react",
"comment": "Pass SelectionZone props through DetailsList and add alternate data-selection-auto-selection attribute name",
"type": "minor"
}
],
"packageName": "office-ui-fabric-react",
"email": "tmichon@microsoft.com"
}
2 changes: 2 additions & 0 deletions packages/office-ui-fabric-react/src/components/DetailsList/DetailsList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,7 @@ export class DetailsList extends BaseComponent<IDetailsListProps, IDetailsListSt
onColumnHeaderContextMenu,
selectionMode,
selectionPreservedOnEmptyClick,
selectionZoneProps,
ariaLabel,
ariaLabelForGrid,
rowElementEventMap,
Expand Down Expand Up @@ -392,6 +393,7 @@ export class DetailsList extends BaseComponent<IDetailsListProps, IDetailsListSt
onItemInvoked={ onItemInvoked }
onItemContextMenu={ onItemContextMenu }
enterModalOnTouch={ this.props.enterModalSelectionOnTouch }
{ ...(selectionZoneProps || {}) }
Copy link
Copy Markdown
Member

@JasonGore JasonGore May 18, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Is {} needed? Spreading undefined object should be ok

Copy link
Copy Markdown
Member Author

@ThomasMichon ThomasMichon May 22, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

According to ES6, {} is needed because otherwise it would fail. TypeScript's implementation just doesn't fail, though.

Edit: clarified language.

>
{ groups ? (
<GroupedList
Expand Down
8 changes: 7 additions & 1 deletion packages/office-ui-fabric-react/src/components/DetailsList/DetailsList.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ import * as React from 'react';
import { DetailsList } from './DetailsList';
import {
ISelection,
SelectionMode
SelectionMode,
ISelectionZoneProps
} from '../../utilities/selection/index';
import { IRenderFunction } from '../../Utilities';
import {
Expand Down Expand Up @@ -92,6 +93,11 @@ export interface IDetailsListProps extends React.Props<DetailsList>, IWithViewpo
**/
selectionPreservedOnEmptyClick?: boolean;

/**
* Addition props to pass through to the selection zone created by default.
*/
selectionZoneProps?: ISelectionZoneProps;

/** Controls how the columns are adjusted. */
layoutMode?: DetailsListLayoutMode;

Expand Down
7 changes: 6 additions & 1 deletion packages/office-ui-fabric-react/src/utilities/selection/SelectionZone.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,10 +241,15 @@ describe('SelectionZone', () => {
expect(_selection.isIndexSelected(1)).toEqual(false);
});

it('select an item when a button is clicked that has data-selection-select', () => {
it('selects an item when a button is clicked that has data-selection-select', () => {
ReactTestUtils.Simulate.mouseDown(_select1);
expect(_selection.isIndexSelected(1)).toEqual(true);
});

it('selects an item when a button is clicked that has data-selection-select', () => {
ReactTestUtils.Simulate.keyDown(_select1, { which: KeyCodes.enter });
expect(_selection.isIndexSelected(1)).toEqual(true);
});
});

function _simulateClick(el: Element, eventData?: ReactTestUtils.SyntheticEventData): void {
Expand Down
17 changes: 15 additions & 2 deletions packages/office-ui-fabric-react/src/utilities/selection/SelectionZone.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,8 @@ export class SelectionZone extends BaseComponent<ISelectionZoneProps, {}> {
break;
} else if (this._hasAttribute(target, SELECTION_INVOKE_ATTRIBUTE_NAME)) {
break;
} else if ((target === itemRoot || this._hasAttribute(target, SELECTION_SELECT_ATTRIBUTE_NAME))
} else if (
(target === itemRoot || this._shouldAutoSelect(target))
&& !this._isShiftPressed && !this._isCtrlPressed) {
this._onInvokeMouseDown(ev, this._getItemIndex(itemRoot));
break;
Expand Down Expand Up @@ -376,6 +377,11 @@ export class SelectionZone extends BaseComponent<ISelectionZoneProps, {}> {
// For toggle elements, assuming they are rendered as buttons, they will generate a click event,
// so we can no-op for any keydowns in this case.
break;
} else if (this._shouldAutoSelect(target)) {
// If the event went to an element which should trigger auto-select, select it and then let
// the default behavior kick in.
this._onInvokeMouseDown(ev, index);
break;
} else if ((ev.which === KeyCodes.enter || ev.which === KeyCodes.space) &&
(target.tagName === 'BUTTON' || target.tagName === 'A' || target.tagName === 'INPUT')) {
return false;
Expand Down Expand Up @@ -441,7 +447,10 @@ export class SelectionZone extends BaseComponent<ISelectionZoneProps, {}> {
}

private _onInvokeClick(ev: React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement>, index: number): void {
const { selection, onItemInvoked } = this.props;
const {
selection,
onItemInvoked
} = this.props;

if (onItemInvoked) {
onItemInvoked(selection.getItems()[index], index, ev.nativeEvent);
Expand Down Expand Up @@ -540,6 +549,10 @@ export class SelectionZone extends BaseComponent<ISelectionZoneProps, {}> {
return Number(itemRoot.getAttribute(SELECTION_INDEX_ATTRIBUTE_NAME));
}

private _shouldAutoSelect(element: HTMLElement): boolean {
return this._hasAttribute(element, SELECTION_SELECT_ATTRIBUTE_NAME);
}

private _hasAttribute(element: HTMLElement, attributeName: string): boolean {
let isToggle = false;

Expand Down