Skip to content

Commit b140351

Browse files
Merge branch 'main' of github.com:box/developer.box.com into staging
2 parents c883460 + cc455d0 commit b140351

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

content/guides/embed/box-embed.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ alias_paths:
1212

1313
Box Embed is a HTML-based framework that allows embedding the entire
1414
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.
1516

1617
## Before you start
1718

@@ -40,6 +41,10 @@ To fetch the Box Embed widget code from the Box web app, perform the following s
4041
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.
4142
</Message>
4243

44+
<Message type='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+
4348
### Notes
4449

4550
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
5863

5964
In the next step, configure the parameters of an embeddable element.
6065

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. |
6174
| Element Type | Configuration Options |
6275
|--------------|----------------------|
6376
| Files | Size of the widget. |
@@ -86,6 +99,8 @@ If you want to customize Box Embed even further, you can do it programmatically.
8699
frameborder="0"
87100
<!-- Optionally replace * with your enterprise-specific domain (for example, mycompanydomain.app.box.com) -->
88101
allow="local-network-access *; clipboard-read *; clipboard-write *"
102+
<!-- Optionally replace * with your enterprise-specific domain (for example, mycompanydomain.app.box.com) -->
103+
allow="local-network-access *; clipboard-read *; clipboard-write *"
89104
allowfullscreen
90105
webkitallowfullscreen
91106
msallowfullscreen>
@@ -142,6 +157,8 @@ You can also set the page to Root Folder/All Files page. Set the URL to
142157
Next, you will want to choose your view customization options. The following is
143158
a list of optional parameters you can configure.
144159

160+
| | |
161+
| -- | -- |
145162
| | |
146163
| -- | -- |
147164
| `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
265282

266283
#### Using the close button
267284

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`.
269286

270287
##### Enabling the close button
271288

@@ -368,6 +385,9 @@ would look something like this.
368385
https://app.box.com/preview/expiring_embed/[HASH]?[parameterName]=true
369386
```
370387

388+
| | |
389+
| --- | --- |
390+
| `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`. |
371391
| | |
372392
| --- | --- |
373393
| `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.
418438
[6]: g://embed/box-embed/#box-hubs-ai-chat-embedding
419439
[7]: g://embed/box-embed/#chat-button
420440
[8]: g://embed/box-embed/#chat-widget
441+
[9]: g://embed/box-embed/#using-the-close-button
442+
[6]: g://embed/box-embed/#box-hubs-ai-chat-embedding
443+
[7]: g://embed/box-embed/#chat-button
444+
[8]: g://embed/box-embed/#chat-widget
421445
[9]: g://embed/box-embed/#using-the-close-button

0 commit comments

Comments
 (0)