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
+52-19Lines changed: 52 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Box Web App experience in a custom-made application. Box Embed provides the abil
17
17
18
18
To create a widget, you need to:
19
19
20
-
* Set an embeddable element, such as a **folder**, **file**, **Hub**, **note**, or **app** for sharing.
20
+
* Set an embeddable element, such as a folder, file, hub, note, or app for sharing.
21
21
* Have at least **Viewer**[permissions][5].
22
22
23
23
## Using web app
@@ -32,23 +32,23 @@ To fetch the Box Embed widget code from the Box web app, perform the following s
32
32
33
33
### Hubs
34
34
35
-
1. Navigate to the chosen Hub.
35
+
1. Navigate to the chosen hub.
36
36
2. Click on the ellipsis menu in the upper-right corner.
37
37
3. Click **Embed Hub**.
38
38
39
39
<Messagetype='notice'>
40
-
You can also embed only the AI chat interface from a Box 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.
40
+
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
41
</Message>
42
42
43
43
### Notes
44
44
45
-
1. Navigate to the chosen Box Note.
45
+
1. Navigate to the chosen note.
46
46
2. Click on the ellipsis menu.
47
47
3. Click **Embed Box Note**.
48
48
49
49
### Apps
50
50
51
-
1. Navigate to the chosen Box App or Box App View.
51
+
1. Navigate to the chosen app or Box App View.
52
52
2. Click on the ellipsis menu.
53
53
3. Click **Embed**.
54
54
@@ -141,8 +141,8 @@ You can also set the page to Root Folder/All Files page. Set the URL to
141
141
Next, you will want to choose your view customization options. The following is
|`hideHubsGallery`| Hide or show navigation chevron button to go back to Hubs gallery. Can be `true` or `false` (default). |
147
147
|`hideNavigationControls`| Hide or show navigation controls in Box Notes.|
148
148
|`showItemFeedActions`| Hide or show file comments or tasks. Can be `true` (default) or `false`. |
@@ -190,20 +190,51 @@ To embed a hub in AI Chat mode:
190
190
4. Select the **Hub AI Chat** tab.
191
191
5. Select chat mode:
192
192
193
-
***Chat button**: The AI chat widget opens after the user clicks the button.
194
-
***Chat widget**: The AI chat widget is embedded directly on page load.
193
+
*[Chat button][7]
194
+
*[Chat widget][8]
195
195
196
196
6. Copy the embed code.
197
197
198
-
### Parameters
198
+
<Messagetype='notice'>
199
+
If you experience issues with the Box Hubs AI Chat embedding, regenerate the embed code to get the latest version by repeating steps 1-6 above.
200
+
</Message>
201
+
202
+
### Chat button
203
+
204
+
In **Chat button** mode, the AI chat widget opens after the user clicks the button. It is generated as a Box-hosted `script` and displays a floating chat button on your page.
205
+
206
+
<ImageFrameborder>
207
+

208
+
</ImageFrame>
209
+
210
+
#### Chat button parameters
211
+
212
+
The **Chat button** mode supports the following parameters:
213
+
214
+
| Parameter | Required | Description |
215
+
|-----------|----------|-------------|
216
+
|`data-hub-id`| Yes | The ID of the hub that powers the chatbot. |
217
+
|`data-custom-box-domain`| No | For Box instances with custom domains. Default: `app.box.com`. Example: `mycompanydomain.app.box.com`. |
218
+
|`data-button-text`| No | Custom text to display on the chat button. Default: `Box AI`. This value is also used for the button's area label for accessibility. |
219
+
|`data-shared-link`| No | Optional shared link for hub access. If not provided, the chat loads only for users who are collaborators on the hub. |
220
+
221
+
### Chat widget
222
+
223
+
In **Chat widget** mode, the AI chat widget is embedded directly on page load. It is generated as an `iframe` and displays the full chat interface immediately.
224
+
225
+
<ImageFrameborder>
226
+

227
+
</ImageFrame>
228
+
229
+
#### Chat widget parameters
199
230
200
-
The AI Chat embed mode supports the following URL parameters:
231
+
The **Chat button** mode supports the following parameters:
201
232
202
-
| Parameter | Description |
203
-
|-----------|-------------|
204
-
|`hub-id`| The ID of the hub that powers the chatbot. |
205
-
|`custom-box-domain`| For Box instances with custom domains. |
206
-
|`button-text`| Custom text to display on the chat button (chat button mode only). |
233
+
| Parameter |Required |Description |
234
+
|-----------|----------|-------------|
235
+
|`hub-id`|Yes |The ID of the hub that powers the chatbot. |
236
+
|`custom-box-domain`|No |For Box instances with custom domains. |
237
+
|`button-text`|No |Custom text to display on the chat button (chat button mode only). |
207
238
208
239
## Expiring embed links
209
240
@@ -275,9 +306,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`.|
309
+
|||
310
+
| --- | --- |
311
+
|`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`. |
281
312
|`showAnnotations`| Enables users with permission Preview and above to annotate document and image previews. Also shows annotations that are already on the document. To learn more about the file types that annotations is available on as well as the types of annotations, you can refer to our Annotations page. Annotations are available today on web browsers only. On mobile browsers, users will be able to view annotations but not create new ones. |
282
313
283
314
## Cloud game
@@ -323,3 +354,5 @@ and **print** options might not show in mobile browsers.
0 commit comments