fontline
v1.0.2
Published
Font management system for Next.js applications
Downloads
107
Maintainers
thelunaticladReadme
fontline
A powerful and flexible font management system for Next.js applications.
Features
- 🎯 Type-safe font configuration
- 🔄 Automatic font loading and management
- 💾 Persistent font preferences
- 🎨 CSS variables integration
- ⚛️ React hooks for font management
- 📦 Zero-config integration with Next.js
- 🌓 Smooth font transitions
- 🔍 SSR support
Installation
# npm
npm install fontline
# pnpm
pnpm add fontline
# yarn
yarn add fontlineQuick Start
- Load your fonts using Next.js font loaders:
// app/fonts.ts
import { Inter, Roboto } from 'next/font/google'
import type { FontProviderProps } from 'fontline'
const inter = Inter({
subsets: ['latin'],
variable: '--font-inter',
})
const roboto = Roboto({
subsets: ['latin'],
weight: ['400', '700'],
variable: '--font-roboto',
})
export const fontConfig: FontProviderProps = {
fonts: {
inter: {
className: inter.className,
style: { fontFamily: inter.style.fontFamily }
},
roboto: {
className: roboto.className,
style: { fontFamily: roboto.style.fontFamily }
}
},
defaultFont: 'inter',
// Optional: Custom class mappings
values: {
inter: 'my-custom-inter',
roboto: 'my-custom-roboto'
},
}- Set up the provider in your layout:
// app/layout.tsx
import { FontProvider } from 'fontline'
import { fontConfig } from './fonts'
export default function RootLayout({
children,
}: {
children: React.ReactNode
}) {
return (
<html lang="en" suppressHydrationWarning>
<body>
<FontProvider {...fontConfig}>
{children}
</FontProvider>
</body>
</html>
)
}- Use the hook in your components:
// components/font-selector.tsx
import { useFont } from 'fontline'
export function FontSelector() {
const { font, setFont, fonts } = useFont()
return (
<select
value={font}
onChange={(e) => setFont(e.target.value)}
>
{fonts.map((fontName) => (
<option key={fontName} value={fontName}>
{fontName}
</option>
))}
</select>
)
}API Reference
FontProvider
The main provider component for font management.
interface FontProviderProps {
fonts: Record<string, FontConfig>;
defaultFont: string;
forcedFont?: string;
storageKey?: string;
disableTransitionOnChange?: boolean;
values?: FontValues;
nonce?: string;
}useFont Hook
Hook for accessing font state and controls.
interface UseFontProps {
font: string;
setFont: React.Dispatch<React.SetStateAction<string>>;
fonts: string[];
forcedFont?: string;
resolvedFont: string;
}
const { font, setFont, fonts, resolvedFont } = useFont()Configuration Options
fonts: Record of available fonts with their configurationsdefaultFont: Initial font to useforcedFont: Override user selection (optional)storageKey: LocalStorage key for persistence (default: 'font')disableTransitionOnChange: Disable transitions when changing fontsvalues: Custom class name mappingsnonce: CSP nonce for inline scripts
Advanced Usage
Custom Font Classes
const fontConfig: FontProviderProps = {
fonts: {
inter: {
className: 'font-inter',
style: { fontFamily: 'Inter' }
}
},
values: {
inter: 'my-custom-class'
}
}Forced Font
<FontProvider
{...fontConfig}
forcedFont="inter"
>
{children}
</FontProvider>Disable Transitions
<FontProvider
{...fontConfig}
disableTransitionOnChange
>
{children}
</FontProvider>Browser Support
- Chrome (latest)
- Firefox (latest)
- Safari (latest)
- Edge (latest)
- IE 11 (basic support)
Contributing
Contributions are welcome! Please read our Contributing Guide for details.