This example shows how to configure Absolute imports and Module path aliases in tsconfig.json
(or jsconfig.json
for JavaScript projects). These options will allow absolute imports from .
(the root directory), and allow you to create custom import aliases.
If you’re working on a large project, your relative import statements might suffer from ../../../
spaghetti:
import Button from '../../../components/button'
In such cases, we might want to setup absolute imports using the baseUrl
option, for clearer and shorter imports:
import Button from 'components/button'
Furthermore, TypeScript also supports the paths
option, which allows you to configure custom module aliases. You can then use your alias like so:
import Button from '@/components/button'
Deploy the example using Vercel or preview live with StackBlitz
Execute create-next-app
with npm, Yarn, or pnpm to bootstrap the example:
npx create-next-app --example with-absolute-imports with-absolute-imports-app
yarn create next-app --example with-absolute-imports with-absolute-imports-app
pnpm create next-app --example with-absolute-imports with-absolute-imports-app
Deploy it to the cloud with Vercel (Documentation).