dragselect 2.5.4 → 2.5.6
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.
- package/CHANGELOG.md +8 -0
- package/deployment.md +32 -0
- package/dist/DragSelect.d.ts +2 -2
- package/dist/DragSelect.es6m.js +193 -114
- package/dist/DragSelect.js +194 -115
- package/dist/ds.es6m.min.js +1 -1
- package/dist/ds.min.js +1 -1
- package/dist/modules/Interaction.d.ts +1 -1
- package/package.json +16 -23
- package/rollup.config.js +4 -23
- package/src/DragSelect.js +45 -11
- package/src/modules/Area.js +3 -2
- package/src/modules/Interaction.js +8 -5
- package/CODE_OF_CONDUCT.md +0 -128
- package/CONTRIBUTING.md +0 -48
- package/LICENSE +0 -21
- package/README.md +0 -470
- package/deploying.md +0 -36
- package/jsdoc.json +0 -18
- package/todos.md +0 -10
package/package.json
CHANGED
|
@@ -1,34 +1,28 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dragselect",
|
|
3
|
-
"version": "2.5.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "2.5.6",
|
|
4
|
+
"description": "Easy JavaScript library for selecting and moving elements. With no dependencies. Drag-Select & Drag-And-Drop.",
|
|
5
5
|
"main": "./dist/DragSelect.js",
|
|
6
6
|
"types": "./dist/DragSelect.d.ts",
|
|
7
7
|
"scripts": {
|
|
8
8
|
"open": "open __tests__/quicktest.html -a 'Google Chrome'",
|
|
9
|
-
"prestart": "
|
|
10
|
-
"start": "
|
|
11
|
-
"watch": "concurrently --kill-others \"
|
|
9
|
+
"prestart": "yarn",
|
|
10
|
+
"start": "yarn open & yarn watch",
|
|
11
|
+
"watch": "concurrently --kill-others \"yarn checkjs:watch\" \"yarn rollup:watch\" \"yarn test:watch\"",
|
|
12
12
|
"\n# TESTING:": "",
|
|
13
13
|
"checkjs": "tsc --lib es2019,dom -t es5 --allowJs --skipLibCheck --checkJs --noEmit src/*.js",
|
|
14
|
-
"checkjs:watch": "
|
|
15
|
-
"
|
|
16
|
-
"
|
|
17
|
-
"test": "
|
|
18
|
-
"test:watch": "
|
|
14
|
+
"checkjs:watch": "yarn checkjs -- -w",
|
|
15
|
+
"pretest": "yarn build",
|
|
16
|
+
"jest": "jest --detectOpenHandles",
|
|
17
|
+
"test": "yarn checkjs && yarn jest",
|
|
18
|
+
"test:watch": "yarn jest -- --watch",
|
|
19
19
|
"\n# BUILDING:": "",
|
|
20
|
-
"
|
|
21
|
-
"
|
|
22
|
-
"
|
|
23
|
-
"media": "cp -R .media docs/media",
|
|
24
|
-
"prerollup": "npm run types",
|
|
20
|
+
"prebuild": "yarn install",
|
|
21
|
+
"build": "yarn rollup",
|
|
22
|
+
"prerollup": "yarn types",
|
|
25
23
|
"rollup": "rollup -c",
|
|
26
|
-
"rollup:
|
|
27
|
-
"
|
|
28
|
-
"types": "tsc src/DragSelect.js --lib es2019,dom -t es5 --declaration --allowJs --emitDeclarationOnly --skipLibCheck --outDir dist",
|
|
29
|
-
"\n## PROD:": "",
|
|
30
|
-
"ci:build": "npm run rollup:ci && npm run media && npm run docs",
|
|
31
|
-
"ci:test": "npm run test"
|
|
24
|
+
"rollup:watch": "yarn rollup -- -w",
|
|
25
|
+
"types": "tsc src/DragSelect.js --lib es2019,dom -t es5 --declaration --allowJs --emitDeclarationOnly --skipLibCheck --outDir dist"
|
|
32
26
|
},
|
|
33
27
|
"devDependencies": {
|
|
34
28
|
"@babel/cli": "^7.12.10",
|
|
@@ -62,13 +56,12 @@
|
|
|
62
56
|
"glob": "^7.1.7",
|
|
63
57
|
"jest": "^26.6.3",
|
|
64
58
|
"jest-puppeteer": "^6.1.1",
|
|
65
|
-
"jsdoc": "^3.6.11",
|
|
66
59
|
"minami": "^1.2.3",
|
|
67
60
|
"prettier": "^2.2.1",
|
|
68
61
|
"puppeteer": "18.1.0",
|
|
69
62
|
"rollup": "^2.36.1",
|
|
70
63
|
"rollup-plugin-terser": "^7.0.2",
|
|
71
|
-
"typescript": "^4.
|
|
64
|
+
"typescript": "^4.9.3"
|
|
72
65
|
},
|
|
73
66
|
"repository": {
|
|
74
67
|
"type": "git",
|
package/rollup.config.js
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import babel from '@rollup/plugin-babel'
|
|
2
2
|
import fs from 'fs'
|
|
3
3
|
import glob from 'glob'
|
|
4
|
-
import path from 'path'
|
|
5
4
|
import resolve from '@rollup/plugin-node-resolve'
|
|
6
5
|
import { terser } from 'rollup-plugin-terser'
|
|
7
6
|
|
|
@@ -33,7 +32,7 @@ const banner = `/***
|
|
|
33
32
|
********* The MIT License (MIT) **********
|
|
34
33
|
******************************************
|
|
35
34
|
Created 2017 by ThibaultJanBeyer
|
|
36
|
-
web: http://www.
|
|
35
|
+
web: http://www.DragSelect.com/
|
|
37
36
|
github: https://github.com/ThibaultJanBeyer/DragSelect
|
|
38
37
|
|
|
39
38
|
*/`
|
|
@@ -45,13 +44,13 @@ export default {
|
|
|
45
44
|
file: 'dist/DragSelect.es6m.js',
|
|
46
45
|
format: 'es',
|
|
47
46
|
name: 'DragSelect',
|
|
48
|
-
banner
|
|
47
|
+
banner,
|
|
49
48
|
},
|
|
50
49
|
{
|
|
51
50
|
file: 'dist/DragSelect.js',
|
|
52
51
|
format: 'umd',
|
|
53
52
|
name: 'DragSelect',
|
|
54
|
-
banner
|
|
53
|
+
banner,
|
|
55
54
|
},
|
|
56
55
|
{
|
|
57
56
|
file: 'dist/ds.es6m.min.js',
|
|
@@ -71,30 +70,12 @@ export default {
|
|
|
71
70
|
plugins: [
|
|
72
71
|
resolve(),
|
|
73
72
|
babel({ babelHelpers: 'bundled' }),
|
|
74
|
-
{
|
|
75
|
-
name: 'copy',
|
|
76
|
-
writeBundle(options) {
|
|
77
|
-
if (!process.argv.includes('--ci')) return
|
|
78
|
-
if (!fs.existsSync('docs/')) fs.mkdirSync('docs')
|
|
79
|
-
fs.copyFileSync(
|
|
80
|
-
`.v1/${path.basename(options.file)}`,
|
|
81
|
-
`docs/${path.basename(options.file)}`
|
|
82
|
-
)
|
|
83
|
-
console.log(
|
|
84
|
-
`.v1/${path.basename(options.file)}`,
|
|
85
|
-
`docs/${path.basename(options.file)}`
|
|
86
|
-
)
|
|
87
|
-
if (!fs.existsSync('docs/v2')) fs.mkdirSync('docs/v2')
|
|
88
|
-
fs.copyFileSync(options.file, `docs/v2/${path.basename(options.file)}`)
|
|
89
|
-
console.log(options.file, `docs/v2/${path.basename(options.file)}`)
|
|
90
|
-
},
|
|
91
|
-
},
|
|
92
73
|
{
|
|
93
74
|
name: 'add-types', // solves build issue caused by types (#100)
|
|
94
75
|
writeBundle() {
|
|
95
76
|
if (typesDone) return
|
|
96
77
|
typesDone = true
|
|
97
|
-
console.
|
|
78
|
+
console.info(`Adding types to all ts files`)
|
|
98
79
|
glob('dist/**/*.d.ts', (er, files) => {
|
|
99
80
|
if (er) throw er
|
|
100
81
|
files.forEach((fileName) => {
|
package/src/DragSelect.js
CHANGED
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
********* The MIT License (MIT) **********
|
|
20
20
|
******************************************
|
|
21
21
|
Copyright (c) 2017 ThibaultJanBeyer
|
|
22
|
-
web: http://www.
|
|
22
|
+
web: http://www.dragselect.com/
|
|
23
23
|
github: https://github.com/ThibaultJanBeyer/DragSelect
|
|
24
24
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
25
25
|
of this software and associated documentation files (the "Software"), to deal
|
|
@@ -59,7 +59,7 @@ import { PointerStore, ScrollStore, KeyStore, SettingsStore } from './stores'
|
|
|
59
59
|
import { toArray, subscriberAliases } from './methods'
|
|
60
60
|
|
|
61
61
|
// Setup
|
|
62
|
-
|
|
62
|
+
/// ///////////////////////////////////////////////////////////////////////////////////
|
|
63
63
|
|
|
64
64
|
class DragSelect {
|
|
65
65
|
/**
|
|
@@ -67,6 +67,7 @@ class DragSelect {
|
|
|
67
67
|
* @type {boolean}
|
|
68
68
|
*/
|
|
69
69
|
continue = false
|
|
70
|
+
|
|
70
71
|
/**
|
|
71
72
|
* @class DragSelect
|
|
72
73
|
* @constructor DragSelect
|
|
@@ -113,7 +114,7 @@ class DragSelect {
|
|
|
113
114
|
}
|
|
114
115
|
|
|
115
116
|
// Useful methods for the user
|
|
116
|
-
|
|
117
|
+
/// ///////////////////////////////////////////////////////////////////////////////////
|
|
117
118
|
/**
|
|
118
119
|
* Initializes the functionality. Automatically triggered when created.
|
|
119
120
|
* Also, reset the functionality after a teardown
|
|
@@ -122,6 +123,7 @@ class DragSelect {
|
|
|
122
123
|
this.stopped = false
|
|
123
124
|
this.Interaction.init()
|
|
124
125
|
}
|
|
126
|
+
|
|
125
127
|
/**
|
|
126
128
|
* Complete function teardown
|
|
127
129
|
* Will teardown/stop the whole functionality
|
|
@@ -146,23 +148,27 @@ class DragSelect {
|
|
|
146
148
|
|
|
147
149
|
this.stopped = true
|
|
148
150
|
}
|
|
151
|
+
|
|
149
152
|
/**
|
|
150
153
|
* Utility to override DragSelect internal functionality:
|
|
151
154
|
* Break will skip the selection or dragging functionality (until after the callback) but let everything continue to run.
|
|
152
155
|
* Useful utility to write your own functionality/move/dragNdrop based on DragSelect pointer positions.
|
|
153
156
|
*/
|
|
154
157
|
break = () => (this.continue = true)
|
|
158
|
+
|
|
155
159
|
/**
|
|
156
160
|
* Update any setting dynamically
|
|
157
161
|
* @param {Settings} settings
|
|
158
162
|
* @return {void}
|
|
159
163
|
*/
|
|
160
164
|
setSettings = (settings) => this.stores.SettingsStore.update({ settings })
|
|
165
|
+
|
|
161
166
|
/**
|
|
162
167
|
* Returns the current selected nodes
|
|
163
168
|
* @return {DSElements}
|
|
164
169
|
*/
|
|
165
170
|
getSelection = () => this.SelectedSet.elements
|
|
171
|
+
|
|
166
172
|
/**
|
|
167
173
|
* Adds several elements to the selection list also adds the specific classes and take into account all calculations.
|
|
168
174
|
* Does not clear the selection, in contrary to .setSelection. Can add multiple elements at once
|
|
@@ -182,6 +188,7 @@ class DragSelect {
|
|
|
182
188
|
this.PubSub.publish('callback', { items: this.getSelection() })
|
|
183
189
|
return this.getSelection()
|
|
184
190
|
}
|
|
191
|
+
|
|
185
192
|
/**
|
|
186
193
|
* Removes specific elements from the selection
|
|
187
194
|
* Multiple elements can be given at once, in contrary to unselect
|
|
@@ -201,25 +208,31 @@ class DragSelect {
|
|
|
201
208
|
this.PubSub.publish('callback', { items: this.getSelection() })
|
|
202
209
|
return this.getSelection()
|
|
203
210
|
}
|
|
211
|
+
|
|
204
212
|
/**
|
|
205
213
|
* Toggles specific elements from the selection:
|
|
206
214
|
* If element is not in selection it will be added, if it is already selected, it will be removed.
|
|
207
215
|
* Multiple elements can be given at once.
|
|
208
216
|
* @param {DSInputElements} elements one or multiple elements
|
|
209
217
|
* @param {boolean} [triggerCallback] - if callback should be called
|
|
210
|
-
* @param {boolean} [
|
|
218
|
+
* @param {boolean} [removeFromSelectables] - if element should not be added/removed to the list of selectable elements accordingly
|
|
211
219
|
* @return {DSElements} all selected elements
|
|
212
220
|
*/
|
|
213
|
-
toggleSelection(
|
|
221
|
+
toggleSelection(
|
|
222
|
+
elements,
|
|
223
|
+
triggerCallback = false,
|
|
224
|
+
removeFromSelectables = false
|
|
225
|
+
) {
|
|
214
226
|
toArray(elements).forEach((el) =>
|
|
215
227
|
this.SelectedSet.has(el)
|
|
216
|
-
? this.removeSelection(elements, triggerCallback,
|
|
217
|
-
: this.addSelection(elements, triggerCallback,
|
|
228
|
+
? this.removeSelection(elements, triggerCallback, removeFromSelectables)
|
|
229
|
+
: this.addSelection(elements, triggerCallback, removeFromSelectables)
|
|
218
230
|
)
|
|
219
231
|
if (triggerCallback)
|
|
220
232
|
this.PubSub.publish('callback', { items: this.getSelection() })
|
|
221
233
|
return this.getSelection()
|
|
222
234
|
}
|
|
235
|
+
|
|
223
236
|
/**
|
|
224
237
|
* Sets the current selected elements and optionally run the callback
|
|
225
238
|
* By default, adds new elements also to the list of selectables
|
|
@@ -237,6 +250,7 @@ class DragSelect {
|
|
|
237
250
|
this.addSelection(elements, triggerCallback, dontAddToSelectables)
|
|
238
251
|
return this.getSelection()
|
|
239
252
|
}
|
|
253
|
+
|
|
240
254
|
/**
|
|
241
255
|
* Unselect / Deselect all current selected Nodes
|
|
242
256
|
* @param {boolean} [triggerCallback] - if callback should be called
|
|
@@ -248,6 +262,7 @@ class DragSelect {
|
|
|
248
262
|
this.PubSub.publish('callback', { items: this.getSelection() })
|
|
249
263
|
return this.getSelection()
|
|
250
264
|
}
|
|
265
|
+
|
|
251
266
|
/**
|
|
252
267
|
* Add elements that can be selected. No node is added twice
|
|
253
268
|
* @param {DSInputElements} elements dom element(s)
|
|
@@ -263,11 +278,13 @@ class DragSelect {
|
|
|
263
278
|
this.PubSub.publish('callback', { items: this.getSelection() })
|
|
264
279
|
return elements
|
|
265
280
|
}
|
|
281
|
+
|
|
266
282
|
/**
|
|
267
283
|
* Gets all nodes that can potentially be selected
|
|
268
284
|
* @return {DSElements} this.selectables
|
|
269
285
|
*/
|
|
270
286
|
getSelectables = () => this.SelectableSet.elements
|
|
287
|
+
|
|
271
288
|
/**
|
|
272
289
|
* Sets all elements that can be selected.
|
|
273
290
|
* Removes all current selectables (& their respective classes).
|
|
@@ -282,10 +299,13 @@ class DragSelect {
|
|
|
282
299
|
removeFromSelection = false,
|
|
283
300
|
addToSelection = false
|
|
284
301
|
) {
|
|
285
|
-
console.warn(
|
|
302
|
+
console.warn(
|
|
303
|
+
'[DragSelect] DEPRECATION ".setSelectables" is deprecated and will be removed soon. Please use "ds.setSettings({ selectables: << new dom elements >> })" instead (see docs)'
|
|
304
|
+
)
|
|
286
305
|
this.removeSelectables(elements, removeFromSelection)
|
|
287
306
|
return this.addSelectables(elements, addToSelection)
|
|
288
307
|
}
|
|
308
|
+
|
|
289
309
|
/**
|
|
290
310
|
* Remove elements from the elements that can be selected.
|
|
291
311
|
* @param {DSInputElements} elements – dom element(s)
|
|
@@ -300,49 +320,63 @@ class DragSelect {
|
|
|
300
320
|
this.PubSub.publish('callback', { items: this.getSelection() })
|
|
301
321
|
return elements
|
|
302
322
|
}
|
|
323
|
+
|
|
303
324
|
/** The starting/initial position of the cursor/selector @return {Vect2} */
|
|
304
325
|
getInitialCursorPosition = () => this.stores.PointerStore.initialVal
|
|
326
|
+
|
|
305
327
|
/** The last seen position of the cursor/selector @return {Vect2} */
|
|
306
328
|
getCurrentCursorPosition = () => this.stores.PointerStore.currentVal
|
|
329
|
+
|
|
307
330
|
/** The previous position of the cursor/selector @return {Vect2} */
|
|
308
331
|
getPreviousCursorPosition = () => this.stores.PointerStore.lastVal
|
|
332
|
+
|
|
309
333
|
/** The starting/initial position of the cursor/selector @return {Vect2} */
|
|
310
334
|
getInitialCursorPositionArea = () => this.stores.PointerStore.initialValArea
|
|
335
|
+
|
|
311
336
|
/** The last seen position of the cursor/selector @return {Vect2} */
|
|
312
337
|
getCurrentCursorPositionArea = () => this.stores.PointerStore.currentValArea
|
|
338
|
+
|
|
313
339
|
/** The previous position of the cursor/selector @return {Vect2} */
|
|
314
340
|
getPreviousCursorPositionArea = () => this.stores.PointerStore.lastValArea
|
|
341
|
+
|
|
315
342
|
/**
|
|
316
343
|
* Whether the multi-selection key was pressed
|
|
317
344
|
* @param {DSEvent|KeyboardEvent} [event]
|
|
318
345
|
* @return {boolean}
|
|
319
346
|
*/
|
|
320
347
|
isMultiSelect = (event) => this.stores.KeyStore.isMultiSelectKeyPressed(event)
|
|
348
|
+
|
|
321
349
|
/**
|
|
322
350
|
* Whether the user is currently drag n dropping elements (instead of selection)
|
|
323
351
|
* @return {boolean}
|
|
324
352
|
*/
|
|
325
353
|
isDragging = () => this.Interaction.isDragging
|
|
354
|
+
|
|
326
355
|
/**
|
|
327
356
|
* Returns first DropsZone under coordinates,
|
|
328
357
|
* if no coordinated provided current pointer coordinates are used
|
|
329
358
|
* @param {Vect2} [coordinates]
|
|
330
359
|
* @returns {DSDropZone | undefined}
|
|
331
360
|
*/
|
|
332
|
-
getZoneByCoordinates = (coordinates) =>
|
|
361
|
+
getZoneByCoordinates = (coordinates) =>
|
|
362
|
+
this.DropZones.getTarget(coordinates)?.toObject()
|
|
363
|
+
|
|
333
364
|
/**
|
|
334
365
|
* Returns itemsDropped into zone by zone id
|
|
335
366
|
* @param {string} zoneId
|
|
336
367
|
* @returns {DSElements|void}
|
|
337
368
|
*/
|
|
338
|
-
getItemsDroppedByZoneId = (zoneId) =>
|
|
369
|
+
getItemsDroppedByZoneId = (zoneId) =>
|
|
370
|
+
this.DropZones.getItemsDroppedById(zoneId)
|
|
371
|
+
|
|
339
372
|
/**
|
|
340
373
|
* Returns itemsInside by zone id
|
|
341
374
|
* @param {string} zoneId
|
|
342
375
|
* @param {boolean} addClasses whether or not to add/remove the "inside" classes to the items
|
|
343
376
|
* @returns {DSElements|void}
|
|
344
377
|
*/
|
|
345
|
-
getItemsInsideByZoneId = (zoneId, addClasses) =>
|
|
378
|
+
getItemsInsideByZoneId = (zoneId, addClasses) =>
|
|
379
|
+
this.DropZones.getItemsInsideById(zoneId, addClasses)
|
|
346
380
|
}
|
|
347
381
|
|
|
348
382
|
export default DragSelect
|
package/src/modules/Area.js
CHANGED
|
@@ -64,9 +64,9 @@ export default class Area {
|
|
|
64
64
|
|
|
65
65
|
this.setArea(this.DS.stores.SettingsStore.s.area)
|
|
66
66
|
// @ts-ignore: @todo: update to typescript
|
|
67
|
-
this.DS.PubSub.subscribe('Settings:updated:area', ({ settings }) =>
|
|
67
|
+
this.DS.PubSub.subscribe('Settings:updated:area', ({ settings }) => {
|
|
68
68
|
this.setArea(settings.area)
|
|
69
|
-
)
|
|
69
|
+
})
|
|
70
70
|
|
|
71
71
|
this.DS.PubSub.subscribe('Interaction:init', this.start)
|
|
72
72
|
this.DS.PubSub.subscribe('Interaction:end', this.reset)
|
|
@@ -74,6 +74,7 @@ export default class Area {
|
|
|
74
74
|
|
|
75
75
|
/** @param {DSArea} area */
|
|
76
76
|
setArea = (area) => {
|
|
77
|
+
this.reset()
|
|
77
78
|
this._node = area
|
|
78
79
|
handleElementPositionAttribute({
|
|
79
80
|
computedStyle: this.computedStyle,
|
|
@@ -18,7 +18,10 @@ export default class Interaction {
|
|
|
18
18
|
this.DS = DS
|
|
19
19
|
this.Settings = DS.stores.SettingsStore.s
|
|
20
20
|
// @ts-ignore: @todo: update to typescript
|
|
21
|
-
this.DS.subscribe('Settings:updated:area',
|
|
21
|
+
this.DS.subscribe('Settings:updated:area', ({ settings }) => {
|
|
22
|
+
this.stop(settings['area:pre'])
|
|
23
|
+
this.init()
|
|
24
|
+
})
|
|
22
25
|
this.DS.subscribe('PointerStore:updated', this.update)
|
|
23
26
|
this.DS.subscribe('Selectable:click', this.onClick)
|
|
24
27
|
this.DS.subscribe('Selectable:pointer', ({ event }) => this.start(event))
|
|
@@ -156,24 +159,24 @@ export default class Interaction {
|
|
|
156
159
|
this.reset() // simulate mouse-up (that does not exist on keyboard)
|
|
157
160
|
}
|
|
158
161
|
|
|
159
|
-
stop = () => {
|
|
162
|
+
stop = (area = this.DS.Area.HTMLNode) => {
|
|
160
163
|
this.isInteracting = false
|
|
161
164
|
this.isDragging = false
|
|
162
165
|
|
|
163
166
|
// @TODO: fix pointer events mixing issue see [PR](https://github.com/ThibaultJanBeyer/DragSelect/pull/128#issuecomment-1154885289)
|
|
164
167
|
if (this.Settings.usePointerEvents) {
|
|
165
|
-
|
|
168
|
+
area.removeEventListener('pointerdown', this.start, {
|
|
166
169
|
// @ts-ignore
|
|
167
170
|
passive: false,
|
|
168
171
|
})
|
|
169
172
|
document.removeEventListener('pointerup', this.reset)
|
|
170
173
|
document.removeEventListener('pointercancel', this.reset)
|
|
171
174
|
} else {
|
|
172
|
-
|
|
175
|
+
area.removeEventListener('mousedown', this.start)
|
|
173
176
|
document.removeEventListener('mouseup', this.reset)
|
|
174
177
|
}
|
|
175
178
|
|
|
176
|
-
|
|
179
|
+
area.removeEventListener('touchstart', this.start, {
|
|
177
180
|
// @ts-ignore
|
|
178
181
|
passive: false,
|
|
179
182
|
})
|
package/CODE_OF_CONDUCT.md
DELETED
|
@@ -1,128 +0,0 @@
|
|
|
1
|
-
# Contributor Covenant Code of Conduct
|
|
2
|
-
|
|
3
|
-
## Our Pledge
|
|
4
|
-
|
|
5
|
-
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
-
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
-
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
-
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
-
nationality, personal appearance, race, religion, or sexual identity
|
|
10
|
-
and orientation.
|
|
11
|
-
|
|
12
|
-
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
-
diverse, inclusive, and healthy community.
|
|
14
|
-
|
|
15
|
-
## Our Standards
|
|
16
|
-
|
|
17
|
-
Examples of behavior that contributes to a positive environment for our
|
|
18
|
-
community include:
|
|
19
|
-
|
|
20
|
-
* Demonstrating empathy and kindness toward other people
|
|
21
|
-
* Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
-
* Giving and gracefully accepting constructive feedback
|
|
23
|
-
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
-
and learning from the experience
|
|
25
|
-
* Focusing on what is best not just for us as individuals, but for the
|
|
26
|
-
overall community
|
|
27
|
-
|
|
28
|
-
Examples of unacceptable behavior include:
|
|
29
|
-
|
|
30
|
-
* The use of sexualized language or imagery, and sexual attention or
|
|
31
|
-
advances of any kind
|
|
32
|
-
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
-
* Public or private harassment
|
|
34
|
-
* Publishing others' private information, such as a physical or email
|
|
35
|
-
address, without their explicit permission
|
|
36
|
-
* Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
-
professional setting
|
|
38
|
-
|
|
39
|
-
## Enforcement Responsibilities
|
|
40
|
-
|
|
41
|
-
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
-
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
-
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
-
or harmful.
|
|
45
|
-
|
|
46
|
-
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
-
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
-
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
-
decisions when appropriate.
|
|
50
|
-
|
|
51
|
-
## Scope
|
|
52
|
-
|
|
53
|
-
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
-
an individual is officially representing the community in public spaces.
|
|
55
|
-
Examples of representing our community include using an official e-mail address,
|
|
56
|
-
posting via an official social media account, or acting as an appointed
|
|
57
|
-
representative at an online or offline event.
|
|
58
|
-
|
|
59
|
-
## Enforcement
|
|
60
|
-
|
|
61
|
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
-
reported to the community leaders responsible for enforcement at
|
|
63
|
-
https://github.com/ThibaultJanBeyer/DragSelect/discussions.
|
|
64
|
-
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
|
-
|
|
66
|
-
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
-
reporter of any incident.
|
|
68
|
-
|
|
69
|
-
## Enforcement Guidelines
|
|
70
|
-
|
|
71
|
-
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
-
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
-
|
|
74
|
-
### 1. Correction
|
|
75
|
-
|
|
76
|
-
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
-
unprofessional or unwelcome in the community.
|
|
78
|
-
|
|
79
|
-
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
-
clarity around the nature of the violation and an explanation of why the
|
|
81
|
-
behavior was inappropriate. A public apology may be requested.
|
|
82
|
-
|
|
83
|
-
### 2. Warning
|
|
84
|
-
|
|
85
|
-
**Community Impact**: A violation through a single incident or series
|
|
86
|
-
of actions.
|
|
87
|
-
|
|
88
|
-
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
-
interaction with the people involved, including unsolicited interaction with
|
|
90
|
-
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
-
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
-
like social media. Violating these terms may lead to a temporary or
|
|
93
|
-
permanent ban.
|
|
94
|
-
|
|
95
|
-
### 3. Temporary Ban
|
|
96
|
-
|
|
97
|
-
**Community Impact**: A serious violation of community standards, including
|
|
98
|
-
sustained inappropriate behavior.
|
|
99
|
-
|
|
100
|
-
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
-
communication with the community for a specified period of time. No public or
|
|
102
|
-
private interaction with the people involved, including unsolicited interaction
|
|
103
|
-
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
-
Violating these terms may lead to a permanent ban.
|
|
105
|
-
|
|
106
|
-
### 4. Permanent Ban
|
|
107
|
-
|
|
108
|
-
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
-
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
-
individual, or aggression toward or disparagement of classes of individuals.
|
|
111
|
-
|
|
112
|
-
**Consequence**: A permanent ban from any sort of public interaction within
|
|
113
|
-
the community.
|
|
114
|
-
|
|
115
|
-
## Attribution
|
|
116
|
-
|
|
117
|
-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
-
version 2.0, available at
|
|
119
|
-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
|
120
|
-
|
|
121
|
-
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
|
122
|
-
enforcement ladder](https://github.com/mozilla/diversity).
|
|
123
|
-
|
|
124
|
-
[homepage]: https://www.contributor-covenant.org
|
|
125
|
-
|
|
126
|
-
For answers to common questions about this code of conduct, see the FAQ at
|
|
127
|
-
https://www.contributor-covenant.org/faq. Translations are available at
|
|
128
|
-
https://www.contributor-covenant.org/translations.
|
package/CONTRIBUTING.md
DELETED
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
# DragSelect Developers Guide
|
|
2
|
-
|
|
3
|
-
## Collaborate
|
|
4
|
-
|
|
5
|
-
Since I’ve not so much free time, contributions are very welcome.
|
|
6
|
-
Please follow this [tutorial on collaborating via github](https://www.youtube.com/watch?time_continue=4&v=81uKcXZoQ2A).
|
|
7
|
-
Thanks in advance!
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
## Setup
|
|
11
|
-
|
|
12
|
-
The project is kept as simple as possible, so it is very easy to set up.
|
|
13
|
-
Actually, you don’t need to do anything. You will find all work files under `src/`.
|
|
14
|
-
I.e. `src/DragSelect.js`. Don’t touch the files in `docs/` nor in `dist/`. They are automatically generated.
|
|
15
|
-
|
|
16
|
-
Run:
|
|
17
|
-
|
|
18
|
-
```
|
|
19
|
-
npm start
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
it will install dependencies & run the dev mode (& on osx open `tests/quicktest.html` for your convenience).
|
|
23
|
-
|
|
24
|
-
*Note: opening quicktest will fail on other operating systems than Mac because I’m using the mac specific `open` command to open the file. However, that is not an issue and you can go on opening the file manually.*
|
|
25
|
-
|
|
26
|
-
Now whenever you make a change to the `DragSelect.js` in `src/` it will be transpiled and updated in `docs/` and `dist/` automatically. This is important since clients use those files.
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
## Testing
|
|
30
|
-
|
|
31
|
-
- You will want to see if your changes work, use `tests/quicktest.html`. Modify that file as much as you want to match your test cases.
|
|
32
|
-
|
|
33
|
-
### Automatic
|
|
34
|
-
|
|
35
|
-
For the testing puppeteer and jest is used. Puppeteer will be installed locally, but can be a bit heavy (~200mb) you can use the [Environment Variables](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#environment-variables) if you have puppeteer installed already.
|
|
36
|
-
|
|
37
|
-
Automated tests are run via:
|
|
38
|
-
|
|
39
|
-
```
|
|
40
|
-
npm test
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
- If you feel like your test case should be permanently tested before each release, please add it to the `__tests__` folder.
|
|
44
|
-
|
|
45
|
-
## NOTES
|
|
46
|
-
|
|
47
|
-
- Be extra careful with changes that affect the customer facing apis:
|
|
48
|
-
- - when changing/updating/removing topics (publish/subscribe). As these could be used
|
package/LICENSE
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2017 Thibault Jan Beyer
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|