@liiift-studio/sanity-font-data-extractor

sanity-font-data-extractor

Inspect OpenType metadata, variable-font axes, and font metrics directly inside Sanity Studio — drag in one or more .otf / .ttf / .woff / .woff2 files and read their internals without leaving the CMS.

A client-side React component for Sanity Studio (v3 through v6). Upload font files and the component parses them in the browser with fontkit, then surfaces the family/style/version, glyph count, metrics (units-per-em, ascent, descent, line gap), and the full parsed font object — including variable-font fvar axes and the name table — in an expandable inspector. Upload two or more fonts to compare their metrics side by side.

Privacy: font bytes never leave the browser. Files are read with FileReader and parsed client-side via fontkit; nothing is uploaded to Sanity or any server.

How it works

Install

npm install @liiift-studio/sanity-font-data-extractor

Install the peer dependencies if your Studio does not already provide them:

npm install sanity @sanity/ui @sanity/icons react fontkit

Peer dependency	Supported range	Notes
sanity	>=3 <7	Studio v3, v4, v5 and v6
@sanity/ui	>=2 <5	Not a typo — Studio v6 ships @sanity/ui v4, not v5
@sanity/icons	>=2 <6
react	^18 || ^19
fontkit	^2	optional peer (peerDependenciesMeta) — required at runtime to parse fonts

@devtools-ds/object-inspector (the metadata tree view) and @liiift-studio/sanity-ui-compat (see Compatibility) ship as direct dependencies, so you do not install them yourself.

Compatibility

This one build runs on four consecutive Studio majors. The peer ranges above look wrong at a glance, so here is why they are not.

@sanity/ui v4 moved Tooltip, Menu, MenuButton, MenuItem, Code, Popover, Autocomplete, Toast and useToast out of the package root into subpath entries, and @sanity/icons v5 removed every named *Icon export.

The trap: both packages still declare the removed names in their .d.ts, typed never. A named import therefore type-checks, compiles green, and only then fails at runtime as an undefined component. tsc cannot see the breakage, so a passing build proves nothing here.

This package therefore imports no @sanity/ui or @sanity/icons symbol directly. Every primitive (Card, Stack, Grid, usePrefersDark, …) and every icon (UploadIcon, TrashIcon, CopyIcon, …) routes through @liiift-studio/sanity-ui-compat and its /icons subpath, which resolve whichever namespace is actually installed at runtime and degrade gracefully when a symbol is absent:

// src/GetFontData.jsx — no direct @sanity/ui or @sanity/icons import anywhere
import { Stack, Card, Grid, Heading, Text, Button, Badge, Flex, Box, usePrefersDark } from '@liiift-studio/sanity-ui-compat'
import { TrashIcon, UploadIcon, CopyIcon, CheckmarkIcon, CloseIcon } from '@liiift-studio/sanity-ui-compat/icons'

Note the @sanity/ui peer of >=2 <5: Studio v6 ships @sanity/ui v4, not v5, so excluding v5 is correct rather than a stale upper bound.

Verification status. v3–v6 support rests on the declared peer ranges and a green build. It has been exercised in three in-house Studios; it has not been broadly validated in a running Sanity 6 Studio. Treat v6 as supported but lightly travelled, and please open an issue if something looks off.

Usage

The package's default export is the GetFontData component. Mount it anywhere in your Studio — most commonly as a custom Structure tool or a desk view:

import GetFontData from '@liiift-studio/sanity-font-data-extractor'
import { useClient } from 'sanity'
import { SearchIcon } from '@sanity/icons'

export function FontInspector() {
	const client = useClient({ apiVersion: '2024-01-01' })

	return (
		<GetFontData
			icon={SearchIcon}
			client={client}
			displayName="Font Inspector"
		/>
	)
}

Then add it to your Studio's structure, for example:

// sanity.config.js (structure tool)
S.view
	.component(FontInspector)
	.title('Font Inspector')

Props

Prop	Type	Description
icon	React.ComponentType	Icon component rendered next to the heading (e.g. a @sanity/icons icon).
client	SanityClient	A Sanity client instance. Accepted for forward compatibility; the current upload-and-parse flow runs entirely in the browser and does not query the client.
displayName	string	Heading shown above the upload area.

Features

• Upload or drag & drop one or many .otf / .ttf / .woff / .woff2 files.
• Summary cards — family name, style name, glyph count, version at a glance.
• Full metadata inspector — the entire parsed fontkit object in an expandable, dark/light-aware ObjectInspector tree, including variable-font fvar axes/instances and the OpenType name table.
• Side-by-side compare — upload 2+ fonts and switch to Compare view for a metrics table (family, style, full name, version, glyph count, units-per-em, ascent, descent, line gap), with differing values highlighted.
• Copy metadata — copy the parsed font object as formatted JSON to the clipboard.

A live screenshot of the inspector running inside Sanity Studio is welcome — the component is an interactive upload UI and cannot be captured headlessly. Maintainers/users: a Studio screenshot or GIF would slot in above.

Requirements

• A Sanity Studio v3, v4, v5, or v6 project (see Compatibility).
• A browser environment (the component is client-side React; it is not a CLI or server utility).

Regenerating the diagram

The pipeline diagram is generated from a committed Mermaid source — no manual editing of the image:

npm run capture   # scripts/extraction-pipeline.mmd -> assets/extraction-pipeline.svg

License

MIT Quinn Keaveney / Liiift Studio