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: content/guides/embed/box-embed.md
+25-1Lines changed: 25 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,7 @@ alias_paths:
12
12
13
13
Box Embed is a HTML-based framework that allows embedding the entire
14
14
Box Web App experience in a custom-made application. Box Embed provides the ability to upload, search, comment, share, tag, and edit files using Box Edit. You can also embed Box Hubs AI Chat for a focused chatbot experience.
15
+
Box Web App experience in a custom-made application. Box Embed provides the ability to upload, search, comment, share, tag, and edit files using Box Edit. You can also embed Box Hubs AI Chat for a focused chatbot experience.
15
16
16
17
## Before you start
17
18
@@ -40,6 +41,10 @@ To fetch the Box Embed widget code from the Box web app, perform the following s
40
41
You can also embed only the AI chat interface from a hub. Users can ask questions and get AI-powered answers based on the hub's files, without accessing navigation or file browsing features. For more information, see the [Box Hubs AI Chat embedding][6] section.
41
42
</Message>
42
43
44
+
<Messagetype='notice'>
45
+
You can also embed only the AI chat interface from a hub. Users can ask questions and get AI-powered answers based on the hub's files, without accessing navigation or file browsing features. For more information, see the [Box Hubs AI Chat embedding][6] section.
46
+
</Message>
47
+
43
48
### Notes
44
49
45
50
1. Navigate to the chosen note.
@@ -58,6 +63,14 @@ You can also embed only the AI chat interface from a hub. Users can ask question
58
63
59
64
In the next step, configure the parameters of an embeddable element.
60
65
66
+
| Element Type | Configuration Options |
67
+
|--------------|----------------------|
68
+
| Files | Size of the widget. |
69
+
| Folders | Size of the widget, sorting of the files in a folder, hiding the navigation path and sidebar. |
70
+
| Hubs | Size of the widget, hiding the parent navigation path and sidebar. |
71
+
| Hubs AI Chat | Chat mode: button or widget. |
72
+
| Notes | Size of the widget, skipping cloud game (results in note being in read only mode), hiding notes navigation. |
73
+
| Apps | Size of the widget. |
61
74
| Element Type | Configuration Options |
62
75
|--------------|----------------------|
63
76
| Files | Size of the widget. |
@@ -86,6 +99,8 @@ If you want to customize Box Embed even further, you can do it programmatically.
@@ -142,6 +157,8 @@ You can also set the page to Root Folder/All Files page. Set the URL to
142
157
Next, you will want to choose your view customization options. The following is
143
158
a list of optional parameters you can configure.
144
159
160
+
|||
161
+
| -- | -- |
145
162
|||
146
163
| -- | -- |
147
164
|`hideHubsGallery`| Hide or show navigation chevron button to go back to Hubs gallery. Can be `true` or `false` (default). |
@@ -265,7 +282,7 @@ The following example shows a fully configured chat widget with all available pa
265
282
266
283
#### Using the close button
267
284
268
-
When embedding the Box AI chat directly with `iframe` (without using the provided script), you can enable a close button within the chat interface that communicates with your parent application via`postMessage`.
285
+
When embedding the Box AI chat directly with `iframe` (without using the provided script), you can enable a close button within the chat interface that communicates with your parent application through`postMessage`.
269
286
270
287
##### Enabling the close button
271
288
@@ -368,6 +385,9 @@ would look something like this.
|`showDownload`| Shows the download button in the embedded header bar if the viewer has permissions to download the file. Document file types will also show a print button since print and download are governed by the same permissions. Defaults to `false`. |
371
391
|||
372
392
| --- | --- |
373
393
|`showDownload`| Shows the download button in the embedded header bar if the viewer has permissions to download the file. Document file types will also show a print button since print and download are governed by the same permissions. Defaults to `false`. |
@@ -418,4 +438,8 @@ and **print** options might not show in mobile browsers.
0 commit comments