vercel / vercel/examples

Font Optimization example unclear on showing global usage

Open
#574 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
5.2k
Forks
1.8k
Avg merge
3d 12h
Merged PRs (30d)
6

Description

Looking at the code sample for Font Optimization, the index.jsx page imports inter from lib.

However, it then goes on to re-declare inter down within the documentation, causing the actual lib/inter file to not be used. Line 33 declares inter and seems to be the only place that the import would potentially actually be used. This leads to confusion to the reader about how and where the font is actually being referenced.

I think that the commented out code in _app.tsx might be what is supposed to be using the lib folder reference, but doesn't show the import of it at the top (nor commented out).

Personally, looking through the example I also found it really confusing because it has Tailwind explicitly mushed in, rather than just highlighting how you would use and set the fonts via classname like the documents do (https://nextjs.org/docs/api-reference/next/font) -- for those of us not using Tailwind, it's hard to see where the magic is explicitly happening that Next is doing under the hood (especially in consideration at all to the global fonts).

The only other spot in examples where I could see local fonts being used or set was in the platforms-slate-supabase example, which is also using Tailwind and doesn't seem to be using next/font. The other font example I see is in edge-functions but is explicitly not using the next/font package?

Is there an example somewhere that does use the recommended exported reused font declaration?

Related - the documentation for using next/font overall seems integrated with Next 13 only.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing solutions/loading-web-fonts/pages/index.tsx, pages/_app.tsx, and the lib/inter file referenced in the issue. Review the linked next/font documentation and determine how the example should demonstrate reused and global font declarations, including the role of Tailwind. Done means the example has one clear usage path and its documentation matches the implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
nextjs, tailwindcss, typescript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.