MailtoLink

MailtoLink Props API

children
node Required
Content of the MailToLink
className
string
Custom class names for the MailToLink
to
emailPropType[] | emailPropType
Specifies the email's recipients
Default[]
cc
emailPropType[] | emailPropType
Specifies the email's carbon copy recipients
Default[]
bcc
emailPropType[] | emailPropType
Specifies the email's blind carbon copy recipients
Default[]
subject
string
Specifies the email's subject
Default''
body
string
Specifies the email's body
Default''
target
string
Specifies where the link should open. The default behavior is _self, which means that the URL will be loaded into the same browsing context as the current one
Default'_self'
onClick
func
Specifies the callback function when the link is clicked
Defaultnull
externalLink
shape {
alternativeText: isRequiredIf(PropTypes.string, props => props.target === '_blank'),
title: isRequiredIf(PropTypes.string, props => props.target === '_blank'),
}
The object that contains the alternativeText and title fields which specify the text and title for links with a _blank target (which loads the URL in a new browsing context).
Default{ alternativeText: 'in a new tab', title: 'Opens in a new tab', }

Paragon Design System