| Name | Description | Default | Type |
|---|---|---|---|
className | Additional CSS classes. | | string |
displayText | The text to be displayed. | | string |
ref | Ref for the wrapping element. | | Ref<HTMLAnchorElement |HTMLSpanElement> |
value | Email address, no 'mailto:' scheme | | string |
variant | Controls styling of the field. | "link" | 'link' |'text' |
EmailDisplay
core package3.2.2
Note: All components shown on this site are supported by the Constellation design system. To learn how to configure Theme Cosmos, visit Pega Community.
The EmailDisplay component renders an email address as either a Link that will open a user's preferred email application, or as plain Text.
Usage
The value passed to the EmailDisplay component should be a formatted email address in order to guarantee flawless intergration if a user were to click on the EmailDisplay when it's set as a link variant.
If no displayText is provided, the display will default to the value given. The component displays "--" in the case of an undefined value.