> For the complete documentation index, see [llms.txt](https://docs.airdev.co/canvas/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.airdev.co/canvas/4.1/canvas-library/popups/rating-popup.md).

# Rating Popup

## Overview

![](/files/Kup7xvNQ5jLrJValateg)

A popup with a star rating and input fields for submitting a rating or review.

## Structure

The popup includes the following:

* **Group Collapsible rating**&#x20;
  * This group contains a star rating input where a user can click on one of the stars to submit a rating.
  * The user's rating will be temporarily stored in **Group inner rating\_number** which has a number data type.
  * This group will be hidden when **Group inner rating\_number's** data source is not empty (i.e., the user has selected a star rating).
* **Group Collapsible feedback**
  * This group contains a multiline input for user feedback and two buttons.
  * This group will be hidden when **Group inner rating\_number's** data source is empty (i.e., the user hasn't selected a star rating yet).
* The popup can't be closed by pressing 'Esc'.
* Clicking on Button Not now or Button Send feedback will close the popup.

## How to set up

* Update the content in **Group Inner top section rating**
  * You can use this [website](https://www.manypixels.co/gallery/) to add new graphics or change colors
  * Update title&#x20;
  * Update background color
* Add a workflow on the page to show **Popup ratingPopup**
  * In this workflow, before the show popup step, add a new workflow step to Reset Group inner rating\_number (this will reset the popup to show **Group Collapsible rating**).
* Add a workflow to **Button Send feedback**
  * For example, you may want to send an email or save the rating to the database


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.airdev.co/canvas/4.1/canvas-library/popups/rating-popup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
