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 { Button } from "@emailux/components";

<Button
 text='Submit'
 href='https://example.com'
 backgroundColor='#000'
 textColor='#ffff'
 borderRadius='20px'
 style={{
  paddingBottom: '20px'
 }}
/>

Props

NameTypeRequiredDefaultDescription
srcstringYes""Path or URL to the image
dir”ltr” | “rtl”NoComes from wrapping Html component’s dir context prop which is ltrText direction
spacingstringNoComes from wrapping Html component’s defaultSpacing context prop which is 20pxSpacing bottom, by default comes from Html defaultSpacing prop
hrefstringYes""
iconobjectNo{ url, alt, width, height }
backgroundColorstringYes""
alignstringNo”center”
directionstringNo”ltr”
textColorstringNocss color hex
borderRadiusstringNo
stylestringNoCSS style
borderWidthstringNoCSS border width
borderColorstringNoCSS border color