@aori/fonts v1.0.4

Aori Typography System

View Typography System PDF

About

This repository contains the official Aori typography system fonts for use in web apps and marketing materials.

Installation

The official Aori typography system can be easily imported for use in frontend frameworks like Next.js, React, and Vue.

# or
bun add @aori/fonts
# or
npm install @aori/fonts
# or
yarn add @aori/fonts

Usage

Next.js Pages Router Integration

For Next.js apps using the Pages Router, import the font in your _app.tsx file:

// pages/_app.tsx
import { AoriSans } from '@aori/fonts/font/sans';
import { AoriMono } from '@aori/fonts/font/mono';

export default function App({ Component, pageProps }) {
  return (
    <>
      <style jsx global>{`
        :root {
          --font-aori-sans: ${AoriSans.style.fontFamily};
          --font-aori-mono: ${AoriMono.style.fontFamily};
        }
      `}</style>
      <Component {...pageProps} />
    </>
  );
}

Basic Font Import

Import the fonts in your root layout or app component:

// app/layout.tsx or pages/_app.tsx
import "@aori/fonts";

Tailwind Configuration

Add the Aori preset to your tailwind.config.js/ts:

/** @type {import('tailwindcss').Config} */
module.exports = {
  presets: [require("@aori/fonts/tailwind")],
  content: [
    // ...
  ],
};

Next.js Configuration

Add this to your next.config.js:

/** @type {import('next').NextConfig} */
const nextConfig = {
  // This is needed for font file loading
  webpack(config) {
    config.module.rules.push({
      test: /\.(woff|woff2|eot|ttf|otf)$/i,
      type: "asset/resource",
    });
    return config;
  },
  
  // Required for Next.js versions older than 15 to work with this package
  transpilePackages: ["@aori/fonts"],
};

module.exports = nextConfig;

Available Classes

Font Family

<div className="font-aori">Uses Aori font</div>;
{
  /* or */
}
<div className="font-sans">Uses Aori as system font</div>;

Typography Scales

<h1 className="text-aori-h1">Heading 1</h1>
<h2 className="text-aori-h2">Heading 2</h2>
<p className="text-aori-body">Body text</p>

Letter Spacing

<div className="tracking-aori-tight">Tight tracking</div>
<div className="tracking-aori-normal">Normal tracking</div>
<div className="tracking-aori-wide">Wide tracking</div>

Utility Classes

<h1 className="aori-heading-xl">Extra Large Heading</h1>
<h2 className="aori-heading-lg">Large Heading</h2>

License

See LICENSE for details.

Repository Layout

This font repository structure is inspired by Unified Font Repository v0.3.