Document
Dernière mise à jour
Cet article vous a-t-il été utile ?
Dernière mise à jour
Cet article vous a-t-il été utile ?
A widget Document lets you integrate a Page document into your product or website to deliver contextual education.
To create a Document widget, click on the New button in the top right-hand corner and then on Document. A drawer opens:
Choose the rendering mode for your widget:
Embed: the widget appears as an embed and you can integrate it anywhere on your site or application.
Modal: the widget is in a window opened with a button.
Drawer: the widget is in a side panel opened with a button.
Enter a title. This title will not be visible in the widget integrated into your application.
Select a course using the search bar.
Click on Create: that's it, your widget is ready to be integrated!
You can edit a widget in two different ways:
From the widget list, by clicking on the three small dots to the right of a widget's card and then on Edit.
From the widget preview window, click on Edit.
The widget drawer opens, where you can edit :
The widget's rendering type. Warning, switching your widget type requires you to update the code.
The widget title
The selected doucment: simply click on the X button at the top right of the selected document and use the search bar to find the required document.
Once you've made all your changes, you can save the widget by clicking on Save.
The widget preview depends on its rendering type:
If it's an Embed or Modale widget: When you click on a widget card, a window opens. In this window, you can see a preview of the widget's rendering in your application or site (in the case of an embed, grey zones materialize the content of your site).
If it's a Drawer widget: when you click on a widget's card, a side panel opens. Here you can see a preview of how the widget will look in your application or site.
At the bottom of the modal, there are several buttons:
Edit: opens the editing drawer.
Many members of your site or application will be able to access your widget. Don't worry, they will only see the document if they have access to it.
To access a document,
The member must be logged in
The member must have access to the collection containing the document (either because the collection is public, or because it is private, but the member is invited to the collection).
The document must be published (unless the member is an admin or has "manage & create collections" permission).
If a member displays the document widget and has access to it, the corresponding activity will be taken into account and you will be able to find it in the Dashboard page of your Spot settings.
To ensure that the user sees the widget content while logged in, we recommend that you set up SSO authentication in the widget integration space.
There are 2 ways to delete a widget:
From the widget card, click on the three small dots on the right, then on Delete.
From the widget editing drawer, click on the three small dots in the top right-hand corner, then on Delete.
Clicking on either of these two buttons opens a confirmation window.
Warning, all deletions are final!
Get code: gives you the choice between the widget code directly by e-mail (with Send instructions) or the widget code (with Copy code).
Once SSO has been set up, the JWT token authenticating the user can be transmitted directly to the widget script. Find out more .
