| Name | Type | Default | Description |
|---|---|---|---|
className | string | | Additional CSS classes. |
displayText | string | | The text to be displayed. |
ref | Ref<HTMLAnchorElement |HTMLSpanElement> | | Ref for the wrapping element. |
value | string | | Email address, no 'mailto:' scheme |
variant | 'link' |'text' | "link"
| Controls styling of the field. |
EmailDisplay
The EmailDisplay component renders an email address as either a Link that will open a user's preferred email application, or as plain Text.
For more information on how to use the features and props for this component, check out the developer documentation.
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.