Draft
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
thomaswhyyou
reviewed
Apr 9, 2026
| title="SDK requirement." | ||
| text={ | ||
| <> | ||
| The guides toolbar requires <code>@knocklabs/react</code> v0.11.8 or |
Contributor
There was a problem hiding this comment.
Suggested change
| The guides toolbar requires <code>@knocklabs/react</code> v0.11.8 or | |
| The guides toolbar requires <code>@knocklabs/react</code> v0.11.13 or |
This is the latest version now.
Comment on lines
+52
to
+54
| - **All guides.** Every guide in your environment. | ||
| - **Eligible.** Guides that pass all eligibility checks for the current user. | ||
| - **On this page.** Guides whose target element exists on the current page. |
Contributor
There was a problem hiding this comment.
The filter has been updated to: All, Active, and Eligible.
| | **Inactive** | The guide has not been published or is currently inactive. | | ||
| | **Archived** | The current user has already dismissed this guide. | | ||
| | **Not targeted** | The current user doesn't meet the guide's targeting conditions. | | ||
| | **Not found** | No component that can render this guide was found on the page. | |
Contributor
There was a problem hiding this comment.
Suggested change
| | **Not found** | No component that can render this guide was found on the page. | | |
| | **Not queried** | No component that can render this guide was found on the page. | |
The label has been updated to "Not queried" for this status.
| Each guide row displays three eligibility ("Elig.") indicators. A filled dot means the condition passes; an X means it fails. All three must pass for a guide to display. | ||
|
|
||
| 1. **Active.** The guide is published and active. | ||
| 2. **Not archived.** The guide has not been dismissed for the current user. |
Contributor
There was a problem hiding this comment.
Suggested change
| 2. **Not archived.** The guide has not been dismissed for the current user. | |
| 2. **Archived.** The guide has not been dismissed for the current user. |
We flipped this to remove the double negative, per Sam's suggestion.
| - **Ready.** A component found the guide and is actively returning it for display. | ||
| - **Throttled.** A component found the guide, but throttling rules are holding it back. | ||
| - **Queued.** The guide is available but not yet ready to display because another guide is ahead of it in the display sequence. | ||
| - **Not found.** No component on the page can render this guide. |
Contributor
There was a problem hiding this comment.
Suggested change
| - **Not found.** No component on the page can render this guide. | |
| - **Not queried.** No component on the page can render this guide. |
| Two visibility ("Vis.") indicators show the guide's display state: | ||
|
|
||
| 1. **Activated.** The guide's trigger condition has been met in the current location. | ||
| 2. **Selectable.** The availability and readiness of the target component on the current page. Possible values: |
Contributor
There was a problem hiding this comment.
Suggested change
| 2. **Selectable.** The availability and readiness of the target component on the current page. Possible values: | |
| 2. **Display.** The availability and readiness of the target component on the current page. Possible values: |
|
|
||
| Two visibility ("Vis.") indicators show the guide's display state: | ||
|
|
||
| 1. **Activated.** The guide's trigger condition has been met in the current location. |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. **Activated.** The guide's trigger condition has been met in the current location. | |
| 1. **Activation** The guide's trigger condition has been met in the current location. |
| ### Toolbar controls | ||
|
|
||
| - **Drag handle.** Drag to reposition the toolbar anywhere within the viewport. The toolbar stays within viewport bounds and re-clamps automatically on window resize. | ||
| - **Sandbox.** Prevents engagement API calls (seen, interacted, dismissed) from being sent to Knock. Local state still updates so the UI reflects changes, but nothing is recorded in Knock. Use this to test continuously without needing to reset engagement. |
Contributor
There was a problem hiding this comment.
Suggested change
| - **Sandbox.** Prevents engagement API calls (seen, interacted, dismissed) from being sent to Knock. Local state still updates so the UI reflects changes, but nothing is recorded in Knock. Use this to test continuously without needing to reset engagement. | |
| - **Sandbox engagement.** Prevents engagement API calls (seen, interacted, dismissed) from being sent to Knock. Local state still updates so the UI reflects changes, but nothing is recorded in Knock. Use this to test continuously without needing to reset engagement. |
| - **Drag handle.** Drag to reposition the toolbar anywhere within the viewport. The toolbar stays within viewport bounds and re-clamps automatically on window resize. | ||
| - **Sandbox.** Prevents engagement API calls (seen, interacted, dismissed) from being sent to Knock. Local state still updates so the UI reflects changes, but nothing is recorded in Knock. Use this to test continuously without needing to reset engagement. | ||
| - **Ignore throttle.** Bypasses the display interval throttle window so guides can display immediately, regardless of when the last guide was dismissed. | ||
| - **Inspect target params.** Opens a panel showing the tenant and data params being used to evaluate guide [targeting](/in-app-ui/guides/create-guides#targeting) for the current user. |
Contributor
There was a problem hiding this comment.
Suggested change
| - **Inspect target params.** Opens a panel showing the tenant and data params being used to evaluate guide [targeting](/in-app-ui/guides/create-guides#targeting) for the current user. | |
| - **Settings & target params.** Opens a panel showing the tenant and data params being used to evaluate guide [targeting](/in-app-ui/guides/create-guides#targeting) for the current user. |
Also, now the "Sandbox engagement" and the "Ignore throttle" toggles are folded into this expandable area, so maybe we want to bring them down here as sub bullets?
|
|
||
| <AccordionGroup> | ||
| <Accordion title="How can I test guides with an older SDK version?"> | ||
| If you're on `@knocklabs/react` v0.8.0 or above, but haven't upgraded to v0.11.8 yet, you can still preview guides in your application using live preview: |
Contributor
There was a problem hiding this comment.
Heads up: Live preview is effectively being replaced with the new toolbar, so it won't be there once we GA. We probably just want to nudge people to upgrade to >v0.11.13?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
KNO-12444: [Docs] Document guides toolbar
Summary
debugging-guides.mdxto provide better TOC navigation options and add guides toolbar in place of live preview documentationChanges
content/in-app-ui/guides/debugging-guides.mdx— restructured page; added guides toolbar section with SDK requirement callout; moved live preview to FAQ accordion; updated dashboard preview callout to reference toolbarTODO