myrtle

package module

Go to main page

Versions in this module

v0

v0.2.0

Jul 20, 2026

Changes in this version

type CalloutBlock

+ Markdown bool

type CalloutOption

+ func CalloutMarkdown() CalloutOption

type EmptyStateBlock

+ Markdown bool

type EmptyStateOption

+ func EmptyStateMarkdown() EmptyStateOption

type Group

+ func (group *Group) AddButtonGroup(buttons []ButtonGroupButton, options ...ButtonGroupOption) *Group

+ func (group *Group) AddCardList(cards []CardItem, options ...CardListOption) *Group

+ func (group *Group) AddColumns(leftGroup, rightGroup *Group, options ...ColumnsOption) *Group

+ func (group *Group) AddDistribution(header string, buckets []DistributionBucket, options ...DistributionOption) *Group

+ func (group *Group) AddEmptyState(title, body, actionLabel, actionURL string, options ...EmptyStateOption) *Group

+ func (group *Group) AddFooterLinks(links []FooterLink, note string) *Group

+ func (group *Group) AddGrid(items []GridItem, options ...GridOption) *Group

+ func (group *Group) AddGridGroups(groups []*Group, options ...GridOption) *Group

+ func (group *Group) AddHero(title, body, ctaLabel, ctaURL string, options ...HeroOption) *Group

+ func (group *Group) AddPanel(content Block, options ...PanelOption) *Group

+ func (group *Group) AddPriceSummary(header string, items []PriceLine, totalLabel, totalValue string, ...) *Group

+ func (group *Group) AddProgress(header string, items []ProgressItem, options ...ProgressOption) *Group

+ func (group *Group) AddSparkline(header, label, value string, points []int, options ...SparklineOption) *Group

+ func (group *Group) AddStackedBar(header string, rows []StackedBarRow, options ...StackedBarOption) *Group

+ func (group *Group) AddTiles(entries []TileEntry, options ...TilesOption) *Group

type HeroBlock

+ Markdown bool

type HeroOption

+ func HeroMarkdown() HeroOption

type KeyValueBlock

+ Markdown bool

+ type KeyValueOption func(*KeyValueBlock)

+ func KeyValueMarkdown() KeyValueOption

type ListBlock

+ Markdown bool

+ type ListOption func(*ListBlock)

+ func ListMarkdown() ListOption

type QuoteBlock

+ Markdown bool

+ type QuoteOption func(*QuoteBlock)

+ func QuoteMarkdown() QuoteOption

type SummaryCardBlock

+ Markdown bool

type SummaryCardOption

+ func SummaryCardMarkdown() SummaryCardOption

type TextBlock

+ Markdown bool

type TextOption

+ func TextMarkdown() TextOption

type TimelineBlock

+ Markdown bool

type TimelineOption

+ func TimelineMarkdown() TimelineOption

v0.1.0

Mar 10, 2026

Changes in this version

+ const ButtonAlignmentCenter

+ const ButtonAlignmentEnd

+ const ButtonAlignmentStart

+ const ButtonSizeLarge

+ const ButtonSizeMedium

+ const ButtonSizeSmall

+ const ButtonStyleFilled

+ const ButtonStyleGhost

+ const ButtonStyleOutline

+ const TableBorderStyleDashed

+ const TableBorderStyleDotted

+ const TableBorderStyleSolid

+ const TableColumnAlignmentCenter

+ const TableColumnAlignmentEnd

+ const TableColumnAlignmentStart

+ const TableDensityCompact

+ const TableDensityNormal

+ const TableDensityRelaxed

+ const TableHeaderToneMuted

+ const TableHeaderTonePlain

+ const TableHeaderTonePrimary

+ var ErrThemeCannotRenderBlock = errors.New("myrtle: theme cannot render block")

+ type AttachmentBlock struct

+ CTA string

+ Filename string

+ InsetMode InsetMode

+ Meta string

+ URL string

+ func (block AttachmentBlock) Kind() theme.BlockKind

+ func (block AttachmentBlock) LayoutSpec() LayoutSpec

+ func (block AttachmentBlock) RenderText(_ RenderContext) (string, error)

+ func (block AttachmentBlock) TemplateData() any

+ type AttachmentOption func(*AttachmentBlock)

+ func AttachmentInsetMode(value InsetMode) AttachmentOption

+ type BadgeBlock struct

+ Text string

+ Tone Tone

+ func (block BadgeBlock) Kind() theme.BlockKind

+ func (block BadgeBlock) LayoutSpec() LayoutSpec

+ func (block BadgeBlock) RenderText(_ RenderContext) (string, error)

+ func (block BadgeBlock) TemplateData() any

+ type Block interface

+ Kind func() theme.BlockKind

+ LayoutSpec func() LayoutSpec

+ RenderText func(context RenderContext) (string, error)

+ TemplateData func() any

+ func NewCustomBlockWithLayoutSpec[T any](kind theme.BlockKind, data T, layoutSpec LayoutSpec, ...) Block

+ func NewCustomBlock[T any](kind theme.BlockKind, data T, renderHTML func(T, theme.Values) (string, error), ...) Block

+ type Builder struct

+ func NewBuilder(themeImpl theme.Theme, options ...BuilderOption) *Builder

+ func (builder *Builder) Add(block Block) *Builder

+ func (builder *Builder) AddAttachment(filename, meta, url, cta string, options ...AttachmentOption) *Builder

+ func (builder *Builder) AddBadge(tone Tone, text string) *Builder

+ func (builder *Builder) AddButton(label, url string, options ...ButtonOption) *Builder

+ func (builder *Builder) AddButtonGroup(buttons []ButtonGroupButton, options ...ButtonGroupOption) *Builder

+ func (builder *Builder) AddCallout(tone Tone, title, body string, options ...CalloutOption) *Builder

+ func (builder *Builder) AddCardList(cards []CardItem, options ...CardListOption) *Builder

+ func (builder *Builder) AddColumns(leftGroup, rightGroup *Group, options ...ColumnsOption) *Builder

+ func (builder *Builder) AddDistribution(header string, buckets []DistributionBucket, options ...DistributionOption) *Builder

+ func (builder *Builder) AddDivider(options ...DividerOption) *Builder

+ func (builder *Builder) AddEmptyState(title, body, actionLabel, actionURL string, options ...EmptyStateOption) *Builder

+ func (builder *Builder) AddFooterLinks(links []FooterLink, note string) *Builder

+ func (builder *Builder) AddFreeMarkdown(markdown string) *Builder

+ func (builder *Builder) AddGrid(items []GridItem, options ...GridOption) *Builder

+ func (builder *Builder) AddGridGroups(groups []*Group, options ...GridOption) *Builder

+ func (builder *Builder) AddHeading(text string, options ...HeadingOption) *Builder

+ func (builder *Builder) AddHero(title, body, ctaLabel, ctaURL string, options ...HeroOption) *Builder

+ func (builder *Builder) AddHorizontalBarChart(header string, items []HorizontalBarChartItem, ...) *Builder

+ func (builder *Builder) AddImage(src, alt string, opts ...ImageOption) *Builder

+ func (builder *Builder) AddKeyValue(header string, pairs []KeyValuePair) *Builder

+ func (builder *Builder) AddLegal(companyName, address, manageURL, unsubscribeURL string) *Builder

+ func (builder *Builder) AddList(items []string, ordered bool) *Builder

+ func (builder *Builder) AddMessage(message MessageBlock, options ...MessageOption) *Builder

+ func (builder *Builder) AddMessageDigest(messages []MessageBlock, options ...MessageDigestOption) *Builder

+ func (builder *Builder) AddPanel(content Block, options ...PanelOption) *Builder

+ func (builder *Builder) AddPriceSummary(header string, items []PriceLine, totalLabel, totalValue string, ...) *Builder

+ func (builder *Builder) AddProgress(header string, items []ProgressItem, options ...ProgressOption) *Builder

+ func (builder *Builder) AddQuote(text, author string) *Builder

+ func (builder *Builder) AddSpacer(options ...SpacerOption) *Builder

+ func (builder *Builder) AddSparkline(header, label, value string, points []int, options ...SparklineOption) *Builder

+ func (builder *Builder) AddStackedBar(header string, rows []StackedBarRow, options ...StackedBarOption) *Builder

+ func (builder *Builder) AddStatsRow(header string, stats []StatItem) *Builder

+ func (builder *Builder) AddSummaryCard(title, body, footer string, options ...SummaryCardOption) *Builder

+ func (builder *Builder) AddTable(columns []string, rows [][]string, options ...TableOption) *Builder

+ func (builder *Builder) AddText(text string, options ...TextOption) *Builder

+ func (builder *Builder) AddTiles(entries []TileEntry, options ...TilesOption) *Builder

+ func (builder *Builder) AddTimeline(header string, items []TimelineItem, options ...TimelineOption) *Builder

+ func (builder *Builder) AddVerificationCode(label, code string, options ...VerificationCodeOption) *Builder

+ func (builder *Builder) AddVerticalBarChart(axisLabels []string, series []VerticalBarChartSeries, ...) *Builder

+ func (builder *Builder) Build() *Email

+ func (builder *Builder) Clone() *Builder

+ func (builder *Builder) Footer(value FooterSection) *Builder

+ func (builder *Builder) Header(value HeaderSection) *Builder

+ func (builder *Builder) NoFooter() *Builder

+ func (builder *Builder) NoHeader() *Builder

+ func (builder *Builder) WithDirection(value theme.Direction) *Builder

+ func (builder *Builder) WithFooter(block Block, options ...FooterOption) *Builder

+ func (builder *Builder) WithHeader(block Block, options ...HeaderOption) *Builder

+ func (builder *Builder) WithPreheader(value string, options ...PreheaderOption) *Builder

+ func (builder *Builder) WithoutFooter() *Builder

+ func (builder *Builder) WithoutHeader() *Builder

+ type BuilderOption func(*Builder)

+ func WithDirection(value theme.Direction) BuilderOption

+ func WithFooter(block Block, options ...FooterOption) BuilderOption

+ func WithFooterMode(mode FooterMode) BuilderOption

+ func WithFooterOptions(block Block, options ...FooterOption) BuilderOption

+ func WithHeader(block Block, options ...HeaderOption) BuilderOption

+ func WithHeaderMode(mode HeaderMode) BuilderOption

+ func WithHeaderOptions(block Block, options ...HeaderOption) BuilderOption

+ func WithMSOCompatibility(value theme.MSOCompatibilityMode) BuilderOption

+ func WithOutlookCompatibility(enabled bool) BuilderOption

+ func WithStyles(value theme.Styles) BuilderOption

+ type ButtonAlignmentValue string

+ type ButtonBlock struct

+ Alignment ButtonAlignmentValue

+ FullWidth bool

+ Label string

+ NoWrap bool

+ Size ButtonSizeValue

+ Style ButtonStyleValue

+ Tone Tone

+ URL string

+ func (block ButtonBlock) Kind() theme.BlockKind

+ func (block ButtonBlock) LayoutSpec() LayoutSpec

+ func (block ButtonBlock) RenderText(_ RenderContext) (string, error)

+ func (block ButtonBlock) TemplateData() any

+ type ButtonGroupBlock struct

+ Alignment ButtonAlignmentValue

+ Buttons []ButtonGroupButton

+ FullWidthOnMobile bool

+ Gap int

+ Joined bool

+ StackOnMobile bool

+ func (block ButtonGroupBlock) Kind() theme.BlockKind

+ func (block ButtonGroupBlock) LayoutSpec() LayoutSpec

+ func (block ButtonGroupBlock) RenderText(_ RenderContext) (string, error)

+ func (block ButtonGroupBlock) TemplateData() any

+ type ButtonGroupButton struct

+ Label string

+ Style ButtonStyleValue

+ Tone Tone

+ URL string

+ type ButtonGroupOption func(*ButtonGroupBlock)

+ func ButtonGroupAlign(value ButtonAlignmentValue) ButtonGroupOption

+ func ButtonGroupFullWidthOnMobile(value bool) ButtonGroupOption

+ func ButtonGroupGap(value int) ButtonGroupOption

+ func ButtonGroupJoined(value bool) ButtonGroupOption

+ func ButtonGroupStackOnMobile(value bool) ButtonGroupOption

+ type ButtonOption func(*ButtonBlock)

+ func ButtonAlign(value ButtonAlignmentValue) ButtonOption

+ func ButtonFullWidth(value bool) ButtonOption

+ func ButtonNoWrap(value bool) ButtonOption

+ func ButtonSize(value ButtonSizeValue) ButtonOption

+ func ButtonStyle(value ButtonStyleValue) ButtonOption

+ func ButtonTone(value Tone) ButtonOption

+ type ButtonSizeValue string

+ type ButtonStyleValue string

+ type CalloutBlock struct

+ Body string

+ InsetMode InsetMode

+ LinkLabel string

+ LinkURL string

+ Title string

+ Tone Tone

+ Variant CalloutVariant

+ func (block CalloutBlock) Kind() theme.BlockKind

+ func (block CalloutBlock) LayoutSpec() LayoutSpec

+ func (block CalloutBlock) RenderText(_ RenderContext) (string, error)

+ func (block CalloutBlock) TemplateData() any

+ type CalloutOption func(*CalloutBlock)

+ func CalloutInsetMode(value InsetMode) CalloutOption

+ func CalloutLink(label, url string) CalloutOption

+ func CalloutStyle(variant CalloutVariant) CalloutOption

+ type CalloutVariant string

+ const CalloutVariantOutline

+ const CalloutVariantSoft

+ const CalloutVariantSolid

+ type CardItem struct

+ Body string

+ CTALabel string

+ Subtitle string

+ Title string

+ URL string

+ type CardListBlock struct

+ Border bool

+ Cards []CardItem

+ Columns int

+ Gap int

+ InsetMode InsetMode

+ func (block CardListBlock) Kind() theme.BlockKind

+ func (block CardListBlock) LayoutSpec() LayoutSpec

+ func (block CardListBlock) RenderText(_ RenderContext) (string, error)

+ func (block CardListBlock) TemplateData() any

+ type CardListOption func(*CardListBlock)

+ func CardListBorder(value bool) CardListOption

+ func CardListColumns(value int) CardListOption

+ func CardListGap(value int) CardListOption

+ func CardListInsetMode(value InsetMode) CardListOption

+ type ColumnsBlock struct

+ Gap int

+ InsetMode InsetMode

+ Left []Block

+ LeftWidth int

+ Right []Block

+ RightWidth int

+ VerticalAlign ColumnsVerticalAlign

+ func (block ColumnsBlock) Kind() theme.BlockKind

+ func (block ColumnsBlock) LayoutSpec() LayoutSpec

+ func (block ColumnsBlock) RenderText(context RenderContext) (string, error)

+ func (block ColumnsBlock) TemplateData() any

+ type ColumnsOption func(*ColumnsBlock)

+ func ColumnsAlign(value ColumnsVerticalAlign) ColumnsOption

+ func ColumnsGap(value int) ColumnsOption

+ func ColumnsInsetMode(value InsetMode) ColumnsOption

+ func ColumnsWidths(leftWidth, rightWidth int) ColumnsOption

+ type ColumnsVerticalAlign string

+ const ColumnsVerticalAlignBottom

+ const ColumnsVerticalAlignMiddle

+ const ColumnsVerticalAlignTop

+ type DistributionBlock struct

+ Buckets []DistributionBucket

+ CountColumnWidthCh int

+ Header string

+ InsetMode InsetMode

+ func (block DistributionBlock) Kind() theme.BlockKind

+ func (block DistributionBlock) LayoutSpec() LayoutSpec

+ func (block DistributionBlock) RenderText(_ RenderContext) (string, error)

+ func (block DistributionBlock) TemplateData() any

+ type DistributionBucket struct

+ Color string

+ Count int

+ Label string

+ WidthPercent int

+ type DistributionOption func(*DistributionBlock)

+ func DistributionInsetMode(value InsetMode) DistributionOption

+ type DividerBlock struct

+ Inset int

+ InsetMode InsetMode

+ Label string

+ Thickness int

+ Variant DividerVariant

+ func (block DividerBlock) Kind() theme.BlockKind

+ func (block DividerBlock) LayoutSpec() LayoutSpec

+ func (block DividerBlock) RenderText(_ RenderContext) (string, error)

+ func (block DividerBlock) TemplateData() any

+ type DividerOption func(*DividerBlock)

+ func DividerInset(value int) DividerOption

+ func DividerInsetMode(value InsetMode) DividerOption

+ func DividerLabel(value string) DividerOption

+ func DividerStyle(value DividerVariant) DividerOption

+ func DividerThickness(value int) DividerOption

+ type DividerVariant string

+ const DividerVariantDashed

+ const DividerVariantDotted

+ const DividerVariantSolid

+ type Email struct

+ func (email *Email) HTML() (string, error)

+ func (email *Email) Preheader() string

+ func (email *Email) Text() (string, error)

+ func (email *Email) Values() theme.Values

+ type EmptyStateBlock struct

+ ActionLabel string

+ ActionURL string

+ Body string

+ InsetMode InsetMode

+ Title string

+ Tone Tone

+ func (block EmptyStateBlock) Kind() theme.BlockKind

+ func (block EmptyStateBlock) LayoutSpec() LayoutSpec

+ func (block EmptyStateBlock) RenderText(_ RenderContext) (string, error)

+ func (block EmptyStateBlock) TemplateData() any

+ type EmptyStateOption func(*EmptyStateBlock)

+ func EmptyStateInsetMode(value InsetMode) EmptyStateOption

+ func EmptyStateTone(value Tone) EmptyStateOption

+ type FooterLink struct

+ Label string

+ URL string

+ type FooterLinksBlock struct

+ Links []FooterLink

+ Note string

+ func (block FooterLinksBlock) Kind() theme.BlockKind

+ func (block FooterLinksBlock) LayoutSpec() LayoutSpec

+ func (block FooterLinksBlock) RenderText(_ RenderContext) (string, error)

+ func (block FooterLinksBlock) TemplateData() any

+ type FooterMode int

+ const FooterModeAuto

+ const FooterModeDisabled

+ const FooterModeEnabled

+ type FooterOption func(*FooterSection)

+ func FooterPlacement(value FooterPlacementValue) FooterOption

+ func FooterRenderInText(value bool) FooterOption

+ type FooterPlacementValue string

+ const FooterPlacementInside

+ const FooterPlacementOutside

+ type FooterSection struct

+ Block Block

+ Placement FooterPlacementValue

+ RenderInText bool

+ type FreeMarkdownBlock struct

+ Markdown string

+ func (block FreeMarkdownBlock) Kind() theme.BlockKind

+ func (block FreeMarkdownBlock) LayoutSpec() LayoutSpec

+ func (block FreeMarkdownBlock) RenderText(_ RenderContext) (string, error)

+ func (block FreeMarkdownBlock) TemplateData() any

+ type GridBlock struct

+ Border bool

+ Columns int

+ Gap int

+ InsetMode InsetMode

+ Items []GridItem

+ func (block GridBlock) Kind() theme.BlockKind

+ func (block GridBlock) LayoutSpec() LayoutSpec

+ func (block GridBlock) RenderText(context RenderContext) (string, error)

+ func (block GridBlock) TemplateData() any

+ type GridItem struct

+ Content Block

+ func GridItemGroup(group *Group) GridItem

+ type GridOption func(*GridBlock)

+ func GridBorder(value bool) GridOption

+ func GridColumns(value int) GridOption

+ func GridGap(value int) GridOption

+ func GridInsetMode(value InsetMode) GridOption

+ type Group struct

+ func NewGroup() *Group

+ func (group *Group) Add(block Block) *Group

+ func (group *Group) AddAttachment(filename, meta, url, cta string, options ...AttachmentOption) *Group

+ func (group *Group) AddBadge(tone Tone, text string) *Group

+ func (group *Group) AddButton(label, url string, options ...ButtonOption) *Group

+ func (group *Group) AddCallout(tone Tone, title, body string, options ...CalloutOption) *Group

+ func (group *Group) AddDivider(options ...DividerOption) *Group

+ func (group *Group) AddFreeMarkdown(markdown string) *Group

+ func (group *Group) AddHeading(text string, options ...HeadingOption) *Group

+ func (group *Group) AddHorizontalBarChart(header string, items []HorizontalBarChartItem, ...) *Group

+ func (group *Group) AddImage(src, alt string, opts ...ImageOption) *Group

+ func (group *Group) AddKeyValue(header string, pairs []KeyValuePair) *Group

+ func (group *Group) AddLegal(companyName, address, manageURL, unsubscribeURL string) *Group

+ func (group *Group) AddList(items []string, ordered bool) *Group

+ func (group *Group) AddMessage(message MessageBlock, options ...MessageOption) *Group

+ func (group *Group) AddMessageDigest(messages []MessageBlock, options ...MessageDigestOption) *Group

+ func (group *Group) AddQuote(text, author string) *Group

+ func (group *Group) AddSpacer(options ...SpacerOption) *Group

+ func (group *Group) AddStatsRow(header string, stats []StatItem) *Group

+ func (group *Group) AddSummaryCard(title, body, footer string) *Group

+ func (group *Group) AddTable(columns []string, rows [][]string, options ...TableOption) *Group

+ func (group *Group) AddText(text string, options ...TextOption) *Group

+ func (group *Group) AddTimeline(header string, items []TimelineItem, options ...TimelineOption) *Group

+ func (group *Group) AddVerificationCode(label, code string, options ...VerificationCodeOption) *Group

+ func (group *Group) AddVerticalBarChart(axisLabels []string, series []VerticalBarChartSeries, ...) *Group

+ func (group *Group) Blocks() []Block

+ func (group *Group) Kind() theme.BlockKind

+ func (group *Group) LayoutSpec() LayoutSpec

+ func (group *Group) RenderText(context RenderContext) (string, error)

+ func (group *Group) TemplateData() any

+ type HeaderMode int

+ const HeaderModeAuto

+ const HeaderModeDisabled

+ const HeaderModeEnabled

+ type HeaderOption func(*HeaderSection)

+ func HeaderPlacement(value HeaderPlacementValue) HeaderOption

+ func HeaderRenderInText(value bool) HeaderOption

+ type HeaderPlacementValue string

+ const HeaderPlacementInside

+ const HeaderPlacementOutside

+ type HeaderSection struct

+ Block Block

+ Placement HeaderPlacementValue

+ RenderInText bool

+ type HeadingBlock struct

+ Level int

+ Text string

+ func (block HeadingBlock) Kind() theme.BlockKind

+ func (block HeadingBlock) LayoutSpec() LayoutSpec

+ func (block HeadingBlock) RenderText(_ RenderContext) (string, error)

+ func (block HeadingBlock) TemplateData() any

+ type HeadingOption func(*HeadingBlock)

+ func HeadingLevel(value int) HeadingOption

+ type HeroBlock struct

+ Body string

+ CTALabel string

+ CTAURL string

+ Eyebrow string

+ ImageAlt string

+ ImageURL string

+ InsetMode InsetMode

+ Title string

+ Tone Tone

+ func (block HeroBlock) Kind() theme.BlockKind

+ func (block HeroBlock) LayoutSpec() LayoutSpec

+ func (block HeroBlock) RenderText(_ RenderContext) (string, error)

+ func (block HeroBlock) TemplateData() any

+ type HeroOption func(*HeroBlock)

+ func HeroEyebrow(value string) HeroOption

+ func HeroImage(url, alt string) HeroOption

+ func HeroInsetMode(value InsetMode) HeroOption

+ func HeroTone(value Tone) HeroOption

+ type HorizontalBarChartBlock struct

+ Header string

+ InsetMode InsetMode

+ Items []HorizontalBarChartItem

+ ShowLabelsInsideBars bool

+ Thickness int

+ Tone Tone

+ TransparentBackground bool

+ func (block HorizontalBarChartBlock) Kind() theme.BlockKind

+ func (block HorizontalBarChartBlock) LayoutSpec() LayoutSpec

+ func (block HorizontalBarChartBlock) RenderText(_ RenderContext) (string, error)

+ func (block HorizontalBarChartBlock) TemplateData() any

+ type HorizontalBarChartItem struct

+ Color string

+ Label string

+ Percent int

+ Value string

+ type HorizontalBarChartOption func(*HorizontalBarChartBlock)

+ func HorizontalBarChartInsetMode(value InsetMode) HorizontalBarChartOption

+ func HorizontalBarChartLabelsInsideBars(value bool) HorizontalBarChartOption

+ func HorizontalBarChartThickness(value int) HorizontalBarChartOption

+ func HorizontalBarChartTone(value Tone) HorizontalBarChartOption

+ func HorizontalBarChartTransparentBackground(value bool) HorizontalBarChartOption

+ type ImageAlignment string

+ const ImageAlignmentCenter

+ const ImageAlignmentDefault

+ const ImageAlignmentEnd

+ const ImageAlignmentFull

+ const ImageAlignmentStart

+ type ImageBlock struct

+ Align ImageAlignment

+ Alt string

+ BottomSpacing int

+ CornerMode ImageCornerMode

+ HasBottomSpacing bool

+ HasTopSpacing bool

+ Href string

+ InsetMode InsetMode

+ Src string

+ TopSpacing int

+ Width int

+ func (block ImageBlock) Kind() theme.BlockKind

+ func (block ImageBlock) LayoutSpec() LayoutSpec

+ func (block ImageBlock) RenderText(_ RenderContext) (string, error)

+ func (block ImageBlock) TemplateData() any

+ type ImageCornerMode string

+ const ImageCornerModeAll

+ const ImageCornerModeAuto

+ const ImageCornerModeBottom

+ const ImageCornerModeNone

+ const ImageCornerModeTop

+ type ImageOption func(*ImageBlock)

+ func ImageAlign(align ImageAlignment) ImageOption

+ func ImageAllCorners() ImageOption

+ func ImageBottomCorners() ImageOption

+ func ImageBottomSpacing(px int) ImageOption

+ func ImageCorners(value ImageCornerMode) ImageOption

+ func ImageFullWidth() ImageOption

+ func ImageHref(href string) ImageOption

+ func ImageInsetMode(value InsetMode) ImageOption

+ func ImageNoCorners() ImageOption

+ func ImageTopCorners() ImageOption

+ func ImageTopSpacing(px int) ImageOption

+ func ImageWidth(px int) ImageOption

+ type InsetMode string

+ const InsetModeCustom

+ const InsetModeDefault

+ const InsetModeNone

+ type KeyValueBlock struct

+ Header string

+ Pairs []KeyValuePair

+ func (block KeyValueBlock) Kind() theme.BlockKind

+ func (block KeyValueBlock) LayoutSpec() LayoutSpec

+ func (block KeyValueBlock) RenderText(_ RenderContext) (string, error)

+ func (block KeyValueBlock) TemplateData() any

+ type KeyValuePair struct

+ Key string

+ Value string

+ type LayoutSpec struct

+ CustomInset string

+ InsetMode InsetMode

+ type LegalBlock struct

+ Address string

+ CompanyName string

+ ManageURL string

+ UnsubscribeURL string

+ func (block LegalBlock) Kind() theme.BlockKind

+ func (block LegalBlock) LayoutSpec() LayoutSpec

+ func (block LegalBlock) RenderText(_ RenderContext) (string, error)

+ func (block LegalBlock) TemplateData() any

+ type ListBlock struct

+ Items []string

+ Ordered bool

+ func (block ListBlock) Kind() theme.BlockKind

+ func (block ListBlock) LayoutSpec() LayoutSpec

+ func (block ListBlock) RenderText(_ RenderContext) (string, error)

+ func (block ListBlock) TemplateData() any

+ type MessageBlock struct

+ ActionLabel string

+ ActionURL string

+ AvatarURL string

+ InsetMode InsetMode

+ LogoAlt string

+ LogoHref string

+ Platform string

+ Preview string

+ PreviewMarkdown string

+ SenderHandle string

+ SenderName string

+ SentAt string

+ Subject string

+ URL string

+ func (block MessageBlock) Kind() theme.BlockKind

+ func (block MessageBlock) LayoutSpec() LayoutSpec

+ func (block MessageBlock) RenderText(_ RenderContext) (string, error)

+ func (block MessageBlock) TemplateData() any

+ type MessageDigestBlock struct

+ EmptyText string

+ Footer string

+ InsetMode InsetMode

+ MaxItems int

+ Messages []MessageBlock

+ Subtitle string

+ Title string

+ func (block MessageDigestBlock) Kind() theme.BlockKind

+ func (block MessageDigestBlock) LayoutSpec() LayoutSpec

+ func (block MessageDigestBlock) RenderText(_ RenderContext) (string, error)

+ func (block MessageDigestBlock) TemplateData() any

+ type MessageDigestOption func(*MessageDigestBlock)

+ func MessageDigestEmptyText(value string) MessageDigestOption

+ func MessageDigestFooter(value string) MessageDigestOption

+ func MessageDigestInsetMode(value InsetMode) MessageDigestOption

+ func MessageDigestMaxItems(value int) MessageDigestOption

+ func MessageDigestSubtitle(value string) MessageDigestOption

+ func MessageDigestTitle(value string) MessageDigestOption

+ type MessageOption func(*MessageBlock)

+ func MessageInsetMode(value InsetMode) MessageOption

+ type PanelBlock struct

+ Blocks []Block

+ Border bool

+ Category string

+ Headerless bool

+ InsetMode InsetMode

+ Padding int

+ ShowHeader bool

+ Subtitle string

+ Title string

+ func (block PanelBlock) Kind() theme.BlockKind

+ func (block PanelBlock) LayoutSpec() LayoutSpec

+ func (block PanelBlock) RenderText(context RenderContext) (string, error)

+ func (block PanelBlock) TemplateData() any

+ type PanelOption func(*PanelBlock)

+ func PanelBorder(value bool) PanelOption

+ func PanelCategory(value string) PanelOption

+ func PanelHeaderless(value bool) PanelOption

+ func PanelInsetMode(value InsetMode) PanelOption

+ func PanelPadding(value int) PanelOption

+ func PanelSubtitle(value string) PanelOption

+ func PanelTitle(value string) PanelOption

+ type PreheaderOption func(*preheaderConfig)

+ func PreheaderPaddingRepeat(value int) PreheaderOption

+ type PriceLine struct

+ Label string

+ Value string

+ type PriceSummaryBlock struct

+ Header string

+ InsetMode InsetMode

+ Items []PriceLine

+ TotalLabel string

+ TotalValue string

+ func (block PriceSummaryBlock) Kind() theme.BlockKind

+ func (block PriceSummaryBlock) LayoutSpec() LayoutSpec

+ func (block PriceSummaryBlock) RenderText(_ RenderContext) (string, error)

+ func (block PriceSummaryBlock) TemplateData() any

+ type PriceSummaryOption func(*PriceSummaryBlock)

+ func PriceSummaryInsetMode(value InsetMode) PriceSummaryOption

+ type ProgressBlock struct

+ Header string

+ InsetMode InsetMode

+ Items []ProgressItem

+ func (block ProgressBlock) Kind() theme.BlockKind

+ func (block ProgressBlock) LayoutSpec() LayoutSpec

+ func (block ProgressBlock) RenderText(_ RenderContext) (string, error)

+ func (block ProgressBlock) TemplateData() any

+ type ProgressItem struct

+ Color string

+ Label string

+ Percent int

+ Value string

+ type ProgressOption func(*ProgressBlock)

+ func ProgressInsetMode(value InsetMode) ProgressOption

+ type QuoteBlock struct

+ Author string

+ Text string

+ func (block QuoteBlock) Kind() theme.BlockKind

+ func (block QuoteBlock) LayoutSpec() LayoutSpec

+ func (block QuoteBlock) RenderText(_ RenderContext) (string, error)

+ func (block QuoteBlock) TemplateData() any

+ type RenderContext struct

+ Preheader string

+ Values theme.Values

+ type SpacerBlock struct

+ Size int

+ func (block SpacerBlock) Kind() theme.BlockKind

+ func (block SpacerBlock) LayoutSpec() LayoutSpec

+ func (block SpacerBlock) RenderText(_ RenderContext) (string, error)

+ func (block SpacerBlock) TemplateData() any

+ type SpacerOption func(*SpacerBlock)

+ func SpacerSize(value int) SpacerOption

+ type SparklineBlock struct

+ Delta string

+ DeltaSemantic StatDeltaSemantic

+ Header string

+ InsetMode InsetMode

+ Label string

+ Points []int

+ Tone Tone

+ Value string

+ func (block SparklineBlock) Kind() theme.BlockKind

+ func (block SparklineBlock) LayoutSpec() LayoutSpec

+ func (block SparklineBlock) RenderText(_ RenderContext) (string, error)

+ func (block SparklineBlock) TemplateData() any

+ type SparklineOption func(*SparklineBlock)

+ func SparklineDelta(value string) SparklineOption

+ func SparklineDeltaSemantic(value StatDeltaSemantic) SparklineOption

+ func SparklineInsetMode(value InsetMode) SparklineOption

+ func SparklineTone(value Tone) SparklineOption

+ type StackedBarBlock struct

+ Header string

+ InsetMode InsetMode

+ Rows []StackedBarRow

+ TotalLabel string

+ TotalValue string

+ func (block StackedBarBlock) Kind() theme.BlockKind

+ func (block StackedBarBlock) LayoutSpec() LayoutSpec

+ func (block StackedBarBlock) RenderText(_ RenderContext) (string, error)

+ func (block StackedBarBlock) TemplateData() any

+ type StackedBarOption func(*StackedBarBlock)

+ func StackedBarInsetMode(value InsetMode) StackedBarOption

+ func StackedBarTotal(label, value string) StackedBarOption

+ type StackedBarRow struct

+ Label string

+ Segments []StackedBarSegment

+ type StackedBarSegment struct

+ Color string

+ Label string

+ Percent int

+ Value string

+ type StatDeltaSemantic string

+ const StatDeltaSemanticNegative

+ const StatDeltaSemanticNone

+ const StatDeltaSemanticPositive

+ type StatItem struct

+ Delta string

+ DeltaSemantic StatDeltaSemantic

+ Label string

+ Value string

+ type StatsRowBlock struct

+ Header string

+ Stats []StatItem

+ func (block StatsRowBlock) Kind() theme.BlockKind

+ func (block StatsRowBlock) LayoutSpec() LayoutSpec

+ func (block StatsRowBlock) RenderText(_ RenderContext) (string, error)

+ func (block StatsRowBlock) TemplateData() any

+ type SummaryCardBlock struct

+ Body string

+ Footer string

+ InsetMode InsetMode

+ Title string

+ Tone Tone

+ func (block SummaryCardBlock) Kind() theme.BlockKind

+ func (block SummaryCardBlock) LayoutSpec() LayoutSpec

+ func (block SummaryCardBlock) RenderText(_ RenderContext) (string, error)

+ func (block SummaryCardBlock) TemplateData() any

+ type SummaryCardOption func(*SummaryCardBlock)

+ func SummaryCardInsetMode(value InsetMode) SummaryCardOption

+ func SummaryCardTone(value Tone) SummaryCardOption

+ type TableBlock struct

+ BorderStyle TableBorderStyleValue

+ ColumnAlignments map[int]TableColumnAlignmentValue

+ Columns []string

+ Compact bool

+ Density TableDensityValue

+ EmphasizeTotalRow bool

+ HasLegendSwatches bool

+ Header string

+ HeaderTone TableHeaderToneValue

+ InsetMode InsetMode

+ LegendSwatches []string

+ RightAlignNumericColumns bool

+ Rows [][]string

+ ZebraRows bool

+ func (block TableBlock) Kind() theme.BlockKind

+ func (block TableBlock) LayoutSpec() LayoutSpec

+ func (block TableBlock) RenderText(_ RenderContext) (string, error)

+ func (block TableBlock) TemplateData() any

+ type TableBorderStyleValue string

+ type TableColumnAlignmentValue string

+ type TableDensityValue string

+ type TableHeaderToneValue string

+ type TableOption func(*TableBlock)

+ func TableBorderStyle(value TableBorderStyleValue) TableOption

+ func TableColumnAlignments(value map[int]TableColumnAlignmentValue) TableOption

+ func TableCompact(value bool) TableOption

+ func TableDensity(value TableDensityValue) TableOption

+ func TableEmphasizeTotalRow(value bool) TableOption

+ func TableHeaderTone(value TableHeaderToneValue) TableOption

+ func TableInsetMode(value InsetMode) TableOption

+ func TableLegendSwatches(value []string) TableOption

+ func TableRightAlignNumericColumns(value bool) TableOption

+ func TableTitle(value string) TableOption

+ func TableZebraRows(value bool) TableOption

+ type TextAlignmentValue string

+ const TextAlignCenter

+ const TextAlignEnd

+ const TextAlignStart

+ type TextBlock struct

+ Align TextAlignmentValue

+ NoMargin bool

+ Size TextSizeValue

+ Spacing TextSpacingValue

+ Text string

+ Tone Tone

+ Transform TextTransformValue

+ Weight TextWeightValue

+ func (block TextBlock) Kind() theme.BlockKind

+ func (block TextBlock) LayoutSpec() LayoutSpec

+ func (block TextBlock) RenderText(_ RenderContext) (string, error)

+ func (block TextBlock) TemplateData() any

+ type TextOption func(*TextBlock)

+ func TextAlign(value TextAlignmentValue) TextOption

+ func TextNoMargin(value bool) TextOption

+ func TextSize(value TextSizeValue) TextOption

+ func TextSpacing(value TextSpacingValue) TextOption

+ func TextTone(value Tone) TextOption

+ func TextTransform(value TextTransformValue) TextOption

+ func TextWeight(value TextWeightValue) TextOption

+ type TextSizeValue string

+ const TextSizeBase

+ const TextSizeLarge

+ const TextSizeSmall

+ type TextSpacingValue string

+ const TextSpacingCompact

+ const TextSpacingNormal

+ const TextSpacingRelaxed

+ type TextTransformValue string

+ const TextTransformCapitalize

+ const TextTransformLowercase

+ const TextTransformNone

+ const TextTransformUppercase

+ type TextWeightValue string

+ const TextWeightBold

+ const TextWeightMedium

+ const TextWeightNormal

+ const TextWeightSemibold

+ type TileAlignment string

+ const TileAlignmentCenter

+ const TileAlignmentEnd

+ const TileAlignmentStart

+ type TileEntry struct

+ Content string

+ Subtitle string

+ Title string

+ URL string

+ Variant TileVariant

+ type TileVariant string

+ const TileVariantCritical

+ const TileVariantDefault

+ const TileVariantHighlight

+ const TileVariantSuccess

+ const TileVariantWarning

+ type TilesBlock struct

+ Alignment TileAlignment

+ Border bool

+ Columns int

+ Entries []TileEntry

+ InsetMode InsetMode

+ TransparentBackground bool

+ func (block TilesBlock) Kind() theme.BlockKind

+ func (block TilesBlock) LayoutSpec() LayoutSpec

+ func (block TilesBlock) RenderText(_ RenderContext) (string, error)

+ func (block TilesBlock) TemplateData() any

+ type TilesOption func(*TilesBlock)

+ func TilesAlign(value TileAlignment) TilesOption

+ func TilesBorder(value bool) TilesOption

+ func TilesColumns(value int) TilesOption

+ func TilesInsetMode(value InsetMode) TilesOption

+ func TilesTransparentBackground(value bool) TilesOption

+ type TimelineBlock struct

+ AggregateHeader string

+ CurrentIndex int

+ HasCurrentIndex bool

+ Header string

+ InsetMode InsetMode

+ Items []TimelineItem

+ func (block TimelineBlock) Kind() theme.BlockKind

+ func (block TimelineBlock) LayoutSpec() LayoutSpec

+ func (block TimelineBlock) RenderText(_ RenderContext) (string, error)

+ func (block TimelineBlock) TemplateData() any

+ type TimelineItem struct

+ Detail string

+ Time string

+ Title string

+ type TimelineOption func(*TimelineBlock)

+ func TimelineAggregateHeader(value string) TimelineOption

+ func TimelineCurrentIndex(value int) TimelineOption

+ func TimelineInsetMode(value InsetMode) TimelineOption

+ type Tone string

+ const ToneDanger

+ const ToneDark

+ const ToneDefault

+ const ToneInfo

+ const ToneMuted

+ const TonePrimary

+ const ToneSecondary

+ const ToneSuccess

+ const ToneWarning

+ type VerificationCodeBlock struct

+ CharacterSpacingEm float64

+ InsetMode InsetMode

+ Label string

+ Tone Tone

+ UseMonospace bool

+ Value string

+ func (block VerificationCodeBlock) Kind() theme.BlockKind

+ func (block VerificationCodeBlock) LayoutSpec() LayoutSpec

+ func (block VerificationCodeBlock) RenderText(_ RenderContext) (string, error)

+ func (block VerificationCodeBlock) TemplateData() any

+ type VerificationCodeOption func(*VerificationCodeBlock)

+ func VerificationCodeInsetMode(value InsetMode) VerificationCodeOption

+ func VerificationCodeMonospace(value bool) VerificationCodeOption

+ func VerificationCodeSpacing(value float64) VerificationCodeOption

+ func VerificationCodeTone(value Tone) VerificationCodeOption

+ type VerticalBarChartAxis struct

+ DrawYAxisLine bool

+ HasDrawYAxisLine bool

+ HasMax bool

+ HasMin bool

+ HasShowCategoryLabels bool

+ LabelFormat VerticalBarChartAxisLabelFormatValue

+ Max float64

+ Min float64

+ ShowBaseline bool

+ ShowCategoryLabels bool

+ ShowYTicks bool

+ type VerticalBarChartAxisLabelFormatValue string

+ const VerticalBarChartAxisLabelFormatNumber

+ const VerticalBarChartAxisLabelFormatPercent

+ type VerticalBarChartBlock struct

+ Axis VerticalBarChartAxis

+ AxisLabels []string

+ ColumnGap int

+ HasColumnGap bool

+ HasOuterGap bool

+ Height int

+ InsetMode InsetMode

+ Legend []VerticalBarChartLegendItem

+ LegendPlacement VerticalBarChartLegendPlacementValue

+ Normalize bool

+ OuterGap int

+ Series []VerticalBarChartSeries

+ Subtitle string

+ Title string

+ Tone Tone

+ TransparentBackground bool

+ ValueFormatter VerticalBarChartValueFormatter

+ ValueLabels VerticalBarChartValueLabels

+ func (block VerticalBarChartBlock) Kind() theme.BlockKind

+ func (block VerticalBarChartBlock) LayoutSpec() LayoutSpec

+ func (block VerticalBarChartBlock) RenderText(_ RenderContext) (string, error)

+ func (block VerticalBarChartBlock) TemplateData() any

+ type VerticalBarChartColumnView struct

+ Label string

+ NegativeSegments []VerticalBarChartSegmentView

+ PositiveAboveLabel string

+ PositiveAboveLabelColor string

+ PositiveSegments []VerticalBarChartSegmentView

+ PositiveTopPadding int

+ type VerticalBarChartLegendConfig struct

+ Items []VerticalBarChartLegendItem

+ Placement VerticalBarChartLegendPlacementValue

+ type VerticalBarChartLegendItem struct

+ Color string

+ Label string

+ type VerticalBarChartLegendPlacementValue string

+ const VerticalBarChartLegendBottom

+ const VerticalBarChartLegendNone

+ type VerticalBarChartMagnitudeSuffixValue string

+ const VerticalBarChartMagnitudeSuffixNone

+ const VerticalBarChartMagnitudeSuffixShort

+ type VerticalBarChartNegativeFormatValue string

+ const VerticalBarChartNegativeFormatMinus

+ const VerticalBarChartNegativeFormatParentheses

+ type VerticalBarChartOption func(*VerticalBarChartBlock)

+ func VerticalBarChartAxisConfig(value VerticalBarChartAxis) VerticalBarChartOption

+ func VerticalBarChartAxisDrawYAxisLine(value bool) VerticalBarChartOption

+ func VerticalBarChartAxisLabelFormat(value VerticalBarChartAxisLabelFormatValue) VerticalBarChartOption

+ func VerticalBarChartAxisMax(value float64) VerticalBarChartOption

+ func VerticalBarChartAxisMin(value float64) VerticalBarChartOption

+ func VerticalBarChartAxisShowBaseline(value bool) VerticalBarChartOption

+ func VerticalBarChartAxisShowCategoryLabels(value bool) VerticalBarChartOption

+ func VerticalBarChartAxisShowYTicks(value bool) VerticalBarChartOption

+ func VerticalBarChartCategoryGap(value int) VerticalBarChartOption

+ func VerticalBarChartColumnGap(value int) VerticalBarChartOption

+ func VerticalBarChartHeight(value int) VerticalBarChartOption

+ func VerticalBarChartInsetMode(value InsetMode) VerticalBarChartOption

+ func VerticalBarChartLegend(items []VerticalBarChartLegendItem) VerticalBarChartOption

+ func VerticalBarChartLegendConfigOption(value VerticalBarChartLegendConfig) VerticalBarChartOption

+ func VerticalBarChartLegendPlacement(value VerticalBarChartLegendPlacementValue) VerticalBarChartOption

+ func VerticalBarChartNormalize(value bool) VerticalBarChartOption

+ func VerticalBarChartOuterGap(value int) VerticalBarChartOption

+ func VerticalBarChartSubtitle(value string) VerticalBarChartOption

+ func VerticalBarChartTitle(value string) VerticalBarChartOption

+ func VerticalBarChartTone(value Tone) VerticalBarChartOption

+ func VerticalBarChartTransparentBackground(value bool) VerticalBarChartOption

+ func VerticalBarChartValueFormatterOption(value VerticalBarChartValueFormatter) VerticalBarChartOption

+ func VerticalBarChartValueLabelsOption(value VerticalBarChartValueLabels) VerticalBarChartOption

+ type VerticalBarChartSegmentView struct

+ Color string

+ Display string

+ Height int

+ Label string

+ Series string

+ SignedDisplay string

+ Value float64

+ ValueLabelColor string

+ type VerticalBarChartSeries struct

+ Color string

+ Key string

+ Label string

+ ValueLabelColor string

+ Values []float64

+ type VerticalBarChartTemplateData struct

+ ColumnGap int

+ Columns []VerticalBarChartColumnView

+ DrawYAxisLine bool

+ Height int

+ InsetMode InsetMode

+ Legend []VerticalBarChartLegendItem

+ LegendPlacement VerticalBarChartLegendPlacementValue

+ LegendStartOffset int

+ NegativeHeight int

+ OuterGap int

+ PositiveHeight int

+ ShowBaseline bool

+ ShowCategoryLabels bool

+ ShowValueLabels bool

+ ShowYTicks bool

+ Subtitle string

+ Ticks []VerticalBarChartTickView

+ Title string

+ Tone Tone

+ TransparentBackground bool

+ ValueLabelColor string

+ ValueLabelMinHeight int

+ YAxisMaxLabel string

+ YAxisWidth int

+ YAxisZeroLabel string

+ type VerticalBarChartTickView struct

+ Label string

+ type VerticalBarChartValueFormatter struct

+ MagnitudeSuffix VerticalBarChartMagnitudeSuffixValue

+ NegativeFormat VerticalBarChartNegativeFormatValue

+ Prefix string

+ Suffix string

+ type VerticalBarChartValueLabels struct

+ Color string

+ MinSegmentHeight int

+ Show bool

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL