> For the complete documentation index, see [llms.txt](https://help.rbsgo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.rbsgo.com/dineplan/backoffice/printer/widget.md).

# Widget

### **Overview** <a href="#overview.3" id="overview.3"></a>

The Widget setting allows you to create and manage widgets used in the system. Widgets can be configured with different types, and the available options may vary depending on the selected type.

You can add, edit, delete, and change the display order of widgets.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-1d37be7e8f7fe5616d6533bc7440e9cf2cdb5592%2Fimage%20(126).png?alt=media" alt=""><figcaption></figcaption></figure>

### **Screen Elements** <a href="#screen-elements.4" id="screen-elements.4"></a>

| **Screen Element**    | **Description**                                                                                            |
| --------------------- | ---------------------------------------------------------------------------------------------------------- |
| Widget List           | Displays the widgets configured in the system.                                                             |
| Search                | Allows you to search for a specific widget.                                                                |
| Add Widget            | Opens the screen to create a new widget.                                                                   |
| Edit Widget           | Allows you to modify the selected widget.                                                                  |
| Delete Widget         | Allows you to remove the selected widget after confirmation.                                               |
| Change Sort Order     | Allows you to change the order in which widgets are displayed.                                             |
| Widget Name           | Specifies the name of the widget.                                                                          |
| Type                  | Allows you to select the widget type. The available configuration options vary based on the selected type. |
| Item Content Template | Provides the area to enter the content template for the widget.                                            |
| Save                  | Saves the widget configuration.                                                                            |
| Close                 | Closes the current screen.                                                                                 |

### **Working** <a href="#working.4" id="working.4"></a>

#### **Add a Widget** <a href="#add-a-widget" id="add-a-widget"></a>

1. Select “Add Widget."

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-0bb86a5bdba44b81f3ef5a3ac6e515fb05b82f9e%2Fatt_38_for_3422650369.png?alt=media" alt=""><figcaption></figcaption></figure>

2. Enter the widget name in Widget Name.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-e968c7b4b188e6e66ed85d6736c4b373bdf07649%2Fatt_39_for_3422650369.png?alt=media" alt=""><figcaption></figcaption></figure>

3. Select the required “Type."

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-b02486499f4a7786c4857ecd8b59ef2216cb5233%2Fatt_40_for_3422650369.png?alt=media" alt=""><figcaption></figcaption></figure>

4. Configure the fields available for the selected type.
5. Enter the required content in Item Content Template, where applicable.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-0b1713dd1c55b123c23c38da6b73f9b207267e23%2Fatt_41_for_3422650369.png?alt=media" alt=""><figcaption></figcaption></figure>

6. Select “Save" to create the widget.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-cb29dec29a88496e74fee63f2320610112b896c0%2Fatt_42_for_3422650369.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Widget Types** <a href="#widget-types" id="widget-types"></a>

The Type field provides different widget types, including:

* Image
* Video
* Slide
* Queue
* Ticket

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-a4639071fdec1017352a092ee9e93b59c1122e86%2Fatt_43_for_3422650369.png?alt=media" alt=""><figcaption></figcaption></figure>

The configuration options available on the screen may differ based on the selected widget type.

#### **Edit a Widget** <a href="#edit-a-widget" id="edit-a-widget"></a>

1. Select the widget you want to modify from the Widget List.
2. Select “Edit Widget."

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-990c4442035db60c958733b326fb13a15a140b23%2Fatt_44_for_3422650369.png?alt=media" alt=""><figcaption></figcaption></figure>

3. Modify the required widget details.
4. Select “Save" to apply the changes.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-cb29dec29a88496e74fee63f2320610112b896c0%2Fatt_42_for_3422650369.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Delete a Widget** <a href="#delete-a-widget" id="delete-a-widget"></a>

1. Select the widget you want to remove.
2. Select “Delete Widget."

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-637595999c2fe2c9b60bd3b6ab8f9b6718158094%2Fatt_46_for_3422650369.png?alt=media" alt=""><figcaption></figcaption></figure>

3. A confirmation message is displayed.
4. Select “Yes" to delete the widget, or select “No" to cancel the action.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-f091e63b97875e9642a7854175f3adc5bb06cbb9%2Fatt_47_for_3422650369.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Change Sort Order** <a href="#change-sort-order.3" id="change-sort-order.3"></a>

1. Select the widget from the list.
2. Select “Change Sort Order."

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-b0f1373b42a29c54e4954c031e808ed6cda9db56%2Fatt_48_for_3422650369.png?alt=media" alt=""><figcaption></figcaption></figure>

3. Adjust the widget's position as required.

### **Use Case** <a href="#use-case.4" id="use-case.4"></a>

* Display promotional images or visual content on screens used within the restaurant.
* Present videos to customers for promotions, announcements, or other relevant information.
* Create slideshows to display multiple images or messages in sequence.
* Display queue information to help customers track their position or waiting status.
* Present ticket-related information on screens where customers or staff need to view ticket details.
* Configure different types of content based on the purpose of the display or the information that needs to be presented.
* Update widget content when promotional materials, displayed information, or operational requirements change.
* Organize multiple widgets in a preferred order to control how the configured content is presented.

### **Notes** <a href="#notes.4" id="notes.4"></a>

* The available configuration fields depend on the selected Type.
* A Widget Name is required to save a widget.
* Select Save after adding or editing a widget to apply the changes.
* Select Yes in the confirmation dialog to permanently delete a selected widget.
* Select No to cancel a deletion.
* Widgets can be searched using the Search field.
* You can add, edit, delete, and change the sort order of widgets.
* Ensure that the appropriate widget Type is selected before configuring its additional options.

<br>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.rbsgo.com/dineplan/backoffice/printer/widget.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
