01
Overview
GuidanceRegion provides a context-scoped claim registry. Claims are filtered by version windows and can be dismissed or reset through a consumer-owned storage adapter.
02
When to use
Use when
- Coordinating coachmarks that must respect product versions and reversible dismissal.
Avoid when
- Showing an isolated anchored explanation without registry lifecycle; use Popover.
03
Examples
Basic guidance region
Provide contextual guidance claims to an application surface.
04
Props
Name | Type | Default | Description |
|---|---|---|---|
claims | GuidanceClaim[] | [] | |
version | text | ||
storage | GuidanceStorage | ||
storageKey | text | 'cinder-guidance' | |
anchorResolver | (anchor: string) => HTMLElementnull | Resolves a claim anchor using consumer-owned DOM knowledge. | |
children | snippet |