Skip to content

Commit 14429f0

Browse files
Implement feedback
1 parent b3ff9a6 commit 14429f0

File tree

3 files changed

+52
-19
lines changed

3 files changed

+52
-19
lines changed

content/guides/embed/box-embed.md

Lines changed: 52 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Box Web App experience in a custom-made application. Box Embed provides the abil
1717

1818
To create a widget, you need to:
1919

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.
2121
* Have at least **Viewer** [permissions][5].
2222

2323
## Using web app
@@ -32,23 +32,23 @@ To fetch the Box Embed widget code from the Box web app, perform the following s
3232

3333
### Hubs
3434

35-
1. Navigate to the chosen Hub.
35+
1. Navigate to the chosen hub.
3636
2. Click on the ellipsis menu in the upper-right corner.
3737
3. Click **Embed Hub**.
3838

3939
<Message type='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.
4141
</Message>
4242

4343
### Notes
4444

45-
1. Navigate to the chosen Box Note.
45+
1. Navigate to the chosen note.
4646
2. Click on the ellipsis menu.
4747
3. Click **Embed Box Note**.
4848

4949
### Apps
5050

51-
1. Navigate to the chosen Box App or Box App View.
51+
1. Navigate to the chosen app or Box App View.
5252
2. Click on the ellipsis menu.
5353
3. Click **Embed**.
5454

@@ -141,8 +141,8 @@ You can also set the page to Root Folder/All Files page. Set the URL to
141141
Next, you will want to choose your view customization options. The following is
142142
a list of optional parameters you can configure.
143143

144-
| | |
145-
| --------------------- | -------------------------------------------------------------------------------------------- |
144+
| | |
145+
| -- | -- |
146146
| `hideHubsGallery` | Hide or show navigation chevron button to go back to Hubs gallery. Can be `true` or `false` (default). |
147147
| `hideNavigationControls` | Hide or show navigation controls in Box Notes.|
148148
| `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:
190190
4. Select the **Hub AI Chat** tab.
191191
5. Select chat mode:
192192

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]
195195

196196
6. Copy the embed code.
197197

198-
### Parameters
198+
<Message type='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+
<ImageFrame border>
207+
![Chat button mode](./chat-button.png)
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+
<ImageFrame border>
226+
![Chat widget mode](./chat-widget.png)
227+
</ImageFrame>
228+
229+
#### Chat widget parameters
199230

200-
The AI Chat embed mode supports the following URL parameters:
231+
The **Chat button** mode supports the following parameters:
201232

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). |
207238

208239
## Expiring embed links
209240

@@ -275,9 +306,9 @@ would look something like this.
275306
https://app.box.com/preview/expiring_embed/[HASH]?[parameterName]=true
276307
```
277308

278-
| | |
279-
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
280-
| `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`. |
281312
| `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. |
282313

283314
## Cloud game
@@ -323,3 +354,5 @@ and **print** options might not show in mobile browsers.
323354
[5]: https://support.box.com/hc/en-us/articles/360044196413-Understanding-Collaborator-Permission-Levels
324355
[cloud-game]: https://support.box.com/hc/en-us/articles/360043691034-How-Does-Box-Prevent-Clickjacking
325356
[6]: g://embed/box-embed/#box-hubs-ai-chat-embedding
357+
[7]: g://embed/box-embed/#chat-button
358+
[8]: g://embed/box-embed/#chat-widget
2.41 MB
Loading
75.1 KB
Loading

0 commit comments

Comments
 (0)