Skip to content

Commit daf56c1

Browse files
committed
Adds comments
1 parent 1302d0b commit daf56c1

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

src/index.js

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,8 +183,11 @@ class InfiniteTree extends events.EventEmitter {
183183
}
184184
// Close this node. The node must have child nodes.
185185
// @param {object} node
186+
// @return {boolean} Returns true on success, false otherwise.
186187
closeNode(node) {
187188
const { rowRenderer } = this.options;
189+
190+
// Retrieve node index
188191
const nodeIndex = this.nodes.indexOf(node);
189192
if (nodeIndex < 0) {
190193
throw new Error('Invalid node specified: node.id=' + JSON.stringify(node.id));
@@ -234,6 +237,7 @@ class InfiniteTree extends events.EventEmitter {
234237
this.rows.splice(nodeIndex + 1, deleteCount);
235238
this.rows[nodeIndex] = rowRenderer(node);
236239

240+
// Emit the 'tree.close' event
237241
this.emit('tree.close', node);
238242

239243
// Updates list with new data
@@ -291,8 +295,11 @@ class InfiniteTree extends events.EventEmitter {
291295
}
292296
// Open this node. The node must have child nodes.
293297
// @param {object} node
298+
// @return {boolean} Returns true on success, false otherwise.
294299
openNode(node) {
295300
const { rowRenderer } = this.options;
301+
302+
// Retrieve node index
296303
const nodeIndex = this.nodes.indexOf(node);
297304
if (nodeIndex < 0) {
298305
throw new Error('Invalid node specified: node.id=' + JSON.stringify(node.id));
@@ -315,6 +322,7 @@ class InfiniteTree extends events.EventEmitter {
315322
this.rows.splice.apply(this.rows, [nodeIndex + 1, 0].concat(rows));
316323
this.rows[nodeIndex] = generateRows([node], rowRenderer)[0];
317324

325+
// Emit the 'tree.open' event
318326
this.emit('tree.open', node);
319327

320328
// Updates list with new data
@@ -334,6 +342,7 @@ class InfiniteTree extends events.EventEmitter {
334342
}
335343
// Select this node. You can deselect the current node by calling selectNode(null) or selectNode().
336344
// @param {object} node
345+
// @return {boolean} Returns true on success, false otherwise.
337346
selectNode(node = null) {
338347
const { rowRenderer } = this.options;
339348

@@ -342,10 +351,12 @@ class InfiniteTree extends events.EventEmitter {
342351
if (this.state.selectedNode) {
343352
const selectedNode = this.state.selectedNode;
344353
const selectedIndex = this.nodes.indexOf(selectedNode);
354+
345355
selectedNode.state.selected = false;
346356
this.rows[selectedIndex] = rowRenderer(selectedNode);
347-
348357
this.state.selectedNode = null;
358+
359+
// Emit the 'tree.select' event
349360
this.emit('tree.select', null);
350361

351362
// Updates list with new data
@@ -357,6 +368,7 @@ class InfiniteTree extends events.EventEmitter {
357368
return false;
358369
}
359370

371+
// Retrieve node index
360372
const nodeIndex = this.nodes.indexOf(node);
361373
if (nodeIndex < 0) {
362374
throw new Error('Invalid node specified: node.id=' + JSON.stringify(node.id));
@@ -378,9 +390,13 @@ class InfiniteTree extends events.EventEmitter {
378390

379391
if (this.state.selectedNode !== node) {
380392
this.state.selectedNode = node;
393+
394+
// Emit the 'tree.select' event
381395
this.emit('tree.select', node);
382396
} else {
383397
this.state.selectedNode = null;
398+
399+
// Emit the 'tree.select' event
384400
this.emit('tree.select', null);
385401
}
386402

0 commit comments

Comments
 (0)