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

feat(lib): add additive behavior #82

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all 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
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@ shortcuts: {
| selectMode | Boolean | `false` | If set to `true`, a _toggle_ mode is activated similar to the `toggleSingleItem` shortcut. Useful for mobile. |
| custom | Boolean | `false` | If set to `true`, all default styles for selected items will not be applied. |
| selectWithShortcut | Boolean | `false` | If set to `true`, items can only be selected when single clicking and applying a keyboard shortcut |
| additive | Boolean | `false` | If set to `true`, will add items to selection when clicking and dragging. |

Here's an example of all inputs in action:

Expand All @@ -261,7 +262,8 @@ Here's an example of all inputs in action:
[disableDrag]="true"
[selectMode]="true"
[custom]="true"
[selectWithShortcut]="false">
[selectWithShortcut]="false"
[additive]="true">
...
</dts-select-container>
```
Expand Down
35 changes: 35 additions & 0 deletions cypress/integration/clicking.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { DEFAULT_CONFIG } from '../../projects/ngx-drag-to-select/src/lib/config
import {
disableRangeSelection,
disableSelectOnDrag,
enableAdditive,
enableSelectWithShortcut,
getDesktopExample,
toggleItem
Expand Down Expand Up @@ -233,4 +234,38 @@ describe('Clicking', () => {
});
});
});

describe('Select with Additive', () => {
beforeEach(() => {
enableAdditive();
});

it('should add item to selection if clicked', () => {
getDesktopExample().within(() => {
cy.getSelectItem(0)
.dispatch('mousedown', { button: 0 })
.dispatch('mouseup')
.getSelectItem(1)
.dispatch('mousedown', { button: 0 })
.dispatch('mouseup')
.shouldSelect([1, 2]);
});
});

it('should remove the item if clicked', () => {
getDesktopExample().within(() => {
cy.getSelectItem(0)
.dispatch('mousedown', { button: 0 })
.dispatch('mouseup')
.getSelectItem(1)
.dispatch('mousedown', { button: 0 })
.dispatch('mouseup')
.shouldSelect([1, 2])
.getSelectItem(0)
.dispatch('mousedown', { button: 0 })
.dispatch('mouseup')
.shouldSelect([2]);
});
});
});
});
26 changes: 26 additions & 0 deletions cypress/integration/dragging.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {
disableSelection,
disableSelectOnDrag,
enableSelectMode,
enableAdditive,
getDesktopExample,
shouldBeInvisible,
shouldBeVisible,
Expand Down Expand Up @@ -372,6 +373,31 @@ describe('Dragging', () => {
});
});

describe('Additive', () => {
beforeEach(() => {
enableAdditive();
});

it('should extend selection after mouseup', () => {
getDesktopExample().within(() => {
cy.getSelectItem(0)
.dispatch('mousedown', { button: 0 })
.getSelectItem(5)
.dispatch('mousemove')
.dispatch('mouseup')
.shouldSelect([1, 2, 5, 6])
.getSelectItem(2)
.dispatch('mousedown', { button: 0 })
.getSelectItem(7)
.dispatch('mousemove')
.dispatch('mouseup')
.shouldSelect([1, 2, 3, 4, 5, 6, 7, 8])
.get(`.${SELECTED_CLASS}`)
.should('have.length', 8);
});
});
});

describe('Shortcuts', () => {
it('should toggle single items', () => {
getDesktopExample().within(() => {
Expand Down
4 changes: 4 additions & 0 deletions cypress/support/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ export const enableSelectWithShortcut = () => {
return cy.get('[data-cy="selectWithShortcut"]').click();
};

export const enableAdditive = () => {
return cy.get('[data-cy="additive"]').click();
};

export const selectAll = () => {
return getSelectAllButton().click();
};
Expand Down
26 changes: 16 additions & 10 deletions projects/ngx-drag-to-select/src/lib/select-container.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ export class SelectContainerComponent implements AfterViewInit, OnDestroy, After
@Input() disableRangeSelection = false;
@Input() selectMode = false;
@Input() selectWithShortcut = false;
@Input() additive = false;

@Input()
@HostBinding('class.dts-custom')
Expand Down Expand Up @@ -466,7 +467,7 @@ export class SelectContainerComponent implements AfterViewInit, OnDestroy, After
const itemRect = item.getBoundingClientRect();
const withinBoundingBox = inBoundingBox(mousePoint, itemRect);

if (this.shortcuts.extendedSelectionShortcut(event) && this.disableRangeSelection) {
if (this.shortcuts.extendedSelectionShortcut(event) && this.disableRangeSelection /* || this.additive*/) {
return;
}

Expand All @@ -482,25 +483,27 @@ export class SelectContainerComponent implements AfterViewInit, OnDestroy, After
(withinBoundingBox &&
!this.shortcuts.toggleSingleItem(event) &&
!this.selectMode &&
!this.additive &&
!this.selectWithShortcut) ||
(this.shortcuts.extendedSelectionShortcut(event) && item.selected && !this._lastRangeSelection.get(item)) ||
withinRange ||
(withinBoundingBox && this.shortcuts.toggleSingleItem(event) && !item.selected) ||
(!withinBoundingBox && this.shortcuts.toggleSingleItem(event) && item.selected) ||
(withinBoundingBox && !item.selected && this.selectMode) ||
(!withinBoundingBox && item.selected && this.selectMode);
(withinBoundingBox && !item.selected && (this.selectMode || this.additive)) ||
(!withinBoundingBox && item.selected && (this.selectMode || this.additive));

const shouldRemove =
(!withinBoundingBox &&
!this.shortcuts.toggleSingleItem(event) &&
!this.selectMode &&
!this.additive &&
!this.shortcuts.extendedSelectionShortcut(event) &&
!this.selectWithShortcut) ||
(this.shortcuts.extendedSelectionShortcut(event) && currentIndex > -1) ||
(!withinBoundingBox && this.shortcuts.toggleSingleItem(event) && !item.selected) ||
(withinBoundingBox && this.shortcuts.toggleSingleItem(event) && item.selected) ||
(!withinBoundingBox && !item.selected && this.selectMode) ||
(withinBoundingBox && item.selected && this.selectMode);
(!withinBoundingBox && !item.selected && (this.selectMode || this.additive)) ||
(withinBoundingBox && item.selected && (this.selectMode || this.additive));

if (shouldAdd) {
this._selectItem(item);
Expand Down Expand Up @@ -546,11 +549,14 @@ export class SelectContainerComponent implements AfterViewInit, OnDestroy, After
private _normalSelectionMode(selectBox: BoundingBox, item: SelectItemDirective, event: Event) {
const inSelection = boxIntersects(selectBox, item.getBoundingClientRect());

const shouldAdd = inSelection && !item.selected && !this.shortcuts.removeFromSelection(event);
const shouldAdd =
(inSelection && !item.selected && !this.shortcuts.removeFromSelection(event)) ||
(this.additive && ((inSelection && !item.selected) || (!inSelection && item.selected)));

const shouldRemove =
(!inSelection && item.selected && !this.shortcuts.addToSelection(event)) ||
(inSelection && item.selected && this.shortcuts.removeFromSelection(event));
(inSelection && item.selected && this.shortcuts.removeFromSelection(event)) ||
(this.additive && !inSelection && !item.selected);

if (shouldAdd) {
this._selectItem(item);
Expand All @@ -562,20 +568,20 @@ export class SelectContainerComponent implements AfterViewInit, OnDestroy, After
private _extendedSelectionMode(selectBox, item: SelectItemDirective, event: Event) {
const inSelection = boxIntersects(selectBox, item.getBoundingClientRect());

const shoudlAdd =
const shouldAdd =
(inSelection && !item.selected && !this.shortcuts.removeFromSelection(event) && !this._tmpItems.has(item)) ||
(inSelection && item.selected && this.shortcuts.removeFromSelection(event) && !this._tmpItems.has(item));

const shouldRemove =
(!inSelection && item.selected && this.shortcuts.addToSelection(event) && this._tmpItems.has(item)) ||
(!inSelection && !item.selected && this.shortcuts.removeFromSelection(event) && this._tmpItems.has(item));

if (shoudlAdd) {
if (shouldAdd) {
item.selected ? item._deselect() : item._select();

const action = this.shortcuts.removeFromSelection(event)
? Action.Delete
: this.shortcuts.addToSelection(event)
: this.shortcuts.addToSelection(event) || this.additive
? Action.Add
: Action.None;

Expand Down
2 changes: 2 additions & 0 deletions src/app/app.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ <h3>
>
<mat-checkbox data-cy="selectMode" [(ngModel)]="selectMode">Select Mode</mat-checkbox>
<mat-checkbox data-cy="selectWithShortcut" [(ngModel)]="selectWithShortcut">Select with Shortcut</mat-checkbox>
<mat-checkbox data-cy="additive" [(ngModel)]="additive">Additive</mat-checkbox>

<div class="action-buttons">
<button data-cy="selectAll" mat-raised-button (click)="selectContainer.selectAll()">Select All</button>
Expand All @@ -44,6 +45,7 @@ <h3>
[disableRangeSelection]="disableRangeSelection"
[selectOnDrag]="selectOnDrag"
[selectWithShortcut]="selectWithShortcut"
[additive]="additive"
>
<mat-grid-list cols="4" rowHeight="200px" gutterSize="20px">
<mat-grid-tile [dtsSelectItem]="document" *ngFor="let document of documents">
Expand Down
1 change: 1 addition & 0 deletions src/app/app.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ export class AppComponent implements OnInit {
disableRangeSelection = false;
isDesktop = false;
selectWithShortcut = false;
additive = false;

constructor(
private titleService: Title,
Expand Down