Feedback Component

The Feedback component asks users to rate the content they have just worked through and, optionally, tell you what they would improve. You place it in the content yourself, as many times as you like, so you can ask for feedback where it matters – after a difficult chapter, halfway through, or on the final page – instead of only at the very end.

Every rating a user gives feeds the lab’s Happiness score in Content Reporting, and you can read the individual ratings and comments on the Lab feedback report.

Adding a Feedback component

The Feedback component is available in the Instructions editor.

1. Place your cursor on an empty line and type / to open the insert menu, then choose Feedback under Blocks.
2. Alternatively, click + Insert in the toolbar and choose Feedback under Blocks.

The editor gives the new component a Feedback ID and opens its settings. In the editor, the block appears as a card reading “Feedback” with its ID underneath. It marks where the rating prompt will appear for users. You can drag it to move it like any other block.

Configuration

Click the block to open its settings.

Setting	Description
Feedback ID	Identifies this component, so a user who comes back to it during the same play updates their rating instead of adding a new one. Filled in for you from the page title plus a random suffix, for example getting-started-a1b2c3. Letters are lowercased and spaces become hyphens. Required, and must be unique on the page.

The question wording and the rating scale are the same everywhere you place the component.

Copying, pasting, or duplicating a Feedback component gives the copy a new ID, so two components never share one by accident.

What users see

The component walks users through three short steps:

1. Rating. The card asks “How did you find the content?” and shows five smileys for a rating from 1 to 5 out of 5. Clicking a smiley submits the rating straight away.
2. Written feedback. The card thanks the user and asks “What would you improve?”, with an optional text field and a Submit button. The rating is already saved at this point, so a user who leaves without writing anything still counts.
3. Thanks. The card confirms the feedback was sent and offers a Change feedback button. Clicking it returns to the rating step, and the new rating replaces the earlier one.

Each Feedback component on a page collects its own rating, one per user per play. If a user revisits the page or reloads the lab during the same play, the component starts again at the rating step, and the new rating replaces their earlier one. A new play of the lab collects a new rating.

Using the code workflow

In markdown, the component is stored as a tag with an id attribute:

<instruqt-feedback id="getting-started-a1b2c3"></instruqt-feedback>

Attribute	Description
id	The Feedback ID. Use lowercase letters, numbers, and hyphens, and keep it unique within the lab.

The id is optional in markdown, but leave it out only if you have to. Without one, the component can’t recognize a returning user, so a user who reloads the lab and rates it again adds a second rating. Feedback components added before Feedback IDs existed have no id; open the page in the editor and click the component to give it one.

Best practices

1. Ask more than once in a long lab. A component at the end of each chapter tells you which part of the lab users struggled with, and collects ratings from users who never reach the end.
2. Put one on the final page. Paired with the Completion component, it catches users at the natural moment to reflect, before they leave.
3. Don’t place several on the same page. Users rarely rate the same content twice in a row, and the extra prompts add noise.
4. Keep the generated ID. There is rarely a reason to change it. If you do change it after users have rated the component, ratings already given still count, but a user returning in the same play adds a new rating instead of replacing their old one.