Page History
...
- Localize user-visible text with
title(language map). - Localize guided-tour copy with
guidedTourHotSpotTitleandguidedTourHotSpotDescription. - Keep
titleconcise to avoid truncation in tight spaces; use the document itself for detailed naming, not the title line.
Dos & Don’ts
| Do | Don’t | Article setting(s) |
|---|---|---|
| Bind the viewer to a concrete source and pass explicit parameters for determinism. | Rely on implicit/global state for which document appears. | dataSourceId, getEntityCollectionHttpRequestParametersMap |
| Localize the title so users understand what they’re viewing. | Hard-code an English-only title. | title |
| Preserve exact layout for formal documents. | Force-fit precise layouts that become blurry or misaligned. | originalSize |
| Disable text selection for sensitive PDFs. | Leave selection on when copying must be prevented. | allowSelectText |
| Add spacing using the component’s own token. | Hack spacing with external CSS not controlled by the component. | paddingClass |
| Hide the viewer until a document is available. | Show an empty/blank frame. | displayConditions |
| Hide confidential documents from unauthorized users. | Show the component and rely on the document to say “no access.” | visibilityPolicySetId |
| Provide stable automation hooks for QA. | Target the viewer with brittle selectors (e.g., DOM order). | id, dataTestId |
| Use localized copy for guided tours. | Show untranslated hotspot text. | enableAsHotspot, guidedTourHotSpotTitle, guidedTourHotSpotDescription |
...
