Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.emailux.com/llms.txt

Use this file to discover all available pages before exploring further.

1. Install dependencies

Install the EmailUX Email package locally and a few components.
# pnpm
pnpm add @emailux/components

# npm
npm install @emailux/components

# yarn
yarn add @emailux/components

2. Usage

import { Font } from "@emailux/components";

export default function EmailTemplate() {
  return <Font 
            family='Inter'
            url='https://fonts.gstatic.com/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZJhiJ-Ek-_EeAmM.woff2'
            type='woff2'
            fallback='Arial'
            style='normal'
            weight='400'
            targetSelectors={['body', '.emailux-table']}
          />
}

Props

NameTypeRequiredDefaultDescription
childrenReact.ReactNodeYesContent of the email document
familyStringYes-
urlStringYes-
typeStringYes“woff2” or “woff”
styleStringYes-
weigthStringYes400
targetSelectorsArray of css selector stringsNo
All other standard Head attributes for the <head> element are supported.