What is geist?
The geist npm package is a React component library that provides a set of high-quality, customizable UI components. It is designed to help developers build modern, responsive web applications with ease.
What are geist's main functionalities?
Button
The Button component allows you to create various types of buttons with different styles and states. The example shows a success button.
<Button type='success'>Success</Button>
Modal
The Modal component is used to create dialog boxes or pop-ups. The example demonstrates a simple modal with a title and content.
<Modal visible={true}><Modal.Title>Title</Modal.Title><Modal.Content>Content</Modal.Content></Modal>
Input
The Input component provides a way to create text input fields. The example shows a basic input field with a placeholder.
<Input placeholder='Enter text' />
Card
The Card component is used to display content in a card layout. The example shows a simple card with content.
<Card><Card.Content>Card Content</Card.Content></Card>
Other packages similar to geist
material-ui
Material-UI is a popular React component library that implements Google's Material Design. It offers a wide range of components and customization options, making it a robust choice for building modern web applications. Compared to geist, Material-UI has a larger community and more extensive documentation.
chakra-ui
Chakra UI is a simple, modular, and accessible component library that gives you the building blocks to build React applications. It focuses on ease of use and accessibility, similar to geist, but offers a different set of design principles and components.
ant-design
Ant Design is a comprehensive UI framework for enterprise applications. It provides a wide range of high-quality components and design guidelines. Compared to geist, Ant Design is more feature-rich and is often used in larger, more complex applications.
Geist Sans & Geist Mono
Geist is a new font family created by Vercel in collaboration with Basement Studio.
Geist Sans is a sans-serif typeface designed for legibility and simplicity. It is modern, geometric, and based on the principles of classic Swiss typography. It is designed to be used in body copy, headlines, logos, posters, and other large display sizes.
Geist Mono is a monospaced typeface, crafted to be the perfect partner to Geist Sans. It is designed to be used in code editors, diagrams, terminals, and other text-based interfaces where code is rendered.
Installation
npm install geist
Using with Next.js
GeistSans
is exported from geist/font/sans
, and GeistMono
can be found in geist/font/mono
. Both are NextFontWithVariable
instances. You can learn more by reading the next/font
docs.
App Router
In app/layout.js
:
import { GeistSans } from "geist/font/sans";
export default function RootLayout({
children,
}) {
return (
<html lang="en" className={GeistSans.className}>
<body>{children}</body>
</html>
)
}
Pages Router
In pages/_app.js
:
import { GeistSans } from "geist/font/sans";
export default function MyApp({ Component, pageProps }) {
return (
<main className={GeistSans.className}>
<Component {...pageProps} />
</main>
)
}
If you're using a version of Next.js that's older than 15, then in next.config.js
or next.config.mjs
add:
/** @type {import('next').NextConfig} */
const nextConfig = {
reactStrictMode: true,
+ transpilePackages: ["geist"],
};
export default nextConfig;
This is required to fix errors like:
TypeError: next_font_local__WEBPACK_IMPORTED_MODULE_0___default(...) is not a function
SyntaxError: Cannot use import statement outside a module
With Tailwind CSS
GeistSans
and GeistMono
can be used through a CSS variable.
GeistSans
: --font-geist-sans
GeistMono
: --font-geist-mono
In app/layout.js
:
import { GeistSans } from 'geist/font/sans'
import { GeistMono } from 'geist/font/mono'
export default function RootLayout({
children,
}) {
return (
<html lang="en" className={`${GeistSans.variable} ${GeistMono.variable}`}>
<body>{children}</body>
</html>
)
}
Then in tailwind.config.js
:
module.exports = {
theme: {
extend: {
fontFamily: {
sans: ['var(--font-geist-sans)'],
mono: ['var(--font-geist-mono)'],
},
},
},
}
License
The Geist font family is free and open sourced under the SIL Open Font License.
Inspiration
Geist has been influenced and inspired by the following typefaces: Inter, Univers, SF Mono, SF Pro, Suisse International, ABC Diatype Mono, and ABC Diatype. We thank the creators of these typefaces for their craft.