Footnotes
Typography
Reading column with comfortable measure, paragraph rhythm, quotes without side bars and policy pages that render as plain prose.
실제로 돌아가는 부품입니다. 눌러 보고 입력해 보세요.
내 앱에 넣기
아직 npm 패키지가 없어서 Taster 리포를 받아 그 안의 명령을 씁니다. 내 앱 폴더가 들어 있는 폴더에서 한 번만 받습니다.
git clone https://github.com/makim-414/taster.git && npm ci --prefix taster/packages/engine내 앱 폴더에서 이 부품을 넣습니다. 부품 파일과 토큰 파일이
src/components/taster에 들어갑니다.node ../taster/packages/engine/cli.mjs add content/footnotes --from https://taster-six.vercel.app --dir src/components/taster부품은 Tailwind 클래스로 그리고, Taster 프리셋이 그 클래스를 토큰에 연결합니다. Tailwind CSS 를 설치하고,
tokens.css를 앱 루트에서 한 번 불러온 뒤, 앱 루트에 이 설정을 둡니다. 프리셋이 없으면 빌드는 되어도 부품이 스타일 없이 나옵니다.// tailwind.config.cjs module.exports = { presets: [require('./src/components/taster/tailwind-preset.cjs')], content: ['./index.html', './src/**/*.{ts,tsx}'], };Tailwind v3 는 이 파일을 그대로 읽습니다. v4 는 Tailwind 를 불러오는
src/의 스타일시트 맨 위에 이 두 줄을 넣습니다.@import "tailwindcss"; @config "../tailwind.config.cjs";tokens.css는:root에--bg,--text,--border,--accent를 정의합니다. 내 앱의 스타일시트가 같은 이름을 뒤에서 다시 정의하면 그쪽 색이 이깁니다. 새 Vite 앱의 스타터 CSS 처럼 그런 변수가 있으면 지우거나 이름을 바꾸세요.
언제 쓰나요
- Long-form proseReading column with comfortable measure, paragraph rhythm, quotes without side bars and policy pages that render as plain prose.
대신 없애 주는 AI 티
- Tight line height on Korean text (KO-03)
- Korean body text that is too small (KO-11)
- Long content as one image (LAY-07)
정보
코드 보기
import * as React from 'react'
import { cn } from '../blocks/_cn'
// Footnotes: numbered references in the text and the matching notes at the end, linked both ways. A
// reference is a real link to its note with the number as text and a label for screen readers; each note
// ends with a link back to where it was cited. Numbers come from the order of `notes`, so moving a note
// renumbers every reference without editing the text.
// Follows patterns/long-form-prose: notes in the same face one step smaller, muted, under a hairline.
// Use FootnoteRef inside Prose or any paragraph, and Footnotes once after the body.
// Original code, MIT.
export interface FootnoteItem {
id: string
content: React.ReactNode
}
const Ctx = React.createContext<{ order: string[]; prefix: string }>({ order: [], prefix: 'fn' })
export interface FootnotesProviderProps {
notes: FootnoteItem[]
/** Prefix for element ids, unique per article. Default "fn". */
prefix?: string
children: React.ReactNode
}
/** Wrap the article so references and the list share the numbering. */
export function FootnotesProvider({ notes, prefix = 'fn', children }: FootnotesProviderProps) {
const value = React.useMemo(() => ({ order: notes.map((n) => n.id), prefix }), [notes, prefix])
return <Ctx.Provider value={value}>{children}</Ctx.Provider>
}
export interface FootnoteRefProps extends React.AnchorHTMLAttributes<HTMLAnchorElement> {
id: string
/** Read before the number, for example "Note". */
label?: string
}
export function FootnoteRef({ id, label = 'Note', className, ...props }: FootnoteRefProps) {
const { order, prefix } = React.useContext(Ctx)
const n = order.indexOf(id) + 1
if (n < 1) return null
// The link sits inline in its sentence (raised with vertical-align, no <sup> wrapper), so it counts as
// part of the line of text for touch target rules.
return (
<a
id={`${prefix}-ref-${id}`}
href={`#${prefix}-${id}`}
className={cn(
'ml-0.5 rounded-sm px-0.5 align-super text-[0.75em] font-medium leading-none tabular-nums text-text no-underline outline-none hover:underline focus-visible:ring-2 focus-visible:ring-ring',
className,
)}
{...props}
>
<span className="sr-only">{label} </span>
{n}
</a>
)
}
export interface FootnotesProps extends React.HTMLAttributes<HTMLElement> {
notes: FootnoteItem[]
title?: string
backLabel?: string
}
export function Footnotes({ notes, title = 'Notes', backLabel = 'Back to text', className, ...props }: FootnotesProps) {
const { prefix } = React.useContext(Ctx)
const titleId = `${prefix}-title`
return (
<section aria-labelledby={titleId} className={cn('mt-12 max-w-[65ch] border-t border-border pt-6', className)} {...props}>
<h2 id={titleId} className="text-body font-semibold text-text">
{title}
</h2>
<ol className="m-0 mt-3 grid list-none gap-3 p-0">
{notes.map((n, i) => (
<li key={n.id} id={`${prefix}-${n.id}`} className="grid scroll-mt-16 grid-cols-[2ch_minmax(0,1fr)] gap-3 text-body leading-[var(--lh-normal)] text-text-muted">
<span className="tabular-nums text-text-subtle">{i + 1}.</span>
<span className="break-keep [overflow-wrap:break-word]">
{n.content}{' '}
<a
href={`#${prefix}-ref-${n.id}`}
className="rounded-sm text-text underline underline-offset-4 outline-none hover:text-text-muted focus-visible:ring-2 focus-visible:ring-ring"
>
{backLabel}
</a>
</span>
</li>
))}
</ol>
</section>
)
}