import { FullWidthImage } from "@/components/email/full-width-image";
import { defaultTheme } from "@/components/email/theme-default";
export function FullWidthImageDemo() {
return (
<FullWidthImage
overlay
frame="none"
frameStyle="padding"
theme={{ ...defaultTheme, containerWidth: "640px" }}
/>
);
}Installation
$ pnpm dlx shadcn@latest add @emailcn/react-email/full-width-image
Usage
import { FullWidthImage } from "@/components/email/full-width-image";<FullWidthImage frame="none" frameStyle="padding" overlay={false} />Examples
Full-width image
Default
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFalseFrameNoneFrameStylePaddingExampleDemo() {
return <FullWidthImage overlay={false} frame="none" frameStyle="padding" />;
}Top padding
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFalseFrameTopFrameStylePaddingExampleDemo() {
return <FullWidthImage overlay={false} frame="top" frameStyle="padding" />;
}Top right
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFalseFrameTopFrameStyleAlternateExampleDemo() {
return <FullWidthImage overlay={false} frame="top" frameStyle="alternate" />;
}Top left
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFalseFrameTopFrameStyleSplitExampleDemo() {
return <FullWidthImage overlay={false} frame="top" frameStyle="split" />;
}Top + sides
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFalseFrameTopFrameStyleSidesExampleDemo() {
return <FullWidthImage overlay={false} frame="top" frameStyle="sides" />;
}Right padding
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFalseFrameRightFrameStylePaddingExampleDemo() {
return <FullWidthImage overlay={false} frame="right" frameStyle="padding" />;
}Right alt
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFalseFrameRightFrameStyleAlternateExampleDemo() {
return (
<FullWidthImage overlay={false} frame="right" frameStyle="alternate" />
);
}Bottom padding
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFalseFrameBottomFrameStylePaddingExampleDemo() {
return <FullWidthImage overlay={false} frame="bottom" frameStyle="padding" />;
}Bottom right
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFalseFrameBottomFrameStyleAlternateExampleDemo() {
return (
<FullWidthImage overlay={false} frame="bottom" frameStyle="alternate" />
);
}Bottom left
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFalseFrameBottomFrameStyleSplitExampleDemo() {
return <FullWidthImage overlay={false} frame="bottom" frameStyle="split" />;
}Bottom + sides
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFalseFrameBottomFrameStyleSidesExampleDemo() {
return <FullWidthImage overlay={false} frame="bottom" frameStyle="sides" />;
}Left padding
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFalseFrameLeftFrameStylePaddingExampleDemo() {
return <FullWidthImage overlay={false} frame="left" frameStyle="padding" />;
}Left alt
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFalseFrameLeftFrameStyleAlternateExampleDemo() {
return <FullWidthImage overlay={false} frame="left" frameStyle="alternate" />;
}Sides padding
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFalseFrameSidesFrameStylePaddingExampleDemo() {
return <FullWidthImage overlay={false} frame="sides" frameStyle="padding" />;
}Sides alt
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFalseFrameSidesFrameStyleAlternateExampleDemo() {
return (
<FullWidthImage overlay={false} frame="sides" frameStyle="alternate" />
);
}Full-width image with overlay
Default
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFrameNoneFrameStylePaddingExampleDemo() {
return <FullWidthImage overlay={true} frame="none" frameStyle="padding" />;
}Top padding
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFrameTopFrameStylePaddingExampleDemo() {
return <FullWidthImage overlay={true} frame="top" frameStyle="padding" />;
}Top right
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFrameTopFrameStyleAlternateExampleDemo() {
return <FullWidthImage overlay={true} frame="top" frameStyle="alternate" />;
}Top left
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFrameTopFrameStyleSplitExampleDemo() {
return <FullWidthImage overlay={true} frame="top" frameStyle="split" />;
}Top + sides
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFrameTopFrameStyleSidesExampleDemo() {
return <FullWidthImage overlay={true} frame="top" frameStyle="sides" />;
}Right padding
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFrameRightFrameStylePaddingExampleDemo() {
return <FullWidthImage overlay={true} frame="right" frameStyle="padding" />;
}Right alt
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFrameRightFrameStyleAlternateExampleDemo() {
return <FullWidthImage overlay={true} frame="right" frameStyle="alternate" />;
}Bottom padding
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFrameBottomFrameStylePaddingExampleDemo() {
return <FullWidthImage overlay={true} frame="bottom" frameStyle="padding" />;
}Bottom right
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFrameBottomFrameStyleAlternateExampleDemo() {
return (
<FullWidthImage overlay={true} frame="bottom" frameStyle="alternate" />
);
}Bottom left
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFrameBottomFrameStyleSplitExampleDemo() {
return <FullWidthImage overlay={true} frame="bottom" frameStyle="split" />;
}Bottom + sides
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFrameBottomFrameStyleSidesExampleDemo() {
return <FullWidthImage overlay={true} frame="bottom" frameStyle="sides" />;
}Left padding
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFrameLeftFrameStylePaddingExampleDemo() {
return <FullWidthImage overlay={true} frame="left" frameStyle="padding" />;
}Left alt
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFrameLeftFrameStyleAlternateExampleDemo() {
return <FullWidthImage overlay={true} frame="left" frameStyle="alternate" />;
}Sides padding
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFrameSidesFrameStylePaddingExampleDemo() {
return <FullWidthImage overlay={true} frame="sides" frameStyle="padding" />;
}Sides alt
import { FullWidthImage } from "@/components/email/full-width-image";
export function FullWidthImageOverlayFrameSidesFrameStyleAlternateExampleDemo() {
return <FullWidthImage overlay={true} frame="sides" frameStyle="alternate" />;
}API Reference
| Prop | Type | Default | Description |
|---|---|---|---|
theme | EmailTheme | defaultTheme | Renderer theme configuration. |
image | { src: string; alt?: string; href?: string; heading?: string; subtext?: string } | - | Configures the component's image. |
overlay | boolean | false | Configures the component's overlay. |
frame | "none" | "top" | "right" | "bottom" | "left" | "sides" | "none" | Configures the component's frame. |
frameStyle | "padding" | "split" | "alternate" | "sides" | "padding" | Configures the component's framestyle. |
On This Page
InstallationUsageExamplesFull-width imageDefaultTop paddingTop rightTop leftTop + sidesRight paddingRight altBottom paddingBottom rightBottom leftBottom + sidesLeft paddingLeft altSides paddingSides altFull-width image with overlayDefaultTop paddingTop rightTop leftTop + sidesRight paddingRight altBottom paddingBottom rightBottom leftBottom + sidesLeft paddingLeft altSides paddingSides altAPI Reference