3f550bc0ec
Due to nature of server-side rendering, navigation within the admin panel can lead to slow page response times. This can lead to the feeling of an unresponsive app after clicking a link, for example, where the page remains in a stale state while the server is processing. This is especially noticeable on slow networks when navigating to data heavy or process intensive pages. To alleviate the bad UX that this causes, the user needs immediate visual indication that _something_ is taking place. This PR renders a progress bar in the admin panel which is immediately displayed when a user clicks a link, and incrementally grows in size until the new route has loaded in. Inspired by https://github.com/vercel/react-transition-progress. Old: https://github.com/user-attachments/assets/1820dad1-3aea-417f-a61d-52244b12dc8d New: https://github.com/user-attachments/assets/99f4bb82-61d9-4a4c-9bdf-9e379bbafd31 To tie into the progress bar, you'll need to use Payload's new `Link` component instead of the one provided by Next.js: ```diff - import { Link } from 'next/link' + import { Link } from '@payloadcms/ui' ``` Here's an example: ```tsx import { Link } from '@payloadcms/ui' const MyComponent = () => { return ( <Link href="/somewhere"> Go Somewhere </Link> ) } ``` In order to trigger route transitions for a direct router event such as `router.push`, you'll need to wrap your function calls with the `startRouteTransition` method provided by the `useRouteTransition` hook. ```ts 'use client' import React, { useCallback } from 'react' import { useTransition } from '@payloadcms/ui' import { useRouter } from 'next/navigation' const MyComponent: React.FC = () => { const router = useRouter() const { startRouteTransition } = useRouteTransition() const redirectSomewhere = useCallback(() => { startRouteTransition(() => router.push('/somewhere')) }, [startRouteTransition, router]) // ... } ``` In the future [Next.js might provide native support for this](https://github.com/vercel/next.js/discussions/41934#discussioncomment-12077414), and if it does, this implementation can likely be simplified. Of course there are other ways of achieving this, such as with [Suspense](https://react.dev/reference/react/Suspense), but they all come with a different set of caveats. For example with Suspense, you must provide a fallback component. This means that the user might be able to immediately navigate to the new page, which is good, but they'd be presented with a skeleton UI while the other parts of the page stream in. Not necessarily an improvement to UX as there would be multiple loading states with this approach. There are other problems with using Suspense as well. Our default template, for example, contains the app header and sidebar which are not rendered within the root layout. This means that they need to stream in every single time. On fast networks, this would also lead to a noticeable "blink" unless there is some mechanism by which we can detect and defer the fallback from ever rendering in such cases. Might still be worth exploring in the future though.
Explore the Docs · Community Help · Roadmap · View G2 Reviews
Important
🎉 We've released 3.0! Star this repo or keep an eye on it to follow along.
Payload is the first-ever Next.js native CMS that can install directly in your existing /app folder. It's the start of a new era for headless CMS.
Benefits over a regular CMS
- Deploy anywhere, including serverless on Vercel for free
- Combine your front+backend in the same
/appfolder if you want - Don't sign up for yet another SaaS - Payload is open source
- Query your database in React Server Components
- Both admin and backend are 100% extensible
- No vendor lock-in
- Never touch ancient WP code again
- Build faster, never hit a roadblock
Quickstart
Before beginning to work with Payload, make sure you have all of the required software.
pnpx create-payload-app@latest
If you're new to Payload, you should start with the website template (pnpx create-payload-app@latest -t website). It shows how to do everything - including custom Rich Text blocks, on-demand revalidation, live preview, and more. It comes with a frontend built with Tailwind all in one /app folder.
One-click templates
Jumpstart your next project by starting with a pre-made template. These are production-ready, end-to-end solutions designed to get you to market as fast as possible.
🌐 Website
Build any kind of website, blog, or portfolio from small to enterprise. Comes with a fully functional front-end built with RSCs and Tailwind.
We're constantly adding more templates to our Templates Directory. If you maintain your own template, consider adding the payload-template topic to your GitHub repository for others to find.
✨ Features
- Completely free and open-source
- Next.js native, built to run inside your
/appfolder - Use server components to extend Payload UI
- Query your database directly in server components, no need for REST / GraphQL
- Fully TypeScript with automatic types for your data
- Auth out of the box
- Versions and drafts
- Localization
- Block-based layout builder
- Customizable React admin
- Lexical rich text editor
- Conditional field logic
- Extremely granular Access Control
- Document and field-level hooks for every action Payload provides
- Intensely fast API
- Highly secure thanks to HTTP-only cookies, CSRF protection, and more
🗒️ Documentation
Check out the Payload website to find in-depth documentation for everything that Payload offers.
Migrating from v2 to v3? Check out the 3.0 Migration Guide on how to do it.
🙋 Contributing
If you want to add contributions to this repository, please follow the instructions in contributing.md.
📚 Examples
The Examples Directory is a great resource for learning how to setup Payload in a variety of different ways, but you can also find great examples in our blog and throughout our social media.
If you'd like to run the examples, you can use create-payload-app to create a project from one:
npx create-payload-app --example example_name
You can see more examples at:
🔌 Plugins
Payload is highly extensible and allows you to install or distribute plugins that add or remove functionality. There are both officially-supported and community-supported plugins available. If you maintain your own plugin, consider adding the payload-plugin topic to your GitHub repository for others to find.
🚨 Need help?
There are lots of good conversations and resources in our Github Discussions board and our Discord Server. If you're struggling with something, chances are, someone's already solved what you're up against. 👇
⭐ Like what we're doing? Give us a star
