dragselect 2.3.0 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +47 -25
  3. package/deploying.md +7 -4
  4. package/dist/DragSelect.d.ts +10 -18
  5. package/dist/DragSelect.es6m.js +417 -570
  6. package/dist/DragSelect.js +417 -570
  7. package/dist/ds.es6m.min.js +1 -1
  8. package/dist/ds.min.js +1 -1
  9. package/dist/methods/createSelectorAreaElement.d.ts +1 -1
  10. package/dist/methods/getOverflowEdges.d.ts +1 -1
  11. package/dist/methods/hydrateSettings.d.ts +3 -0
  12. package/dist/methods/index.d.ts +1 -0
  13. package/dist/modules/Area.d.ts +10 -15
  14. package/dist/modules/Drag.d.ts +4 -40
  15. package/dist/modules/Interaction.d.ts +2 -24
  16. package/dist/modules/SelectableSet.d.ts +6 -38
  17. package/dist/modules/SelectedSet.d.ts +6 -10
  18. package/dist/modules/Selection.d.ts +2 -14
  19. package/dist/modules/Selector.d.ts +5 -11
  20. package/dist/modules/SelectorArea.d.ts +4 -17
  21. package/dist/stores/KeyStore.d.ts +2 -14
  22. package/dist/stores/ScrollStore.d.ts +2 -9
  23. package/dist/stores/SettingsStore.d.ts +39 -0
  24. package/dist/stores/index.d.ts +1 -0
  25. package/dist/types.d.ts +13 -32
  26. package/package.json +4 -3
  27. package/src/DragSelect.js +22 -174
  28. package/src/methods/createSelectorAreaElement.js +1 -3
  29. package/src/methods/hydrateSettings.js +109 -0
  30. package/src/methods/index.js +1 -0
  31. package/src/modules/Area.js +24 -22
  32. package/src/modules/Drag.js +37 -71
  33. package/src/modules/Interaction.js +31 -38
  34. package/src/modules/SelectableSet.js +29 -54
  35. package/src/modules/SelectedSet.js +4 -13
  36. package/src/modules/Selection.js +6 -19
  37. package/src/modules/Selector.js +21 -8
  38. package/src/modules/SelectorArea.js +12 -17
  39. package/src/stores/KeyStore.js +11 -37
  40. package/src/stores/ScrollStore.js +17 -17
  41. package/src/stores/SettingsStore.js +67 -0
  42. package/src/stores/index.js +1 -0
  43. package/src/types.js +4 -7
@@ -1,3 +1,4 @@
1
1
  export { default as KeyStore } from './KeyStore'
2
2
  export { default as PointerStore } from './PointerStore'
3
3
  export { default as ScrollStore } from './ScrollStore'
4
+ export { default as SettingsStore } from './SettingsStore'
package/src/types.js CHANGED
@@ -22,12 +22,6 @@
22
22
  * @property {string} [selectedClass=ds-selected] the class assigned to the selected items
23
23
  * @property {string} [selectorClass=ds-selector] the class assigned to the square selector helper
24
24
  * @property {string} [selectorAreaClass=ds-selector-area] the class assigned to the square in which the selector resides. By default it's invisible
25
- * @property {DSCallback} [callback] Deprecated: please use DragSelect.subscribe('callback', callback) instead
26
- * @property {DSCallback} [onDragMove] Deprecated: please use DragSelect.subscribe('onDragMove', onDragMove) instead
27
- * @property {DSCallback} [onDragStartBegin] Deprecated: please use DragSelect.subscribe('onDragStartBegin', onDragStartBegin) instead
28
- * @property {DSCallback} [onDragStart] Deprecated: please use DragSelect.subscribe('onDragStart', onDragStart) instead
29
- * @property {DSCallback} [onElementSelect] Deprecated: please use DragSelect.subscribe('onElementSelect', onElementSelect) instead
30
- * @property {DSCallback} [onElementUnselect] Deprecated: please use DragSelect.subscribe('onElementUnselect', onElementUnselect) instead
31
25
  */
32
26
 
33
27
  /**
@@ -39,6 +33,7 @@
39
33
  * @property {boolean} [isDragging] Whether the interaction is a drag or a select
40
34
  * @property {boolean} [isDraggingKeyboard] Whether or not the drag interaction is via keyboard
41
35
  * @property {string} [key] Pressed key (lowercase)
36
+ * @property {Settings} [settings] the settings being updates/manipulated/passed, also holds the previous value. i.e. updating selectorClass will publish { settings: { selectorClass: 'newVal', 'selectorClass:pre': 'oldVal' } }
42
37
  * @property {Array.<'top'|'bottom'|'left'|'right'|undefined>} [scroll_directions]
43
38
  * @property {number} [scroll_multiplier]
44
39
  */
@@ -62,7 +57,9 @@
62
57
  /** @typedef {'dragmove'|'autoscroll'|'dragstart'|'elementselect'|'elementunselect'|'callback'} DSEventNames */
63
58
  /** @typedef {'Interaction:init'|'Interaction:start'|'Interaction:end'|'Interaction:update'|'Area:modified'|'Area:scroll'|'PointerStore:updated'|'Selected:added'|'Selected:removed'|'Selectable:click'|'Selectable:pointer'|'KeyStore:down'|'KeyStore:up'} DSInternalEventNames */
64
59
  /** @typedef {'Interaction:init:pre'|'Interaction:start:pre'|'Interaction:end:pre'|'Interaction:update:pre'|'Area:modified:pre'|'Area:scroll:pre'|'PointerStore:updated:pre'|'Selected:added:pre'|'Selected:removed:pre'|'Selectable:click:pre'|'Selectable:pointer:pre'|'KeyStore:down:pre'|'KeyStore:up:pre'} DSInternalEventNamesPre */
65
- /** @typedef {DSEventNames|DSInternalEventNames|DSInternalEventNamesPre} DSCallbackNames the name of the callback */
60
+ // @todo: update to typescript for complex defs like `Settings:updated:${string}` | `Settings:updated:${string}:pre`
61
+ /** @typedef {'Settings:updated'|'Settings:updated:pre'|'Settings:updated:*'|'Settings:updated:*:pre'} DSInternalSettingEvents */
62
+ /** @typedef {DSEventNames|DSInternalEventNames|DSInternalEventNamesPre|DSInternalSettingEvents} DSCallbackNames the name of the callback */
66
63
 
67
64
  /** @typedef {{top:number,left:number,bottom:number,right:number,width:number,height:number}} DSBoundingRect */
68
65
  /** @typedef {{up:string[],down:string[],left:string[],right:string[]}} DSDragKeys */