Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • visibilityPolicySetId – Determines the visibility of the component based on specified policy sets. For example, setting to "contentAccessPolicy" restricts the content visibility to users with specific access permissions, allowing for role-based display of sensitive information.

Guidelines

Usage

  • Embed and reuse content by setting contentId to the target unit; the component renders that content in place and stays context-aware.
  • Expose stable automation handles via id and dataTestId for scripts and tests.
  • Make onboarding discoverable by enabling a hotspot with enableAsHotspot and provide localized text via guidedTourHotSpotTitle and guidedTourHotSpotDescription.

Sizing & Layout

  • Set a predictable height with customHeight using valid CSS lengths (e.g., 400px, 28rem, 100%) to prevent layout shift.
  • Control interior spacing with paddingClass; keep a consistent spacing scale to reinforce grouping and hierarchy.

Data-Driven / Conditional Behavior

  • Use displayConditions to show or hide the entire component for high-level gating (progressive disclosure of non-essential content).
  • Use rules for precise, context-field logic (field, operator, threshold). When matching multiple allowed values, define one rule per value for clarity.
  • Keep conditions mutually exclusive and based on stable fields to avoid rapid toggling.

Visibility & Authorization

  • Restrict visibility for sensitive content with visibilityPolicySetId.
  • When both role and state must align, combine visibilityPolicySetId with displayConditions.

Content & Localization

  • Localize hotspot copy with guidedTourHotSpotTitle and guidedTourHotSpotDescription.
  • Use displayName only for authoring clarity in the structure panel; it does not affect end-user text.

Dos & Don’ts

DoDon’tArticle setting(s)
Gate sensitive content with policy sets.Show to all users and rely on embedded content to refuse access.visibilityPolicySetId
Apply interior spacing via tokenized classes to reflect hierarchy.Depend on surrounding layout to create padding.paddingClass
Stabilize layout by declaring a height.Allow uncontrolled growth that shifts adjacent UI.customHeight
Enable hotspots to guide discovery.Hide onboarding cues inside unrelated components.enableAsHotspot

...