Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs(icons): Transpile icons #DS-987 #1766

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −0
Draft

Docs(icons): Transpile icons #DS-987 #1766

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions packages/icons/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,23 @@ export const Icon = ({ name, , size }) => {
};
```

### Next.js with Pages Router

If you are using Next.js with the Pages Router, it is necessary to add the following configuration to your Next.js configuration file
to transpile the `@lmc-eu/spirit-web-react` package, ensuring the correct functionality of the icons:

```javascript
const nextConfig = {
transpilePackages: ['@lmc-eu/spirit-web-react'],
// other configurations...
};

export default nextConfig;
```

This configuration is not required if you are using the Next.js App Router.

For more information, please see the [Next.js documentation][nextjs-transpilePackages].

[`spirit-web`]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/web
[nextjs-transpilePackages]: https://nextjs.org/docs/pages/api-reference/next-config-js/transpilePackages
Loading