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
+35-20Lines changed: 35 additions & 20 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,8 +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. |
143
-
| `infoPanel[*].prefetchObjects` | Number | yes | `0` | `2` | Number of rows to prefetch when browsing sequential rows.
144
-
| `infoPanel[*].prefetchStale` | Number | yes | `0` | `10` | Duration in seconds after which prefetched data is discarded.
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. |
145
147
|`apps.scripts`| Array<Object>| yes |`[]`|`[{ ... }, { ... }]`| The scripts that can be executed for that app. |
146
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. |
147
149
|`apps.scripts.classes`| Array<String>| no | - |`['_User']`| The classes of Parse Objects for which the scripts can be executed. |
@@ -886,7 +888,9 @@ The following example dashboard configuration shows an info panel for the `_User
886
888
887
889
The Cloud Code Function receives the selected object in the payload and returns a response that can include various items.
888
890
889
-
#### Segments
891
+
#### Response
892
+
893
+
##### Segments
890
894
891
895
The info panel can contain multiple segments to display different groups of information.
892
896
@@ -922,7 +926,7 @@ Example:
922
926
923
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.
924
928
925
-
#### Text Item
929
+
#####Text Item
926
930
927
931
A simple text field.
928
932
@@ -942,7 +946,7 @@ Example:
942
946
}
943
947
```
944
948
945
-
#### Key-Value Item
949
+
#####Key-Value Item
946
950
947
951
A text item that consists of a key and a value. The value can optionally be linked to a URL.
948
952
@@ -1013,7 +1017,7 @@ const item = {
1013
1017
}
1014
1018
```
1015
1019
1016
-
#### Table Item
1020
+
#####Table Item
1017
1021
1018
1022
A table with columns and rows to display data in a structured format.
1019
1023
@@ -1055,7 +1059,7 @@ Example:
1055
1059
}
1056
1060
```
1057
1061
1058
-
#### Image Item
1062
+
#####Image Item
1059
1063
1060
1064
An image to be displayed in the panel.
1061
1065
@@ -1075,7 +1079,7 @@ Example:
1075
1079
}
1076
1080
```
1077
1081
1078
-
#### Video Item
1082
+
#####Video Item
1079
1083
1080
1084
A video to be displayed in the panel.
1081
1085
@@ -1095,7 +1099,7 @@ Example:
1095
1099
}
1096
1100
```
1097
1101
1098
-
#### Audio Item
1102
+
#####Audio Item
1099
1103
1100
1104
An audio file to be played in the panel.
1101
1105
@@ -1115,7 +1119,7 @@ Example:
1115
1119
}
1116
1120
```
1117
1121
1118
-
#### Button Item
1122
+
#####Button Item
1119
1123
1120
1124
A button that triggers an action when clicked.
1121
1125
@@ -1150,7 +1154,7 @@ Example:
1150
1154
}
1151
1155
```
1152
1156
1153
-
#### Panel Item
1157
+
#####Panel Item
1154
1158
1155
1159
A sub-panel whose data is loaded on-demand by expanding the item.
1156
1160
@@ -1172,6 +1176,17 @@ Example:
1172
1176
}
1173
1177
```
1174
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.
0 commit comments