Skip to content

Commit f890c89

Browse files
authored
improvement(emails): size the header wordmark to the landing navbar's rule (#6648)
* improvement(emails): size the header wordmark to the landing navbar's rule The email header rendered the wordmark at 34px of ink against 16px body copy, and inked it #1a1a1a while every other line of the email uses #434343. Size it by the rule the landing navbar states: the mark stands 2px above and below its neighbouring text (18px against 14px chip labels), so 20px against the email's 16px body copy. Rasterize it from the same brand outlines the navbar renders, filled with the email's own textBody token, so the two surfaces cannot drift. * chore(emails): drop the wordmark generator script The raster is committed at 4x, so the display box can be retuned without re-exporting it — the script only ever ran by hand, and the test pinning the asset to an exact multiple of the box would have forced a pointless regeneration on any size tweak. Keep the shared outlines the navbar and 8 other surfaces already render, record how the asset was produced on the size constant, and assert the property that actually matters: the asset out-resolves its display box. * chore(branding): re-export the branding barrel through the absolute alias Matches the repo's absolute-import rule and the majority of lib barrels (billing, table, uploads and five others), instead of leaving this file split between relative and absolute re-exports. * docs(branding): correct the wordmark comments that named the removed script Two TSDoc blocks still pointed at scripts/generate-email-wordmark.ts as how the email raster is produced. Point them at the committed export and the size constant that records its fill and scale instead.
1 parent aeb77dd commit f890c89

6 files changed

Lines changed: 116 additions & 15 deletions

File tree

apps/sim/app/(landing)/components/navbar/components/sim-wordmark/sim-wordmark.tsx

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1+
import { WORDMARK_PATHS, WORDMARK_VIEW_BOX } from '@/lib/branding/wordmark'
2+
13
/**
24
* Inline "sim" brand logotype (wordmark, no separate icon mark) - the paths
35
* from the v1.0 brand guide's `simLogotype--dark.svg`, inlined so the logo
4-
* ships as zero-request server-rendered HTML.
6+
* ships as zero-request server-rendered HTML. They live in
7+
* `@/lib/branding/wordmark` because the email header rasterizes the same
8+
* outlines.
59
*
610
* Filled with a single solid `var(--text-body)` - the navbar's own text color
711
* (the same token its nav-link chips use) - so the wordmark reads as one solid
@@ -14,18 +18,17 @@
1418
export function SimWordmark() {
1519
return (
1620
<svg
17-
viewBox='0 0 441 212'
21+
viewBox={`0 0 ${WORDMARK_VIEW_BOX.width} ${WORDMARK_VIEW_BOX.height}`}
1822
width={37}
1923
height={18}
2024
fill='none'
2125
aria-hidden='true'
2226
className='-translate-y-[1.5px] h-[18px] w-auto'
2327
>
2428
<g fill='var(--text-body)'>
25-
<path d='M0 160.9H29.51C29.51 169.08 32.46 175.61 38.37 180.48C44.27 185.12 52.25 187.44 62.31 187.44C73.24 187.44 81.65 185.34 87.56 181.14C93.46 176.71 96.41 170.85 96.41 163.55C96.41 158.24 94.77 153.82 91.49 150.28C88.43 146.74 82.75 143.86 74.44 141.65L46.24 135.01C32.03 131.47 21.42 126.05 14.43 118.75C7.65 111.45 4.26 101.83 4.26 89.88C4.26 79.93 6.78 71.3 11.81 64C17.05 56.7 24.16 51.06 33.12 47.08C42.3 43.09 52.8 41.1 64.6 41.1C76.41 41.1 86.57 43.2 95.1 47.41C103.84 51.61 110.62 57.47 115.43 64.99C120.46 72.52 123.08 81.48 123.3 91.87H93.79C93.57 83.47 90.84 76.94 85.59 72.3C80.34 67.65 73.02 65.33 63.62 65.33C54 65.33 46.57 67.43 41.32 71.63C36.07 75.83 33.45 81.59 33.45 88.89C33.45 99.73 41.32 107.14 57.06 111.12L85.26 118.09C98.81 121.19 108.98 126.28 115.76 133.35C122.53 140.21 125.92 149.61 125.92 161.56C125.92 171.74 123.19 180.7 117.73 188.44C112.26 195.96 104.72 201.82 95.1 206.03C85.7 210.01 74.55 212 61.65 212C42.85 212 27.87 207.35 16.72 198.06C5.57 188.77 0 176.38 0 160.9Z' />
26-
<path d='M232.8 212H202.13L202.13 49.76H229.54V77.39C232.8 68.34 239.11 60.66 247.81 54.7C256.73 48.52 267.5 45.43 280.12 45.43C294.26 45.43 306.01 49.29 315.36 57.02C324.72 64.75 330.81 75.01 333.64 87.82H328.09C330.27 75.01 336.25 64.75 346.04 57.02C355.83 49.29 367.9 45.43 382.26 45.43C400.54 45.43 414.89 50.84 425.34 61.66C435.78 72.47 441 87.26 441 106.03V212H410.98V113.65C410.98 100.84 407.71 91.02 401.19 84.17C394.88 77.11 386.29 73.58 375.41 73.58C367.79 73.58 361.05 75.34 355.17 78.88C349.52 82.19 345.06 87.04 341.8 93.45C338.53 99.85 336.9 107.36 336.9 115.97V212H306.55V113.32C306.55 100.51 303.4 90.8 297.09 84.17C290.78 77.33 282.19 73.91 271.31 73.91C263.69 73.91 256.95 75.67 251.08 79.21C245.42 82.52 240.96 87.38 237.7 93.78C234.43 99.96 232.8 107.36 232.8 115.97V212Z' />
27-
<path d='M184.83 20.55C184.83 31.9 175.64 41.1 164.29 41.1C152.95 41.1 143.76 31.9 143.76 20.55C143.76 9.2 152.95 0 164.29 0C175.64 0 184.83 9.2 184.83 20.55Z' />
28-
<path d='M179.43 212H149.16V49.76C153.76 51.91 158.88 53.12 164.29 53.12C169.7 53.12 174.83 51.91 179.43 49.76V212Z' />
29+
{WORDMARK_PATHS.map((d) => (
30+
<path key={d} d={d} />
31+
))}
2932
</g>
3033
</svg>
3134
)

apps/sim/components/emails/components/email-layout.tsx

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,25 @@
11
import { Body, Container, Font, Head, Html, Img, Preview, Section } from '@react-email/components'
22
import { baseStyles } from '@/components/emails/_styles'
33
import { EmailFooter } from '@/components/emails/components/email-footer'
4+
import { EMAIL_WORDMARK_SIZE } from '@/lib/branding/wordmark'
45
import { getBaseUrl } from '@/lib/core/utils/urls'
56
import { getBrandConfig } from '@/ee/whitelabeling'
67

78
/**
8-
* Wordmark display size — exactly 1/4 of `wordmark.png`'s intrinsic 272×164.
9-
* The asset is a 4x source and must stay that way, since email clients do no
10-
* responsive image selection; changing one dimension alone distorts the mark.
9+
* Sim's own wordmark: a committed raster export of the brand outlines in
10+
* `@/lib/branding/wordmark`, since email clients strip inline SVG. Both
11+
* dimensions are pinned because they do no responsive image selection either.
1112
*/
12-
const WORDMARK_SIZE = { height: '41', width: '68' } as const
13+
const WORDMARK_SIZE = {
14+
width: String(EMAIL_WORDMARK_SIZE.width),
15+
height: String(EMAIL_WORDMARK_SIZE.height),
16+
} as const
1317

14-
/** Whitelabeled logos are arbitrary aspect ratios, so only height is pinned. */
15-
const CUSTOM_LOGO_SIZE = { height: '34' } as const
18+
/**
19+
* Whitelabeled logos are arbitrary aspect ratios, so only height is pinned —
20+
* matched to the wordmark so both marks read at the same weight.
21+
*/
22+
const CUSTOM_LOGO_SIZE = { height: String(EMAIL_WORDMARK_SIZE.height) } as const
1623

1724
interface EmailLayoutProps {
1825
/** Preview text shown in email client list view */

apps/sim/lib/branding/index.ts

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1-
export { defaultBrandConfig } from './defaults'
2-
export type { BrandConfig, ThemeColors } from './types'
3-
export { HEX_COLOR_REGEX } from './types'
1+
export { defaultBrandConfig } from '@/lib/branding/defaults'
2+
export type { BrandConfig, ThemeColors } from '@/lib/branding/types'
3+
export { HEX_COLOR_REGEX } from '@/lib/branding/types'
4+
export {
5+
EMAIL_WORDMARK_SIZE,
6+
WORDMARK_PATHS,
7+
WORDMARK_VIEW_BOX,
8+
} from '@/lib/branding/wordmark'
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
/**
2+
* @vitest-environment node
3+
*/
4+
import { readFileSync } from 'node:fs'
5+
import path from 'node:path'
6+
import { describe, expect, it } from 'vitest'
7+
import { EMAIL_WORDMARK_SIZE, WORDMARK_PATHS, WORDMARK_VIEW_BOX } from '@/lib/branding/wordmark'
8+
9+
/** Email clients do no responsive image selection, so the asset carries retina detail itself. */
10+
const MIN_RETINA_SCALE = 2
11+
12+
const WORDMARK_PNG = path.join(
13+
import.meta.dirname,
14+
'..',
15+
'..',
16+
'public',
17+
'brand',
18+
'color',
19+
'email',
20+
'wordmark.png'
21+
)
22+
23+
/** Reads width/height out of a PNG's IHDR, which always follows the 8-byte signature. */
24+
function readPngSize(file: string): { width: number; height: number } {
25+
const buffer = readFileSync(file)
26+
return { width: buffer.readUInt32BE(16), height: buffer.readUInt32BE(20) }
27+
}
28+
29+
describe('email wordmark asset', () => {
30+
it('out-resolves the box the email header renders it in', () => {
31+
const { width, height } = readPngSize(WORDMARK_PNG)
32+
expect(width).toBeGreaterThanOrEqual(EMAIL_WORDMARK_SIZE.width * MIN_RETINA_SCALE)
33+
expect(height).toBeGreaterThanOrEqual(EMAIL_WORDMARK_SIZE.height * MIN_RETINA_SCALE)
34+
})
35+
36+
it('is committed at the aspect ratio the header displays it at', () => {
37+
const { width, height } = readPngSize(WORDMARK_PNG)
38+
const assetAspect = width / height
39+
const boxAspect = EMAIL_WORDMARK_SIZE.width / EMAIL_WORDMARK_SIZE.height
40+
expect(Math.abs(assetAspect - boxAspect) / boxAspect).toBeLessThan(0.01)
41+
})
42+
43+
it('renders the mark at the brand outlines aspect ratio, within a rounding pixel', () => {
44+
const boxAspect = EMAIL_WORDMARK_SIZE.width / EMAIL_WORDMARK_SIZE.height
45+
const viewBoxAspect = WORDMARK_VIEW_BOX.width / WORDMARK_VIEW_BOX.height
46+
expect(Math.abs(boxAspect - viewBoxAspect) / viewBoxAspect).toBeLessThan(0.01)
47+
})
48+
49+
it('carries every glyph of the logotype', () => {
50+
expect(WORDMARK_PATHS).toHaveLength(4)
51+
for (const d of WORDMARK_PATHS) expect(d.startsWith('M')).toBe(true)
52+
})
53+
})

apps/sim/lib/branding/wordmark.ts

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/**
2+
* The "sim" logotype paths from the v1.0 brand guide (`simLogotype--dark.svg`).
3+
*
4+
* Shared so the surfaces that draw the mark cannot drift: `SimWordmark` inlines
5+
* them as server-rendered SVG for the navbar, footer, auth shell and settings
6+
* sidebar. The email header cannot — clients (Gmail chief among them) strip
7+
* inline SVG — so it renders a committed raster export of these same outlines;
8+
* {@link EMAIL_WORDMARK_SIZE} records how that file is produced.
9+
*/
10+
export const WORDMARK_VIEW_BOX = { width: 441, height: 212 } as const
11+
12+
/** Glyph outlines, drawn in `WORDMARK_VIEW_BOX` coordinates. */
13+
export const WORDMARK_PATHS: readonly string[] = [
14+
'M0 160.9H29.51C29.51 169.08 32.46 175.61 38.37 180.48C44.27 185.12 52.25 187.44 62.31 187.44C73.24 187.44 81.65 185.34 87.56 181.14C93.46 176.71 96.41 170.85 96.41 163.55C96.41 158.24 94.77 153.82 91.49 150.28C88.43 146.74 82.75 143.86 74.44 141.65L46.24 135.01C32.03 131.47 21.42 126.05 14.43 118.75C7.65 111.45 4.26 101.83 4.26 89.88C4.26 79.93 6.78 71.3 11.81 64C17.05 56.7 24.16 51.06 33.12 47.08C42.3 43.09 52.8 41.1 64.6 41.1C76.41 41.1 86.57 43.2 95.1 47.41C103.84 51.61 110.62 57.47 115.43 64.99C120.46 72.52 123.08 81.48 123.3 91.87H93.79C93.57 83.47 90.84 76.94 85.59 72.3C80.34 67.65 73.02 65.33 63.62 65.33C54 65.33 46.57 67.43 41.32 71.63C36.07 75.83 33.45 81.59 33.45 88.89C33.45 99.73 41.32 107.14 57.06 111.12L85.26 118.09C98.81 121.19 108.98 126.28 115.76 133.35C122.53 140.21 125.92 149.61 125.92 161.56C125.92 171.74 123.19 180.7 117.73 188.44C112.26 195.96 104.72 201.82 95.1 206.03C85.7 210.01 74.55 212 61.65 212C42.85 212 27.87 207.35 16.72 198.06C5.57 188.77 0 176.38 0 160.9Z',
15+
'M232.8 212H202.13L202.13 49.76H229.54V77.39C232.8 68.34 239.11 60.66 247.81 54.7C256.73 48.52 267.5 45.43 280.12 45.43C294.26 45.43 306.01 49.29 315.36 57.02C324.72 64.75 330.81 75.01 333.64 87.82H328.09C330.27 75.01 336.25 64.75 346.04 57.02C355.83 49.29 367.9 45.43 382.26 45.43C400.54 45.43 414.89 50.84 425.34 61.66C435.78 72.47 441 87.26 441 106.03V212H410.98V113.65C410.98 100.84 407.71 91.02 401.19 84.17C394.88 77.11 386.29 73.58 375.41 73.58C367.79 73.58 361.05 75.34 355.17 78.88C349.52 82.19 345.06 87.04 341.8 93.45C338.53 99.85 336.9 107.36 336.9 115.97V212H306.55V113.32C306.55 100.51 303.4 90.8 297.09 84.17C290.78 77.33 282.19 73.91 271.31 73.91C263.69 73.91 256.95 75.67 251.08 79.21C245.42 82.52 240.96 87.38 237.7 93.78C234.43 99.96 232.8 107.36 232.8 115.97V212Z',
16+
'M184.83 20.55C184.83 31.9 175.64 41.1 164.29 41.1C152.95 41.1 143.76 31.9 143.76 20.55C143.76 9.2 152.95 0 164.29 0C175.64 0 184.83 9.2 184.83 20.55Z',
17+
'M179.43 212H149.16V49.76C153.76 51.91 158.88 53.12 164.29 53.12C169.7 53.12 174.83 51.91 179.43 49.76V212Z',
18+
]
19+
20+
/**
21+
* Display box for the email header wordmark.
22+
*
23+
* The landing navbar sizes the mark at its neighbouring text plus 2px above and
24+
* below (18px ink against 14px chip labels). Email body copy is 16px, so the
25+
* mark stands 20px tall; the width follows the view box. Both dimensions are
26+
* pinned because email clients do no responsive image selection.
27+
*
28+
* The header renders `public/brand/color/email/wordmark.png` rather than these
29+
* paths, because email clients strip inline SVG. That file is these outlines
30+
* filled with the email palette's `textBody`, rasterized at 4x so the mark
31+
* stays crisp on retina and this box can be retuned without re-exporting it.
32+
*/
33+
export const EMAIL_WORDMARK_SIZE = { width: 42, height: 20 } as const
-7.56 KB
Loading

0 commit comments

Comments
 (0)