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

(docs): Document creating packages with framework bindings. #9222

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

(docs): Document creating packages with framework bindings. #9222

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28dddcb
(docs): Document creating packages with Next.js bindings.
anthonyshew Oct 4, 2024
c5f85fe
WIP
anthonyshew Oct 4, 2024
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
20 changes: 20 additions & 0 deletions docs/repo-docs/guides/frameworks/nextjs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,23 @@ Make sure to run your package manager's install command. You also may need to up
### Customizing tasks

By default, the new application will use the tasks defined in the root `turbo.json`. If you'd like to configure tasks differently for the new application, use [Package Configurations](/repo/docs/reference/package-configurations).

## Creating packages with Next.js bindings

At times, you may want to create a package that has bindings specific to Next.js. For example, you may want the package to be using the Next.js `<Link />` component. In these cases, install `next` directly into the package and use it there.

These bindings may make your package incompatible with other frameworks or packages that are not using Next.js. To ensure compatibility, create a specific entrypoint to your package for your Next.js adapter code.

```json title="./packages/ui/package.json"
{
"exports": {
"./link": "./dist/link.js"
"./image": "./dist/image.js"
"./next-js/link": "./dist/link.js"
"./next-js/image": "./dist/image.js"
},
"peerDependencies": {
"next": "*" // You may want to specify a version range, according to your package's needs and constraints
}
}
```
Loading