/
ui_base.html
1721 lines (1579 loc) · 73.2 KB
/
ui_base.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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<style>
.red-ui-editor {
--nrdb-node-light: rgb(160, 230, 236);
--nrdb-node-medium: rgb(90, 210, 220);
--nrdb-node-dark: rgb(39, 183, 195);
--nrdb-node-darkest: rgb(32 160 170);
}
.red-ui-editor .form-row-flex {
display: flex;
align-items: baseline;
gap: 4px;
}
.red-ui-editor .form-row-flex input,
.red-ui-editor .form-row-flex label:not(:first-child) {
margin: 0;
width: auto;
}
.nrdb2-helptext {
font-size: 0.75rem;
line-height: 0.825rem;
color: #aaa;
font-style: italic;
}
.w-16 {
width: 16px;
}
#ff-node-red-dashboard {
--ff-grey-50: #F9FAFB;
--ff-grey-100: #F3F4F6;
--ff-grey-200: #E5E7EB;
position: absolute;
top: 1px;
bottom: 2px;
left: 1px;
right: 1px;
overflow-y: auto;
}
#ff-node-red-dashboard .red-ui-sidebar-header {
display: flex;
justify-content: space-between;
}
#ff-node-red-dashboard .red-ui-sidebar-header label {
margin-bottom: 0;
}
#ff-node-red-dashboard .red-ui-sidebar-header-actions {
gap: 4px;
display: flex;
}
#ff-node-red-dashboard .red-ui-editableList-container {
padding: 0;
}
/* don't show border for nexted editable lists */
.red-ui-editableList-border .red-ui-editableList-border {
border: 0;
}
#node-config-stateless-nodes .red-ui-treeList-label.selected {
background-color: #e3f2fd;
}
/* Dashboard 2.0 Sidebar */
.nrdb2-sb-list-button-group {
display: flex;
gap: 4px;
}
.nrdb2-sidebar-tab-content {
padding: 8px 10px;
height: 100%;
box-sizing: border-box;
display: flex;
flex-direction: column;
}
.nrdb2-layout-helptext {
padding: 0 0 9px;
font-style: italic;
color: #a2a2a2;
font-size: 8pt;
line-height: 12pt;
}
.nrdb2-sidebar-header {
display: flex;
justify-content: space-between;
align-items: center;
margin-bottom: 9px;
}
.nrdb2-sb-pages-list li {
padding: 0;
border-bottom: 0;
}
.nrdb2-sb-unattached-groups-list li {
padding: 0;
border-bottom: 0;
background-color: #ffefef;
}
.nrdb2-sb-list-header {
display: flex;
gap: 6px;
align-items: center;
padding: 9px 6px;
cursor: pointer;
}
.nrdb2-sb-list-header.nrdb2-sb-pages-list-header {
border-top: 1px solid var(--red-ui-primary-border-color, --ff-grey-200);
border-bottom: 1px solid var(--red-ui-primary-border-color, --ff-grey-200);
}
.nrdb2-sb-list-header .nrdb2-sb-title {
text-overflow: ellipsis;
overflow: hidden;
white-space: nowrap;
}
.nrdb2-sb-list-header .nrdb2-sb-info {
font-size: 0.75rem;
opacity: 0.5;
}
.nrdb2-sb-list-header .nrdb2-sb-palette {
display: flex;
gap: 2px;
}
.nrdb2-sb-list-header .nrdb2-sb-palette-color {
width: 12px;
height: 12px;
background-color: black;
border: 1px solid #d4d4d4;
border-radius: 2px;
}
.nrdb2-sb-list-header-actions {
position: absolute;
gap: 4px;
right: 1rem;
display: flex;
gap: 4px;
}
.nrdb2-sb-list-header-actions a {
cursor: pointer;
}
.nrdb2-sb-list-header-state-options {
display: flex;
gap: 4px;
}
.nrdb2-sb-list-header-button-group {
right: 1rem;
display: flex;
gap: 4px;
}
.nrdb2-sb-list-header-button-group,
.nrdb2-sb-list-handle {
opacity: 0;
transition: 0.15s opacity;
}
.nrdb2-sb-list-header:hover {
background-color: var(--red-ui-secondary-background-hover, --ff-grey-100);
}
.nrdb2-sb-list-header:hover .nrdb2-sb-list-handle,
.nrdb2-sb-list-header:hover .nrdb2-sb-list-header-button-group {
opacity: 1;
}
/* indent the groups */
.nrdb2-sb-groups-list-header .nrdb2-sb-list-chevron {
margin-left: 1.5rem;
}
/* indent the widgets */
.nrdb2-sb-widgets-list-header .nrdb2-sb-widget-icon {
margin-left: 3.5rem;
}
/* apply subflow icon */
.nrdb2-sb-widgets-list-header .nrdb2-sb-widget-icon.nrdb2-sb-subflow-icon {
background-color: currentColor;
display: inline-block;
mask-image: url(red/images/subflow_tab.svg);
mask-size: contain;
mask-position: center;
height: 18px;
width: 18px;
margin-left: 3.42rem;
}
</style>
<script type="text/javascript">
// #region typedefs for intellisense and better code completion/DX
/**
* @typedef {Object} DashboardItem - A widget/group/page/subflow item
* @property {String} itemType - The type of item (e.g. 'widget', 'group', 'page', 'link')
* @property {String} id - The unique id of the item
* @property {String} name - The name of the item
* @property {String} type - The type of the item (e.g. 'ui-button', 'ui-template', 'ui-group', 'ui-page')
* @property {Number} order
* @property {String} label
* @property {String} color
* @property {String} [group] - The group id that this widget belongs to
* @property {String} [page] - The page id that this group belongs to
* @property {String} [theme] - The theme id that this page belongs to
* @property {Boolean} [isSubflowInstance] - Whether or not this item is a subflow instance
* @property {String} [subflowName] - The name give to the subflow template (only applicable when `isSubflowInstance` is `true`)
* @property {Object} node - The actual node or subflow instance that this DashboardItem represents
* @global
*/
/** @typedef {Object<string, Array<DashboardItem>>} DashboardItemLookup */
// #endregion
(function () {
const sidebarContainer = '<div style="position: relative; height: 100%;"></div>'
const sidebarContentTemplate = $('<div id="ff-node-red-dashboard"></div>').appendTo(sidebarContainer)
const sidebar = $(sidebarContentTemplate)
// convert to i18 text
function c_ (x) {
return RED._('@flowfuse/node-red-dashboard/ui-base:ui-base.' + x)
}
function hasProperty (obj, prop) {
return Object.prototype.hasOwnProperty.call(obj, prop)
}
function debounce (func, wait, immediate) {
let timeout
return function () {
const context = this; const args = arguments
const later = function () {
timeout = null
if (!immediate) func.apply(context, args)
}
const callNow = immediate && !timeout
clearTimeout(timeout)
timeout = setTimeout(later, wait)
if (callNow) func.apply(context, args)
}
}
RED.nodes.registerType('ui-base', {
category: 'config',
defaults: {
name: {
value: c_('label.uiName'),
required: true
},
path: {
value: '/dashboard',
required: true
},
includeClientData: {
value: true
},
acceptsClientConfig: {
value: ['ui-notification', 'ui-control']
},
showPathInSidebar: {
value: false
},
navigationStyle: {
value: 'default'
},
titleBarStyle: {
value: 'default'
}
},
label: function () {
return `${this.name} [${this.path}]` || 'UI Config'
},
oneditprepare: function () {
// backward compatability for navigation style
if (!this.titleBarStyle) {
// set to default
this.titleBarStyle = 'default'
// update the jquery dropdown
$('#node-config-input-titleBarStyle').val('default')
}
},
onpaletteadd: function () {
// add the Dashboard 2.0 sidebar
if (RED._db2debug) { console.log('dashboard 2: ui_base.html: onpaletteadd ()') }
addSidebar()
}
})
/**
* Utility function to convert a dashboard node to a DashboardItem
* Provides a better DX with type checking and intellisense
* @param {Object} node - The node to convert
* @returns {DashboardItem}
*/
function toDashboardItem (node) {
if (RED._db2debug) { console.log('dashboard 2: ui_base.html: toDashboardItem (node)', node) }
/** @type {DashboardItem} */
const item = {
itemType: 'widget',
id: node.id,
name: node.name,
type: node.type,
order: node.order,
label: null,
icon: null,
color: null,
isSubflowInstance: false,
node
}
if (hasProperty(node, 'group')) { item.group = node.group }
if (hasProperty(node, 'page')) { item.page = node.page }
if (hasProperty(node, 'link')) { item.link = node.link }
if (hasProperty(node, 'theme')) { item.theme = node.theme }
if (hasProperty(node, 'env') && Array.isArray(node.env) && /subflow:.+/.test(node.type)) {
const envOrder = node.env.find(e => e.key === 'DB2_SF_ORDER')
if (envOrder) {
item.order = envOrder.value
}
}
switch (node.type) {
case 'ui-page':
case 'ui-link':
case 'ui-group':
case 'ui-theme':
case 'ui-base':
item.itemType = node.type.replace('ui-', '')
break
default:
item.itemType = 'widget'
break
}
try {
item.order = parseInt(item.order)
} finally {
item.order = isNaN(item.order) ? 0 : item.order
}
try {
item.label = RED.utils.getNodeLabel(node)
} finally {
item.label = item.label || node.type || node.id
}
try {
item.color = RED.utils.getNodeColor(node)
} catch (_err) { }
return item
}
/**
* Add Custom Dashboard Side Menu
* */
function dashboardLink (id, name, path) {
const base = RED.settings.httpNodeRoot || '/'
const basePart = base.endsWith('/') ? base : `${base}/`
const dashPart = path.startsWith('/') ? path.slice(1) : path
const fullPath = `${basePart}${dashPart}`
const header = $('<div class="red-ui-sidebar-header"></div>')
const label = $('<label></label>').text(name)
const actions = $('<div class="red-ui-sidebar-header-actions"></div>')
const editSettingsButton = $('<a id="edit-ui-base" class="editor-button editor-button-small nr-db-sb-list-header-button">' +
c_('label.editSettings') + ' <i style="margin-left: 3px;" class="fa fa-cog"></i></a>')
editSettingsButton.on('click', function () {
RED.editor.editConfig('', 'ui-base', id)
})
const openDashboardButton = $(`<a id="open-dashboard" href="${fullPath}" target="nr-dashboard" class="editor-button editor-button-small nr-db-sb-list-header-button">` +
c_('label.openDashboard') + ' <i style="margin-left: 3px;" class="fa fa-external-link"></i></a>')
label.appendTo(header)
editSettingsButton.appendTo(actions)
openDashboardButton.appendTo(actions)
actions.appendTo(header)
return header
}
/**
* Add an editor to control the ordering of groups & widgets
*/
function updateItemOrder (items, events) {
if (RED._db2debug) { console.log('dashboard 2: ui_base.html: updateItemOrder (items, events)', items, events) }
items.each((i, el) => {
/** @type {DashboardItem} */
const dbItem = el.data('data')
const node = dbItem?.node || {}
const setNodeOrder = (newOrder) => {
dbItem.order = newOrder
if (dbItem.isSubflowInstance) {
node.env = node.env || []
const envOrder = node.env.find(e => e.key === 'DB2_SF_ORDER')
if (envOrder) {
envOrder.value = newOrder
} else {
node.env.push({ key: 'DB2_SF_ORDER', value: '' + newOrder, type: 'str' }) // db2 sort order
}
} else {
node.order = newOrder
}
}
const getNodeOrder = () => {
let order = dbItem.order // node.order
if (dbItem.isSubflowInstance && node.env) {
const envOrder = node.env.find(e => e.key === 'DB2_SF_ORDER')
if (envOrder) { order = envOrder.value }
}
if (typeof order === 'string') { order = parseInt(order) }
if (isNaN(order)) { order = 0 }
return order || 0
}
const oldOrder = getNodeOrder()
if (oldOrder !== i + 1) {
const wasDirty = node.dirty
const wasChanged = node.changed
// update Node-RED node properties
setNodeOrder(i + 1)
node.dirty = true
node.changed = true
// generate a history event
const hev = {
t: 'edit',
node,
changes: {
order: oldOrder
},
dirty: wasDirty,
changed: wasChanged
}
events.push(hev)
}
})
}
// toggle slide tab group content
const titleToggle = function (id, content, chevron) {
return function (evt) {
if (content.is(':visible')) {
content.slideUp()
chevron.css({ transform: 'rotate(-90deg)' })
content.addClass('nr-db-sb-collapsed')
} else {
content.slideDown()
chevron.css({ transform: '' })
content.removeClass('nr-db-sb-collapsed')
}
}
}
// Utility function to store events in NR history, trigger a redraw, and detect if a re-deploy is necessary
function recordEvents (events) {
if (events.length === 0) { return } // nothing to record
// note the state of the editor before pushing to history
const isDirty = RED.nodes.dirty()
if (RED._db2debug) { console.log('dashboard 2: recordEvents ()', isDirty, events) }
// add our changes to NR history and trigger whether or not we need to redeploy
RED.history.push({
t: 'multi',
events,
dirty: isDirty
})
RED.nodes.dirty(true)
RED.view.redraw()
}
function checkDuplicateUiBases () {
// check how many ui-bases we have and trim if already too many
const bases = []
const pages = []
RED.nodes.eachConfig((n) => {
if (n.type === 'ui-base') { bases.push(n) }
if (n.type === 'ui-page') { pages.push(n) }
})
// the eachConfig is in creation order, so we can remove from the end
// and keep the oldest ones
while (bases.length > 1) {
const n = bases.pop()
if (RED._db2debug) { console.log('ui-base removed', n) }
RED.nodes.remove(n.id)
RED.nodes.dirty(true)
}
if (bases.length > 0) {
const baseId = bases[0].id
// loop over pages and re-map the ui-base to the only ui-base available
pages.forEach((page) => {
page.ui = baseId
})
RED.nodes.eachNode((node) => {
if (node.type.startsWith('ui-')) {
// check if the widgets are ui-scoped, and have a ui set to the removed ui-base nodes
if (node.ui && node.ui !== '' && node.ui !== baseId) {
node.ui = baseId
}
}
})
}
}
function addConfigNode (node) {
if (!node.users) {
node.users = []
}
node.dirty = true
RED.nodes.add(node)
RED.editor.validateNode(node)
RED.history.push({
t: 'add',
nodes: [node.id],
dirty: RED.nodes.dirty()
})
RED.nodes.dirty(true)
}
function mapDefaults (defaults) {
const values = {}
for (const key in defaults) {
if (Object.prototype.hasOwnProperty.call(defaults, key)) {
values[key] = defaults[key].value
}
}
return values
}
function getConfigNodesByType (type) {
const nodes = []
RED.nodes.eachConfig((n) => {
if ((type instanceof String) && type === n.type) {
nodes.push(n)
} else {
// we have an array of types
if (type.includes(n.type)) {
nodes.push(n)
}
}
})
return nodes
}
function addDefaultPage (baseId, themeId) {
const page = RED.nodes.getType('ui-page')
// get all pages
const entries = getConfigNodesByType(['ui-page', 'ui-link'])
const pageNumber = entries.length + 1
const pageNode = {
_def: page,
id: RED.nodes.id(),
type: 'ui-page',
...mapDefaults(page.defaults),
path: `/page${pageNumber}`, // TODO: generate a unique path
name: `Page ${pageNumber}`,
ui: baseId,
theme: themeId,
layout: 'grid',
order: pageNumber
}
addConfigNode(pageNode)
return pageNode
}
function addDefaultLink (baseId) {
const link = RED.nodes.getType('ui-link')
const linkNode = {
_def: link,
id: RED.nodes.id(),
type: 'ui-link',
...mapDefaults(link.defaults),
path: '/',
name: 'Link',
ui: baseId
}
addConfigNode(linkNode)
return linkNode
}
function addDefaultGroup (pageId) {
const group = RED.nodes.getType('ui-group')
const groupNode = {
_def: group,
id: RED.nodes.id(),
type: 'ui-group',
...mapDefaults(group.defaults),
name: 'My Group',
page: pageId
}
addConfigNode(groupNode)
return groupNode
}
function addDefaultTheme () {
const theme = RED.nodes.getType('ui-theme')
const themeNode = {
_def: theme,
id: RED.nodes.id(),
type: 'ui-theme',
...mapDefaults(theme.defaults),
name: 'Default Theme'
}
addConfigNode(themeNode)
return themeNode
}
function addLayoutsDefaults () {
const cNodes = ['ui-base', 'ui-page', 'ui-group', 'ui-theme']
let exists = false
RED.nodes.eachConfig((n) => {
if (cNodes.includes(n.type)) {
exists = true
}
})
// check if we haven't got any of these yet
if (!exists) {
// Add Single Base Node
const base = RED.nodes.getType('ui-base')
const baseNode = {
_def: base,
id: RED.nodes.id(),
type: 'ui-base',
...mapDefaults(base.defaults),
name: 'My Dashboard'
}
addConfigNode(baseNode)
const theme = addDefaultTheme()
const page = addDefaultPage(baseNode.id, theme.id)
const group = addDefaultGroup(page.id)
// update existing `ui-` nodes to use the new base/page/theme/group
RED.nodes.eachNode((node) => {
if (node.type.startsWith('ui-')) {
// if node has a group property
if (hasProperty(node._def.defaults, 'group') && !node.group) {
// group-scoped widgets - which is most of them
node.group = group.id
} else if (hasProperty(node._def.defaults, 'page') && !node.page) {
// page-scoped widgets
node.page = page.id
} else if (hasProperty(node._def.defaults, 'ui') && !node.ui) {
// base-scoped widgets, e.g. ui-notification/control
node.ui = baseNode.id
}
RED.editor.validateNode(node)
}
})
RED.view.redraw()
RED.sidebar.config.refresh()
}
}
// watch for nodes changed, added, removed - use this to refresh the sidebar
let refreshBusy = false // this is set/reset inside refreshSidebarEditors
const refreshSidebarEditorDebounced = debounce(refreshSidebarEditors, 300)
/**
* Conditional refresh of the sidebar editor
* The refresh is only triggered if the event is a ui- node or a subflow that contains a ui- node
* Calls are debounced to prevent multiple calls to refreshSidebarEditors
* @param {Object} node - The node that was changed/added/removed
* @param {String} eventName - The name of the event that was fired
*/
const conditionalSidebarRefresh = function (node, eventName) {
// if the layout editor is not in view, don't refresh
if ($('#ff-node-red-dashboard').parent().css('display') === 'none') { return }
// if a refresh is in progress, don't refresh
if (refreshBusy) { return }
if (RED._db2debug) { console.log('dashboard 2: conditionalSidebarRefresh (node, eventName)', node, eventName) }
// first, check if the node.dirty flag is set or if the event is a nodes:remove (also ensure the node has a type property)
if ((node.dirty || eventName === 'nodes:remove') && node.type) {
// check if the node is a ui- node
let refresh = node.type.startsWith('ui-')
// if this is not a ui- node, it is perhaps a subflow?
if (!refresh && node.type.startsWith('subflow:')) {
// lets see if it has env vars linked to a `ui-` config or it has a DB2_SF_ORDER sort order key?
const subflowId = node.type.split(':')[1]
if (node.env && node.env.find(e => e.type?.startsWith('ui-') || node.env.find(e => e.key === 'DB2_SF_ORDER'))) {
refresh = true
}
if (!refresh) {
// check if the subflow definition contains any ui- nodes
const subflowChildren = RED.nodes.filterNodes({ z: subflowId })
if (subflowChildren.some(n => n.type.startsWith('ui-'))) {
refresh = true
}
}
}
if (refresh) {
if (RED._db2debug) { console.log(`dashboard 2: ${eventName} - this is a ui- node! queuing a call to refreshSidebarEditors`) }
// debounce the call to refreshSidebarEditors as multiple events can be fired in quick succession
refreshSidebarEditorDebounced()
}
}
}
RED.events.on('nodes:change', function (event) {
conditionalSidebarRefresh(event, 'nodes:change')
})
const addLayoutsDefaultsDebounced = debounce(addLayoutsDefaults, 25)
const checkDuplicateUiBasesDebounced = debounce(checkDuplicateUiBases, 25)
RED.events.on('nodes:add', function (node) {
if (RED._db2debug) { console.log('nodes:add', node) }
if (node.dirty && node.type && node.type.startsWith('ui-')) {
if (RED._db2debug) { console.log('nodes:add - this is a ui- node! queuing a call to refreshSidebarEditors') }
// debounce the call to refreshSidebarEditors as multiple events can be fired in quick succession
refreshSidebarEditorDebounced()
}
// if we're adding a ui-base
if (node.type.startsWith('ui-')) {
// action on all ui- elements to ensure we've remapped (now) missing ui-base nodes
checkDuplicateUiBasesDebounced()
addLayoutsDefaultsDebounced()
}
})
RED.events.on('nodes:remove', function (event) {
conditionalSidebarRefresh(event, 'nodes:remove')
})
/**
* Add group of actions to the right-side of a row in the sidebar editable list.
* @param {Object} parent - jQuery object to add this button group as a child element to
* @param {DashboardItem} item - The page/group/widget that these actions are bound to
*/
function addRowActions (parent, item, list) {
const configNodes = ['ui-base', 'ui-page', 'ui-link', 'ui-group', 'ui-theme']
const btnGroup = $('<div>', { class: 'nrdb2-sb-list-header-button-group', id: item.id }).appendTo(parent)
if (!configNodes.includes(item.type)) {
const focusButton = $('<a href="#" class="nr-db-sb-tab-focus-button editor-button editor-button-small nr-db-sb-list-header-button"><i class="fa fa-bullseye"></i> ' + c_('layout.focus') + '</a>').appendTo(btnGroup)
focusButton.on('click', function (evt) {
RED.view.reveal(item.id)
evt.stopPropagation()
evt.preventDefault()
})
}
const editButton = $('<a href="#" class="nr-db-sb-tab-edit-button editor-button editor-button-small nr-db-sb-list-header-button"><i class="fa fa-pencil"></i> ' + c_('layout.edit') + '</a>').appendTo(btnGroup)
editButton.on('click', function (evt) {
if (configNodes.includes(item.type)) {
RED.editor.editConfig('', item.type, item.id)
} else {
RED.editor.edit(item?.node)
}
evt.stopPropagation()
evt.preventDefault()
})
if (item.type === 'ui-page') {
// add the "+ group" button
$('<a href="#" class="editor-button editor-button-small nr-db-sb-list-header-button"><i class="fa fa-plus"></i> ' + c_('layout.group') + '</a>')
.click(function (evt) {
list.editableList('addItem')
evt.preventDefault()
})
.appendTo(btnGroup)
}
}
/**
* Add group of actions to the right-side of a row in the sidebar editable list.
* @param {Object} parent - jQuery object to add this button group as a child element to
* @param {DashboardItem} dashboardItem - The page/group/widget that these actions are bound to
*/
function addRowStateOptions (parent, dashboardItem) {
const item = dashboardItem.node
const nodes = ['ui-page', 'ui-link', 'ui-group']
const btnGroup = $('<div>', { class: 'nrdb2-sb-list-header-state-options', id: item.id }).appendTo(parent)
if (nodes.includes(item.type)) {
const visibleIcon = (item.visible === 'false' || item.visible === false) ? 'fa-eye-slash' : 'fa-eye'
const visibleBtn = $('<a href="#" title="Hide" class="nr-db-sb-tab-visible-button editor-button editor-button-small nr-db-sb-list-header-button"><i class="fa ' + visibleIcon + '"></i></a>').appendTo(btnGroup)
visibleBtn.on('click', function (evt) {
const events = []
evt.stopPropagation()
evt.preventDefault()
if (item.visible === 'true' || item.visible === true || item.visible === undefined) {
// toggle to hidden
item.visible = false
$(this).prop('title', 'Show')
$(this).find('i').addClass('fa-eye-slash').removeClass('fa-eye')
events.push({
t: 'edit',
node: item,
changes: {
visible: true
},
dirty: item.dirty,
changed: item.changed
})
} else {
// toggle to shown
item.visible = true
$(this).prop('title', 'Hide')
$(this).find('i').addClass('fa-eye').removeClass('fa-eye-slash')
events.push({
t: 'edit',
node: item,
changes: {
visible: false
},
dirty: item.dirty,
changed: item.changed
})
}
recordEvents(events)
})
const disabledIcon = (item.disabled === 'true' || item.disabled === true) ? 'fa-lock' : 'fa-unlock'
const disabledBtn = $('<a href="#" class="nr-db-sb-tab-visible-button editor-button editor-button-small nr-db-sb-list-header-button"><i class="fa ' + disabledIcon + '"></i></a>').appendTo(btnGroup)
disabledBtn.on('click', function (evt) {
const events = []
evt.stopPropagation()
evt.preventDefault()
if (item.disabled === 'true' || item.disabled === true) {
// toggle to hidden
item.disabled = false
$(this).prop('title', 'Disable')
$(this).find('i').addClass('fa-unlock').removeClass('fa-lock')
events.push({
t: 'edit',
node: item,
changes: {
disabled: true
},
dirty: item.dirty,
changed: item.changed
})
} else {
// toggle to shown
item.disabled = true
$(this).prop('title', 'Enable')
$(this).find('i').addClass('fa-lock').removeClass('fa-unlock')
events.push({
t: 'edit',
node: item,
changes: {
disabled: false
},
dirty: item.dirty,
changed: item.changed
})
}
recordEvents(events)
})
}
}
/**
* Adds child list of groups for a given page
* @param {String} pageId - The id of the page that these groups belong to
* @param {Object} container - The jQuery object to append the groups list to
* @param {Object[]} groups - The list of groups to add to the list
* @param {DashboardItemLookup} widgetsByGroup - The lookup of widgets by group
*/
function addGroupOrderingList (pageId, container, groups, widgetsByGroup) {
// ordered list of groups to live within a container (e.g. page list item)
const groupsOL = $('<ol>', { class: 'nrdb2-sb-group-list' }).appendTo(container).editableList({
sortable: '.nrdb2-sb-groups-list-header',
addButton: false,
height: 'auto',
connectWith: '.nrdb2-sb-group-list',
addItem: function (container, i, group) {
if (!group || !group.id) {
// this is a new page that's been added and we need to setup the basics
group = addDefaultGroup(pageId)
RED.editor.editConfig('', group.type, group.id)
}
const widgets = widgetsByGroup[group.id] || []
const titleRow = $('<div>', { class: 'nrdb2-sb-list-header nrdb2-sb-groups-list-header' }).appendTo(container)
$('<i class="nrdb2-sb-list-handle nrdb2-sb-group-list-handle fa fa-bars"></i>').appendTo(titleRow)
const chevron = $('<i class="fa fa-angle-down nrdb2-sb-list-chevron">', { style: 'width:10px;' }).appendTo(titleRow)
const groupicon = 'fa-table'
$('<i>', { class: 'nrdb2-sb-icon nrdb2-sb-group-icon fa ' + groupicon }).appendTo(titleRow)
$('<span>', { class: 'nrdb2-sb-title' }).text(group.name || group.id).appendTo(titleRow)
$('<span>', { class: 'nrdb2-sb-info' }).text(`${widgets.length} Widgets`).appendTo(titleRow)
const actions = $('<div>', { class: 'nrdb2-sb-list-header-actions' }).appendTo(titleRow)
addRowActions(actions, group)
addRowStateOptions(actions, group)
// adds widgets within this group
const widgetsList = $('<div>', { class: 'nrdb2-sb-widget-list-container' }).appendTo(container)
// add chevron/list toggle
titleRow.click(titleToggle(group.id, widgetsList, chevron))
addWidgetToList(group.id, widgetsList, widgets)
},
sortItems: function (items) {
// track any changes
const events = []
// check if we have any new widgets added to this list
items.each((i, el) => {
const dbItem = el.data('data')
const widget = dbItem?.node || {}
if (widget.page !== pageId) {
const oldPageId = widget.page
widget.page = pageId
events.push({
t: 'edit',
node: widget,
changes: {
page: oldPageId
},
dirty: widget.changed,
changed: widget.dirty
})
}
})
updateItemOrder(items, events)
// add our changes to NR history and trigger whether or not we need to redeploy
recordEvents(events)
},
sort: function (a, b) {
return Number(a.order) - Number(b.order)
}
})
groups.forEach(function (group) {
if (RED._db2debug) { if (RED._db2debug) { console.log('dashboard 2: ui_base.html: addGroupOrderingList: adding group', group) } }
groupsOL.editableList('addItem', group)
})
return groupsOL
}
/**
* Adds list of widgets underneath a group
* @param {String} groupId - The id of the group that these widgets belong to
* @param {JQuery} container - The jQuery object to append the widgets list to
* @param {DashboardItem[]} widgets - The list of widgets to add to the list
*/
function addWidgetToList (groupId, container, widgets) {
// ordered list of groups to live within a container (e.g. page list item)
const widgetsOL = $('<ol>', { class: 'nrdb2-sb-widget-list' }).appendTo(container).editableList({
sortable: '.nrdb2-sb-widgets-list-header',
addButton: false,
height: 'auto',
connectWith: '.nrdb2-sb-widget-list',
addItem: function (container, i, /** @type {DashboardItem} */ widget) {
const titleRow = $('<div>', { class: 'nrdb2-sb-list-header nrdb2-sb-widgets-list-header' }).appendTo(container)
$('<i class="nrdb2-sb-list-handle nrdb2-sb-widget-list-handle fa fa-bars"></i>').appendTo(titleRow)
let widgetIcon = 'fa fa-image'
if (widget.isSubflowInstance) {
// In this MVP, subflow instances are constrained to stay within own group.
container.parent().addClass('red-ui-editableList-item-constrained')
// change the icon to use the built-in subflow icon
widgetIcon = 'nrdb2-sb-subflow-icon'
// apply a tooltip to further clarify this is a subflow
titleRow.attr('title', widget.subflowName || 'Subflow instance')
}
$('<i>', { class: 'nrdb2-sb-icon nrdb2-sb-widget-icon ' + widgetIcon }).appendTo(titleRow)
$('<span>', { class: 'nrdb2-sb-title' }).text(widget.label?.trim() || widget.id).appendTo(titleRow)
const actions = $('<div>', { class: 'nrdb2-sb-list-header-actions' }).appendTo(titleRow)
addRowActions(actions, widget)
},
sortItems: function (items) {
// track any changes
const events = []
// check if we have any new widgets added to this list
items.each((i, el) => {
const dbItem = el.data('data')
const widget = dbItem?.node || {}
if (widget.group !== groupId) {
const oldGroupId = widget.group
widget.group = groupId
events.push({
t: 'edit',
node: widget,
changes: {
group: oldGroupId
},
dirty: widget.dirty,
changed: widget.changed
})
}
})
updateItemOrder(items, events)
// add our changes to NR history and trigger whether or not we need to redeploy
recordEvents(events)
},
sort: function (a, b) {
return Number(a.order) - Number(b.order)
}
})
widgets.forEach(function (w) {
widgetsOL.editableList('addItem', w)
})
}
// expand / collapse buttons
let layoutDisplayLevel = 2 // all open by default
const getGroupsInLayout = function () {
const content = $('.nrdb2-layout-order-editor > .red-ui-editableList .nrdb2-sb-widget-list-container')