You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-19Lines changed: 38 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,15 +61,17 @@ Parse Dashboard is a standalone dashboard for managing your [Parse Server](https
61
61
-[Data Browser](#data-browser)
62
62
-[Filters](#filters)
63
63
-[Info Panel](#info-panel)
64
-
-[Segments](#segments)
65
-
-[Text Item](#text-item)
66
-
-[Key-Value Item](#key-value-item)
67
-
-[Table Item](#table-item)
68
-
-[Image Item](#image-item)
69
-
-[Video Item](#video-item)
70
-
-[Audio Item](#audio-item)
71
-
-[Button Item](#button-item)
72
-
-[Panel Item](#panel-item)
64
+
-[Response](#response)
65
+
-[Segments](#segments)
66
+
-[Text Item](#text-item)
67
+
-[Key-Value Item](#key-value-item)
68
+
-[Table Item](#table-item)
69
+
-[Image Item](#image-item)
70
+
-[Video Item](#video-item)
71
+
-[Audio Item](#audio-item)
72
+
-[Button Item](#button-item)
73
+
-[Panel Item](#panel-item)
74
+
-[Prefetching](#prefetching)
73
75
-[Freeze Columns](#freeze-columns)
74
76
-[Browse as User](#browse-as-user)
75
77
-[Change Pointer Key](#change-pointer-key)
@@ -140,6 +142,8 @@ Parse Dashboard is continuously tested with the most recent releases of Node.js
140
142
|`infoPanel[*].title`| String | no | - |`User Details`| The panel title. |
141
143
|`infoPanel[*].classes`| Array<String>| no | - |`["_User"]`| The classes for which the info panel should be displayed. |
142
144
|`infoPanel[*].cloudCodeFunction`| String | no | - |`getUserDetails`| The Cloud Code Function which received the selected object in the data browser and returns the response to be displayed in the info panel. |
145
+
|`infoPanel[*].prefetchObjects`| Number | yes |`0`|`2`| Number of next rows to prefetch when browsing sequential rows. For example, `2` means the next 2 rows will be fetched in advance. |
146
+
|`infoPanel[*].prefetchStale`| Number | yes |`0`|`10`| Duration in seconds after which prefetched data is discarded as stale. |
143
147
|`apps.scripts`| Array<Object>| yes |`[]`|`[{ ... }, { ... }]`| The scripts that can be executed for that app. |
144
148
|`apps.scripts.title`| String | no | - |`'Delete User'`| The title that will be displayed in the data browser context menu and the script run confirmation dialog. |
145
149
|`apps.scripts.classes`| Array<String>| no | - |`['_User']`| The classes of Parse Objects for which the scripts can be executed. |
@@ -873,7 +877,9 @@ The following example dashboard configuration shows an info panel for the `_User
873
877
{
874
878
"title": "User Details",
875
879
"classes": ["_User"],
876
-
"cloudCodeFunction": "getUserDetails"
880
+
"cloudCodeFunction": "getUserDetails",
881
+
"prefetchObjects": 2,
882
+
"prefetchStale": 10
877
883
}
878
884
]
879
885
}
@@ -882,7 +888,9 @@ The following example dashboard configuration shows an info panel for the `_User
882
888
883
889
The Cloud Code Function receives the selected object in the payload and returns a response that can include various items.
884
890
885
-
#### Segments
891
+
#### Response
892
+
893
+
##### Segments
886
894
887
895
The info panel can contain multiple segments to display different groups of information.
888
896
@@ -918,7 +926,7 @@ Example:
918
926
919
927
The items array can include various types of content such as text, key-value pairs, tables, images, videos, audios, and buttons. Each type offers a different way to display information within the info panel, allowing for a customizable and rich user experience. Below is a detailed explanation of each type.
920
928
921
-
#### Text Item
929
+
#####Text Item
922
930
923
931
A simple text field.
924
932
@@ -938,7 +946,7 @@ Example:
938
946
}
939
947
```
940
948
941
-
#### Key-Value Item
949
+
#####Key-Value Item
942
950
943
951
A text item that consists of a key and a value. The value can optionally be linked to a URL.
944
952
@@ -1009,7 +1017,7 @@ const item = {
1009
1017
}
1010
1018
```
1011
1019
1012
-
#### Table Item
1020
+
#####Table Item
1013
1021
1014
1022
A table with columns and rows to display data in a structured format.
1015
1023
@@ -1051,7 +1059,7 @@ Example:
1051
1059
}
1052
1060
```
1053
1061
1054
-
#### Image Item
1062
+
#####Image Item
1055
1063
1056
1064
An image to be displayed in the panel.
1057
1065
@@ -1071,7 +1079,7 @@ Example:
1071
1079
}
1072
1080
```
1073
1081
1074
-
#### Video Item
1082
+
#####Video Item
1075
1083
1076
1084
A video to be displayed in the panel.
1077
1085
@@ -1091,7 +1099,7 @@ Example:
1091
1099
}
1092
1100
```
1093
1101
1094
-
#### Audio Item
1102
+
#####Audio Item
1095
1103
1096
1104
An audio file to be played in the panel.
1097
1105
@@ -1111,7 +1119,7 @@ Example:
1111
1119
}
1112
1120
```
1113
1121
1114
-
#### Button Item
1122
+
#####Button Item
1115
1123
1116
1124
A button that triggers an action when clicked.
1117
1125
@@ -1146,7 +1154,7 @@ Example:
1146
1154
}
1147
1155
```
1148
1156
1149
-
#### Panel Item
1157
+
#####Panel Item
1150
1158
1151
1159
A sub-panel whose data is loaded on-demand by expanding the item.
1152
1160
@@ -1168,6 +1176,17 @@ Example:
1168
1176
}
1169
1177
```
1170
1178
1179
+
#### Prefetching
1180
+
1181
+
To reduce the time for info panel data to appear, data can be prefetched.
1182
+
1183
+
| Parameter | Type | Optional | Default | Example | Description |
|`infoPanel[*].prefetchObjects`| Number | yes |`0`|`2`| Number of next rows to prefetch when browsing sequential rows. For example, `2` means the next 2 rows will be fetched in advance. |
1186
+
|`infoPanel[*].prefetchStale`| Number | yes |`0`|`10`| Duration in seconds after which prefetched data is discarded as stale. |
1187
+
1188
+
Prefetching is particularly useful when navigating through lists of objects. To optimize performance and avoid unnecessary data loading, prefetching is triggered only after the user has moved through 3 consecutive rows using the keyboard down-arrow key or by mouse click.
0 commit comments