-
Notifications
You must be signed in to change notification settings - Fork 90
/
Copy pathindex.html
349 lines (332 loc) · 18.2 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8" />
<title>React-Selectable-Fast Demo</title>
<meta content="width=device-width, initial-scale=1" name="viewport" />
<link href="css/normalize.css" media="screen" rel="stylesheet" type="text/css" />
<link
href="https://fonts.googleapis.com/css?family=Open+Sans:400,500,600,700"
rel="stylesheet"
type="text/css"
/>
<link
rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/github-fork-ribbon-css/0.2.0/gh-fork-ribbon.min.css"
/>
<link href="css/github-light.css" media="screen" rel="stylesheet" type="text/css" />
<link href="css/main.css" media="screen" rel="stylesheet" type="text/css" />
</head>
<body>
<a
title="Fork me on GitHub"
class="github-fork-ribbon"
href="https://github.com/valerybugakov/react-selectable-fast"
>
Fork me on GitHub
</a>
<section class="page-header">
<h1 class="project-name">React-selectable-fast</h1>
<h2 class="project-tagline">
Enable a React component (or group of components) to be selectable.
</h2>
<a class="btn" href="https://github.com/valerybugakov/react-selectable-fast"
>View on GitHub</a
>
<a class="btn" href="https://github.com/valerybugakov/react-selectable-fast/zipball/master"
>Download .zip</a
>
<a class="btn" href="https://github.com/valerybugakov/react-selectable-fast/tarball/master"
>Download .tar.gz</a
>
</section>
<section class="main-content">
<h1>
react-selectable-fast
<img alt="npm" src="https://img.shields.io/npm/v/react-selectable-fast.svg" />
<img alt="license" src="https://img.shields.io/npm/l/react-selectable-fast.svg" />
<img
alt="github-issues"
src="https://img.shields.io/github/issues/valerybugakov/react-selectable-fast.svg"
/>
</h1>
<h2>
<a class="anchor" href="#install" id="install">
<span class="octicon octicon-link"></span>
</a>
Install
</h2>
<div class="highlight highlight-sh">
<pre>npm i -S react-selectable-fast</pre>
</div>
<p>
<a href="https://nodei.co/npm/react-selectable-fast">
<img
alt="react-selectable-fast"
src="https://nodei.co/npm/react-selectable-fast.png?downloads=true&downloadRank=true&stars=true"
/>
</a>
</p>
<h2>
<a class="anchor" href="#demo" id="demo"><span class="octicon octicon-link"></span></a>
Demo
</h2>
<p>
Draw a box with your mouse/touch to select items. Click on + icon of an individual item to
select it.
</p>
<div id="demo-container"></div>
<h2>
<a
id="user-content-javascript-environment-requirements"
class="anchor"
href="#javascript-environment-requirements"
></a
>JavaScript environment requirements
</h2>
<p>
The React-Selectable-Fast package distributed on NPM use the widely-supported ES5 version of
JavaScript to support as many browser environments as possible.
</p>
<p>
However, this package expects modern JavaScript globals (<code>Map</code>, <code>Set</code>,
<code>Array.from</code>, <code>Array.isArray</code> <code>Object.assign</code>) to be
defined. If you support older browsers and devices which may not yet provide these natively,
consider including a global polyfill in your bundled application, such as
<a href="https://github.com/zloirock/core-js">core-js</a> or
<a href="https://babeljs.io/docs/usage/polyfill/">babel-polyfill</a>.
</p>
<p>
A polyfilled environment for React-Selectable-Fast using
<a href="https://github.com/zloirock/core-js">core-js</a> to support older browsers might
look like this:
</p>
<div class="highlight highlight-source-js">
<pre><span class="pl-k">import</span> <span class="pl-s"><span class="pl-pds">'</span>core-js/fn/object/assign<span class="pl-pds">'</span></span>
<span class="pl-k">import</span> <span class="pl-s"><span class="pl-pds">'</span>core-js/fn/array/from<span class="pl-pds">'</span></span>
<span class="pl-k">import</span> <span class="pl-s"><span class="pl-pds">'</span>core-js/fn/array/is-array<span class="pl-pds">'</span></span>
<span class="pl-k">import</span> <span class="pl-s"><span class="pl-pds">'</span>core-js/fn/map<span class="pl-pds">'</span></span>
<span class="pl-k">import</span> <span class="pl-s"><span class="pl-pds">'</span>core-js/fn/set<span class="pl-pds">'</span></span>
<span class="pl-k">import</span> <span class="pl-smi">App</span> <span class="pl-k">from</span> <span class="pl-s"><span class="pl-pds">'</span>./myApp<span class="pl-pds">'</span></span>;</pre>
</div>
<h2>
<a class="anchor" href="#usage" id="usage"><span class="octicon octicon-link"></span></a
>Usage
</h2>
<h3>
<a class="anchor" href="#exemple" id="exemple"><span class="octicon octicon-link"></span></a
>Example
</h3>
<p>
Package exports 4 entities
<code>{ SelectableGroup, createSelectable, SelectAll, DeselectAll }</code>. To make other
components selectable wrap them using HoC <code>createSelectable</code>, add passed
<code>selectableRef</code> prop to the target node and put a list of seletable items under
<code>SelectableGroup</code>.
</p>
<div class="highlight highlight-source-js">
<pre><span class="pl-k">import</span> <span class="pl-smi">React</span>, { <span class="pl-smi">Component</span> } <span class="pl-k">from</span> <span class="pl-s"><span class="pl-pds">'</span>react<span class="pl-pds">'</span></span>
<span class="pl-k">import</span> { <span class="pl-smi">SelectableGroup</span> } <span class="pl-k">from</span> <span class="pl-s"><span class="pl-pds">'</span>react-selectable-fast<span class="pl-pds">'</span></span>
<span class="pl-k">class</span> <span class="pl-en">App</span> <span class="pl-k">extends</span> <span class="pl-e">Component</span> {
<span class="pl-k">...</span>
<span class="pl-en">render</span>() {
<span class="pl-k">return</span> (
<span class="pl-k"><</span>SelectableGroup
className<span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">"</span>main<span class="pl-pds">"</span></span>
clickClassName<span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">"</span>tick<span class="pl-pds">"</span></span>
enableDeselect
tolerance<span class="pl-k">=</span>{<span class="pl-v">this</span>.<span class="pl-smi">state</span>.<span class="pl-smi">tolerance</span>}
globalMouse<span class="pl-k">=</span>{<span class="pl-v">this</span>.<span class="pl-smi">state</span>.<span class="pl-smi">isGlobal</span>}
allowClickWithoutSelected<span class="pl-k">=</span>{<span class="pl-c1">false</span>}
duringSelection<span class="pl-k">=</span>{<span class="pl-v">this</span>.<span class="pl-smi">handleSelecting</span>}
onSelectionClear<span class="pl-k">=</span>{<span class="pl-v">this</span>.<span class="pl-smi">handleSelectionClear</span>}
onSelectionFinish<span class="pl-k">=</span>{<span class="pl-v">this</span>.<span class="pl-smi">handleSelectionFinish</span>}
ignoreList<span class="pl-k">=</span>{[<span class="pl-s"><span class="pl-pds">'</span>.not-selectable<span class="pl-pds">'</span></span>, <span class="pl-s"><span class="pl-pds">'</span>.item:nth-child(10)<span class="pl-pds">'</span></span>, <span class="pl-s"><span class="pl-pds">'</span>.item:nth-child(27)<span class="pl-pds">'</span></span>]}
<span class="pl-k">></span>
<span class="pl-k"><</span>List items<span class="pl-k">=</span>{<span class="pl-v">this</span>.<span class="pl-smi">props</span>.<span class="pl-smi">items</span>} <span class="pl-k">/</span><span class="pl-k">></span>
<span class="pl-k"><</span><span class="pl-k">/</span>SelectableGroup<span class="pl-k">></span>
)
}
}</pre>
</div>
<div class="highlight highlight-source-js">
<pre><span class="pl-k">import</span> <span class="pl-smi">React</span> <span class="pl-k">from</span> <span class="pl-s"><span class="pl-pds">'</span>react<span class="pl-pds">'</span></span>
<span class="pl-k">import</span> { <span class="pl-smi">createSelectable</span> } <span class="pl-k">from</span> <span class="pl-s"><span class="pl-pds">'</span>react-selectable-fast<span class="pl-pds">'</span></span>
<span class="pl-k">const</span> <span class="pl-c1">SomeComponent</span> <span class="pl-k">=</span> ({ selectableRef, isSelected, isSelecting }) <span class="pl-k">=></span> (
<span class="pl-k"><</span>div ref<span class="pl-k">=</span>{selectableRef}<span class="pl-k">></span><span class="pl-k">...</span><span class="pl-k"><</span><span class="pl-k">/</span>div<span class="pl-k">></span>
)
<span class="pl-k">export</span> <span class="pl-c1">default</span> <span class="pl-smi">createSelectable</span>(SomeComponent)</pre>
</div>
<div class="highlight highlight-source-js">
<pre><span class="pl-k">import</span> <span class="pl-smi">React</span>, { <span class="pl-smi">Component</span> } <span class="pl-k">from</span> <span class="pl-s"><span class="pl-pds">'</span>react<span class="pl-pds">'</span></span>
<span class="pl-k">import</span> { <span class="pl-smi">createSelectable</span>, <span class="pl-smi">SelectAll</span>, <span class="pl-smi">DeselectAll</span> } <span class="pl-k">from</span> <span class="pl-s"><span class="pl-pds">'</span>react-selectable-fast<span class="pl-pds">'</span></span>
<span class="pl-k">import</span> <span class="pl-smi">SomeComponent</span> <span class="pl-k">from</span> <span class="pl-s"><span class="pl-pds">'</span>./SomeComponent<span class="pl-pds">'</span></span>
<span class="pl-k">const</span> <span class="pl-c1">SelectableComponent</span> <span class="pl-k">=</span> <span class="pl-en">createSelectable</span>(SomeComponent)
<span class="pl-k">class</span> <span class="pl-en">List</span> <span class="pl-k">extends</span> <span class="pl-e">Component</span> {
<span class="pl-k">...</span>
<span class="pl-en">render</span>() {
<span class="pl-k">return</span> (
<span class="pl-k"><</span>div<span class="pl-k">></span>
<span class="pl-k"><</span>SelectAll className<span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">"</span>selectable-button<span class="pl-pds">"</span></span><span class="pl-k">></span>
<span class="pl-k"><</span>button<span class="pl-k">></span><span class="pl-c1">Select</span> all<span class="pl-k"><</span><span class="pl-k">/</span>button<span class="pl-k">></span>
<span class="pl-k"><</span><span class="pl-k">/</span>SelectAll<span class="pl-k">></span>
<span class="pl-k"><</span>DeselectAll className<span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">"</span>selectable-button<span class="pl-pds">"</span></span><span class="pl-k">></span>
<span class="pl-k"><</span>button<span class="pl-k">></span>Clear selection<span class="pl-k"><</span><span class="pl-k">/</span>button<span class="pl-k">></span>
<span class="pl-k"><</span><span class="pl-k">/</span>DeselectAll<span class="pl-k">></span>
{<span class="pl-v">this</span>.<span class="pl-smi">props</span>.<span class="pl-smi">items</span>.<span class="pl-en">map</span>((<span class="pl-smi">item</span>, <span class="pl-smi">i</span>) <span class="pl-k">=></span> (
<span class="pl-k"><</span>SelectableComponent
key<span class="pl-k">=</span>{i}
player<span class="pl-k">=</span>{<span class="pl-smi">item</span>.<span class="pl-c1">player</span>}
year<span class="pl-k">=</span>{<span class="pl-smi">item</span>.<span class="pl-smi">year</span>}
<span class="pl-k">/</span><span class="pl-k">></span>
))}
<span class="pl-k"><</span><span class="pl-k">/</span>div<span class="pl-k">></span>
)
}
}</pre>
</div>
<h3>
<a class="anchor" href="#props" id="props"><span class="octicon octicon-link"></span></a
>Configuration
</h3>
<ul>
<li>
<code>duringSelection</code> (Function) Callback fired rapidly during selection (while the
selector is being dragged). Passes an array containing selectable items currently under
the selector to the callback function.
</li>
<li><code>onSelectionFinish</code> (Function) Callback.</li>
<li><code>onSelectionClear</code> (Function) Callback.</li>
<li><code>enableDeselect</code> (Boolean) Enables deselect with selectbox.</li>
<li>
<code>mixedDeselect</code> (Boolean) When enabled items can be selected and deselected
with selectbox at the same time, <code>enableDeselect</code> should be set to
<code>true</code>.
</li>
<li>
<code>scrollContainer</code> (String) Selector of scroll container which will be used to
calculate selectbox position. If not specified SelectableGroup element will be used as
scroll container.
</li>
<li><code>ignoreList</code> (Array) Array of ignored selectors.</li>
<li>
<code>disableSelectStartList</code> (Array) Array of selectors where select lasso can not
be started by dragging mouse. Useful if you want to enable drag of selectables.
</li>
<li>
<code>clickableClassName</code> (String) On element with specified selector click item
cotaining this element will be selected.
</li>
<li>
<code>tolerance</code> (Number) The amount of buffer to add around your
<code><SelectableGroup /></code> container, in pixels.
</li>
<li><code>className</code> (String) Class of selectable group element.</li>
<li>
<code>selectionModeClass</code> (String) Class indicating that there are more than 1
selected item. Defaults to 'in-selection-mode'.
</li>
<li>
<code>component</code> (String) The component to render. Defaults to <code>div</code>.
</li>
<li>
<code>allowClickWithoutSelected</code> (Boolean) When disabled items can be selected by
click only if there are more than 1 already selected item.
</li>
<li>
<code>fixedPosition</code> (Boolean) Whether the
<code><SelectableGroup /></code> container is a fixed/absolute position element or
the grandchild of one.
</li>
<li>
<code>resetOnStart</code> (Boolean) Unselect all items when you start a new drag. Default
value is <code>false</code>.
</li>
<li>
<code>disabled</code> (Boolean) Enable or disable the selectable draggable, useful if you
want to enable drag of sub-items. Default value is <code>false</code>.
</li>
<li>
<code>delta</code> (Number) Value of the CSS transform property scaled list, useful if
your list of items in <code><SelectableGroup /></code> is wrapped by a scale css
transform property. Default value is <code>1</code>.
</li>
<li>
<code>selectOnClick</code> (Boolean) Allow selecting by clicking items. Default value is
<code>true</code>
</li>
<li>
<code>allowAltClick</code> (Boolean) Perform select actions even though the
<code>alt</code> key is down when clicking or dragging. Default value is
<code>false</code>
</li>
<li>
<code>allowCtrlClick</code> (Boolean) Perform select actions even though the
<code>ctrl</code> key is down when clicking or dragging. Default value is
<code>false</code>
</li>
<li>
<code>allowMetaClick</code> (Boolean) Perform select actions even though the
<code>meta</code> key is down when clicking or dragging. Default value is
<code>false</code>
</li>
<li>
<code>allowShiftClick</code> (Boolean) Perform select actions even though the
<code>shift</code> key is down when clicking or dragging. Default value is
<code>false</code>
</li>
</ul>
<h2>
<a class="anchor" href="#development" id="development"
><span class="octicon octicon-link"></span></a
>Development
</h2>
<h3>
<a class="anchor" href="#clean-lib-folder" id="clean-lib-folder"
><span class="octicon octicon-link"></span></a
>Clean <code>lib and dist</code> folders
</h3>
<div class="highlight highlight-js">
<pre>npm run clean</pre>
</div>
<h3>
<a class="anchor" href="#watch-src-folder" id="watch-src-folder"
><span class="octicon octicon-link"></span></a
>Watch <code>src</code> folder
</h3>
<div class="highlight highlight-js">
<pre>npm run watch</pre>
</div>
<h3>
<a class="anchor" href="#watch-src-folder" id="watch-src-folder"
><span class="octicon octicon-link"></span></a
>Start <code>example</code> dev-server
</h3>
<div class="highlight highlight-js">
<pre>npm run watch:example</pre>
</div>
<h3>
<a class="anchor" href="#lint-src-folder" id="lint-src-folder"
><span class="octicon octicon-link"></span></a
>Lint <code>src</code> folder
</h3>
<div class="highlight highlight-js">
<pre>npm run lint</pre>
</div>
<h2>
<a class="anchor" href="#license" id="license"><span class="octicon octicon-link"></span></a
>License
</h2>
<p>See <a href="./LICENSE">MIT</a></p>
<footer class="site-footer">
<span class="site-footer-owner"
><a href="https://github.com/valerybugakov/react-selectable-fast"
>React-selectable-fast</a
></span
>
</footer>
<span class="site-footer-owner"></span>
</section>
<script src="./bundle.js"></script>
</body>
</html>