@fundamental-ngx/core 0.33.4-rc.6 → 0.33.4

package/utils/helpers/range-selector.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Utility type, that allows to track and select ranges of elements while using multi-selection.
+ *
+ * @usage
+ * Imagine we have a simple list of checkboxes:
+ * ```html
+ * <input
+ *  #checkboxInput
+ *  *ngFor="let o of options; let idx = index"
+ *  type="checkbox"
+ *  [checked]="selectionModel.checked(o)"
+ *  (click)="toggle(idx, $event)"
+ *  >
+ * ```
+ * With the given layout the logic should be as follows:
+ * ```typescript
+ * export class YourComponent {
+ *  options = ['a', 'b', 'c'];
+ *  readonly selectionModel = new SelectionModel(true);
+ *
+ *  private readonly _rangeSelector = new RangeSelector();
+ *
+ *
+ *  toggle(idx: number, event: PointerEvent): void {
+ *      // getting the toggled value of the checkbox
+ *      const toggledSelection = event.target.value;
+ *
+ *      // registering the selection of current checkbox
+ *      this._rangeSelector.onRangeElementToggled(idx, event);
+ *
+ *      // Apply value to each element in range.
+ *      // If checkbox was toggled without shift pressed or without previously selected one,
+ *      // this method will select only it.
+ *      this._rangeSelector.applyValueToEachInRange(idx => {
+ *          if (toggledSelection) {
+ *              this.selectionModel.select(options[idx]);
+ *          } else {
+ *              this.selectionModel.deselect(options[idx]);
+ *          }
+ *      });
+ *  }
+ * }
+ * ```
+ */
+export declare class RangeSelector {
+    /** @hidden */
+    private _previousSelectedIndex;
+    /** @hidden */
+    private _state;
+    /**
+     * Last registered selection state (either multiple or single).
+     * Is updated on each `onRangeElementClicked` invokation. Will be `null` initially or once `reset()` is called.
+     */
+    get lastRangeSelectionState(): RangeSelectionState | null;
+    /**
+     * The method that should be used to register each checkbox toggle.
+     * Accepts two arguments: `index` and `event`. If none provided, will reset existing state.
+     * Otherwise will register current index as last checked.
+     *
+     * If toggling was done with "shift" pressed and there's a previously registered index, will register a range selection.
+     * At the same time if checkbox was toggled without shift pressed or without previously selected one, this method will select only it.
+     *
+     * After calling this method it's recommended to use `applyValueToEachInRange` to actually toggle each checkbox in range.
+     *
+     * See usage example on this class itself.
+     */
+    onRangeElementToggled(index?: number, event?: KeyboardEvent | MouseEvent | TouchEvent): RangeSelectionState;
+    /**
+     * Allows to apply selection to each item in selection range.
+     * Accepts a function to apply selection to each item by registered index.
+     *
+     * See usage example on this class itself.
+     */
+    applyValueToEachInRange(selectionMethod: (index: number) => void): void;
+    /** Resets selection state. Useful when the list of selectable items is changed (e.g. by filtering, sorting, page change) */
+    reset(): void;
+    /** @hidden */
+    private _isNonNegativeInteger;
+}
+export interface RangeSelectionState {
+    isRangeSelection: boolean;
+    from: number;
+    to: number;
+}

package/utils/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@fundamental-ngx/core/utils",
-  "version": "0.33.4-rc.6",
+  "version": "0.33.4",
   "peerDependencies": {
-    "@angular/common": "^13,.0.0",
-    "@angular/core": "^13,.0.0",
-    "@angular/forms": "^13,.0.0",
-    "@angular/animations": "^13,.0.0",
-    "@angular/router": "^13,.0.0",
+    "@angular/common": "^13.0.0",
+    "@angular/core": "^13.0.0",
+    "@angular/forms": "^13.0.0",
+    "@angular/animations": "^13.0.0",
+    "@angular/router": "^13.0.0",
     "rxjs": "7.5.2"
   },
   "dependencies": {

package/utils/public_api.d.ts

@@ -42,6 +42,7 @@ export * from './dynamic-component/dynamic-component-config';
 export * from './dynamic-component/dynamic-component-injector';
 export * from './dynamic-component/dynamic-component.service';
 export * from './dynamic-component/dynamic-component-container';
+export * from './helpers/range-selector';
 export * from './utils.module';
 export * from './datatypes/hash.datatype';
 export * from './datatypes/size.datatype';

package/vertical-navigation/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@fundamental-ngx/core/vertical-navigation",
-  "version": "0.33.4-rc.6",
+  "version": "0.33.4",
   "peerDependencies": {
-    "@angular/common": "^13,.0.0",
-    "@angular/core": "^13,.0.0"
+    "@angular/common": "^13.0.0",
+    "@angular/core": "^13.0.0"
   },
   "dependencies": {
     "tslib": "^2.0.0"

package/wizard/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@fundamental-ngx/core/wizard",
-  "version": "0.33.4-rc.6",
+  "version": "0.33.4",
   "peerDependencies": {
-    "@angular/common": "^13,.0.0",
-    "@angular/core": "^13,.0.0"
+    "@angular/common": "^13.0.0",
+    "@angular/core": "^13.0.0"
   },
   "dependencies": {
     "tslib": "^2.0.0"