Paragon Design System

Technical Documentation

Theme

PlaygroundBeta

  • A drag-and-drop UI builder for prototyping with Paragon components.Visit playground
npm_versionnpm Paragon package page

MailtoLink

minimal usage

Any Paragon component or export may be added to the code example.

with blank target

Any Paragon component or export may be added to the code example.

with onClick

Any Paragon component or export may be added to the code example.

with subject and body

Any Paragon component or export may be added to the code example.

with cc and bcc

Any Paragon component or export may be added to the code example.

with multiple cc and bcc

Any Paragon component or export may be added to the code example.

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: MAIL_TO_LINK_EXTERNAL_LINK_ALTERNATIVE_TEXT, title: MAIL_TO_LINK_EXTERNAL_LINK_TITLE, }

Contents

All components (A-Z)