chore(release): v3.0.0-beta.103 [skip ci]

## Description

Fixes https://github.com/payloadcms/payload/issues/8134

- [x] I have read and understand the
[CONTRIBUTING.md](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md)
document in this repository.

## Type of change

<!-- Please delete options that are not relevant. -->

- [x] Bug fix (non-breaking change which fixes an issue)

## Checklist:

- [x] Existing test suite passes locally with my changes

.editorconfig

@@ -0,0 +1,29 @@
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{js,ts,tsx}]
+indent_style = space
+indent_size = 2
+
+[*.html]
+indent_style = space
+indent_size = 2
+
+[*.scss]
+indent_style = space
+indent_size = 2
+
+[*.mdx]
+indent_style = space
+indent_size = 2
+
+[*.json]
+indent_style = space
+indent_size = 2
+
+[*.md]
+indent_style = space
+indent_size = 2

.eslintrc.js

@@ -1,30 +0,0 @@
-module.exports = {
-  plugins: ['@typescript-eslint', 'prettier'],
-  parser: '@typescript-eslint/parser', // Specifies the ESLint parser
-  parserOptions: {
-    ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
-    sourceType: 'module', // Allows for the use of imports
-    ecmaFeatures: {
-      jsx: true, // Allows for the parsing of JSX
-    },
-  },
-  extends: [
-    'plugin:@typescript-eslint/recommended',
-    'plugin:prettier/recommended',
-    'prettier',
-  ],
-  settings: {
-    'import/resolver': {
-      node: {
-        extensions: ['.js', '.jsx', '.ts', '.tsx'],
-      },
-    },
-  },
-  ignorePatterns: ['node_modules', 'src/templates', 'dist'],
-  rules: {
-    'prettier/prettier': 'error',
-    'import/prefer-default-export': 'off',
-    'no-underscore-dangle': 'off',
-    '@typescript-eslint/consistent-type-imports': 'warn',
-  },
-};

.git-blame-ignore-revs

@@ -0,0 +1,30 @@
+# lint and format
+ae7d6f97d205491390f15850e5104c7abded1550
+1fbda85cd04a774cb978778b0f813001664c53dd
+
+# prettier all templates
+75a428ddc4672903455998eaba7ae9f9d710bf85
+
+# re-run prettier and eslint everywhere again
+cdaa0acd61d3001407609915bd573b78565d5571
+
+# prettier write again
+dfac7395fed95fc5d8ebca21b786ce70821942bb
+
+# lint and format plugin-cloud
+fb7d1be2f3325d076b7c967b1730afcef37922c2
+
+# lint and format create-payload-app
+5fd3d430001efe86515262ded5e26f00c1451181
+
+# 3.0 prettier & lint everywhere
+6789e61488a1d3de56f472ac3214faf344030005
+
+# 3.0 prettier & lint everywhere again
+83fd4c66222d7846eeb5cc332dfa99bf1e830831
+
+# Upgrade to typescript-eslint v8, then prettier & lint everywhere
+86fdad0bb8ab27810599c8a32f3d8cba1341e1df
+
+# Prettier and lint remaining db packages
+7fd736ea5b2e9fc4ef936e9dc9e5e3d722f6d8bf

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto eol=lf

.github/CODEOWNERS

@@ -0,0 +1,29 @@
+# Order matters. The last matching pattern takes precedence.
+# Approvals are not required currently but may be enabled in the future.
+
+### Package Exports ###
+/**/exports/ @denolfe @jmikrut @DanRibbens
+
+### Packages ###
+/packages/plugin-cloud*/src/ @denolfe
+/packages/email-*/src/ @denolfe
+/packages/storage-*/src/ @denolfe
+/packages/create-payload-app/src/ @denolfe
+/packages/eslint-*/ @denolfe @AlessioGr
+
+### Templates ###
+/templates/_data/ @denolfe
+/templates/_template/ @denolfe
+
+### Build Files ###
+/tsconfig.json @denolfe
+/**/tsconfig*.json @denolfe
+/jest.config.js @denolfe
+/**/jest.config.js @denolfe
+
+### Root ###
+/package.json @denolfe
+/scripts/ @denolfe
+/.husky/ @denolfe
+/.vscode/ @denolfe @AlessioGr
+/.github/ @denolfe

.github/ISSUE_TEMPLATE/1.bug_report.yml

@@ -0,0 +1,47 @@
+name: Bug Report
+description: Create a bug report for Payload
+labels: ['[possible-bug]']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        *Note:* Feature requests should be opened as [discussions](https://github.com/payloadcms/payload/discussions/new?category=feature-requests-ideas).
+  - type: input
+    id: reproduction-link
+    attributes:
+      label: Link to reproduction
+      description: Want us to look into your issue faster? Follow the [reproduction-guide](https://github.com/payloadcms/payload/blob/main/.github/reproduction-guide.md) for more information.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Describe the Bug
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: To Reproduce
+      description: Steps to reproduce the behavior, please provide a clear description of how to reproduce the issue, based on the linked minimal reproduction. Screenshots can be provided in the issue body below. If using code blocks, make sure that [syntax highlighting is correct](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) and double check that the rendered preview is not broken.
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Payload Version
+      description: What version of Payload are you running?
+    validations:
+      required: true
+  - type: input
+    id: adapters-plugins
+    attributes:
+      label: Adapters and Plugins
+      description: What adapters and plugins are you using? ie. db-mongodb, db-postgres, bundler-webpack, etc.
+  - type: markdown
+    attributes:
+      value: Before submitting the issue, go through the steps you've written down to make sure the steps provided are detailed and clear.
+  - type: markdown
+    attributes:
+      value: Contributors should be able to follow the steps provided in order to reproduce the bug.
+  - type: markdown
+    attributes:
+      value: These steps are used to add integration tests to ensure the same issue does not happen again. Thanks in advance!

.github/ISSUE_TEMPLATE/DOCUMENTATION_ISSUE.md

@@ -0,0 +1,13 @@
+---
+name: Documentation Issue
+about: Suggest fix to Payload documentation
+labels: 'documentation'
+---
+
+# Documentation Issue
+
+<!--- Please provide a summary of the documentation issue -->
+
+## Additional Details
+
+<!--- Provide any other additional details -->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Feature Request
+    url: https://github.com/payloadcms/payload/discussions
+    about: Suggest an idea to improve Payload in our GitHub Discussions
+  - name: Question about Payload
+    url: https://github.com/payloadcms/payload/discussions
+    about: Please ask Payload-related questions in our GitHub Discussions

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+## Description
+
+<!-- Please include a summary of the pull request and any related issues it fixes. Please also include relevant motivation and context. -->
+
+- [ ] I have read and understand the [CONTRIBUTING.md](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md) document in this repository.
+
+## Type of change
+
+<!-- Please delete options that are not relevant. -->
+
+- [ ] Chore (non-breaking change which does not add functionality)
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Change to the [templates](https://github.com/payloadcms/payload/tree/main/templates) directory (does not affect core functionality)
+- [ ] Change to the [examples](https://github.com/payloadcms/payload/tree/main/examples) directory (does not affect core functionality)
+- [ ] This change requires a documentation update
+
+## Checklist:
+
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] Existing test suite passes locally with my changes
+- [ ] I have made corresponding changes to the documentation

.github/actions/setup/action.yml

@@ -0,0 +1,48 @@
+name: Setup node and pnpm
+description: Configure the Node.js and pnpm versions
+
+inputs:
+  node-version:
+    description: 'The Node.js version to use'
+    required: true
+    default: 18.20.2
+  pnpm-version:
+    description: 'The pnpm version to use'
+    required: true
+    default: 9.7.0
+
+runs:
+  using: composite
+  steps:
+    # https://github.com/actions/virtual-environments/issues/1187
+    - name: tune linux network
+      shell: bash
+      run: sudo ethtool -K eth0 tx off rx off
+
+    - name: Setup Node@${{ inputs.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ inputs.node-version }}
+
+    - name: Install pnpm
+      uses: pnpm/action-setup@v4
+      with:
+        version: ${{ inputs.pnpm-version }}
+        run_install: false
+
+    - name: Get pnpm store directory
+      shell: bash
+      run: |
+        echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+    - name: Setup pnpm cache
+      uses: actions/cache@v4
+      with:
+        path: ${{ env.STORE_PATH }}
+        key: pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+        restore-keys: |
+          pnpm-store-
+          pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+
+    - shell: bash
+      run: pnpm install

.github/reproduction-guide.md

@@ -0,0 +1,64 @@
+# Reproduction Guide
+
+1. [Fork](https://github.com/payloadcms/payload/fork) this repo
+2. Optionally, create a new branch for your reproduction
+3. Run `pnpm install` to install dependencies
+4. Open up the `test/_community` directory
+5. Add any necessary `collections/globals/fields` in this directory to recreate the issue you are experiencing
+6. Run `pnpm dev _community` to start the admin panel
+
+**NOTE:** The goal is to isolate the problem by reducing the number of `collections/globals/fields` you add to the `test/_community` folder. This folder is _not_ meant for you to copy your project into, but rather recreate the issue you are experiencing with minimal config.
+
+## Example test directory file tree
+
+```text
+.
+├── config.ts
+├── int.spec.ts
+├── e2e.spec.ts
+└── payload-types.ts
+```
+
+- `config.ts` - This is the _granular_ Payload config for testing. It should be as lightweight as possible. Reference existing configs for an example
+- `int.spec.ts` [Optional] - This is the test file run by jest. Any test file must have a `*int.spec.ts` suffix.
+- `e2e.spec.ts` [Optional] - This is the end-to-end test file that will load up the admin UI using the above config and run Playwright tests.
+- `payload-types.ts` - Generated types from `config.ts`. Generate this file by running `pnpm dev:generate-types _community`.
+
+The directory split up in this way specifically to reduce friction when creating tests and to add the ability to boot up Payload with that specific config. You should modify the files in `test/_community` to get started.
+
+<br />
+
+## Testing is optional but encouraged
+
+An issue does not need to have failing tests — reproduction steps with your forked repo are enough at this point. Some people like to dive deeper and we want to give you the guidance/tools to do so. Read more below:
+
+### Running integration tests (Payload API tests)
+
+First install [Jest Runner for VSVode](https://marketplace.visualstudio.com/items?itemName=firsttris.vscode-jest-runner).
+
+There are a couple ways run integration tests:
+
+- **Granularly** - you can run individual tests in vscode by installing the Jest Runner plugin and using that to run individual tests. Clicking the `debug` button will run the test in debug mode allowing you to set break points.
+
+  <img src="https://raw.githubusercontent.com/payloadcms/payload/main/packages/payload/src/admin/assets/images/github/int-debug.png" />
+
+- **Manually** - you can run all int tests in the `/test/_community/int.spec.ts` file by running the following command:
+
+  ```bash
+  pnpm test:int _community
+  ```
+
+### Running E2E tests (Admin Panel UI tests)
+
+The easiest way to run E2E tests is to install
+
+- [Playwright Test for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright)
+- [Playwright Runner](https://marketplace.visualstudio.com/items?itemName=ortoni.ortoni)
+
+Once they are installed you can open the `testing` tab in vscode sidebar and drill down to the test you want to run, i.e. `/test/_community/e2e.spec.ts`
+
+<img src="https://raw.githubusercontent.com/payloadcms/payload/main/packages/payload/src/admin/assets/images/github/e2e-debug.png" />
+
+#### Notes
+
+The default credentials are `dev@payloadcms.com` as email and `test` as password. They can be found in `test/credentials.ts`. By default, these will be autofilled, so no log-in is required.

.github/workflows/label-author.yml

@@ -0,0 +1,50 @@
+name: label-author
+
+on:
+  pull_request:
+    types: [opened]
+  issues:
+    types: [opened]
+
+permissions:
+  contents: read
+  pull-requests: write
+  issues: write
+
+jobs:
+  debug-context:
+    runs-on: ubuntu-latest
+    steps:
+      - name: View context attributes
+        uses: actions/github-script@v7
+        with:
+          script: console.log(context)
+
+  label-created-by:
+    name: Label pr/issue on opening
+    runs-on: ubuntu-latest
+    steps:
+      - name: Tag with 'created-by'
+        uses: actions/github-script@v7
+        if: github.event.action == 'opened'
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const type = context.payload.pull_request ? 'pull_request' : 'issue';
+            const association = context.payload[type].author_association;
+            let label = ''
+            if (association === 'MEMBER' || association === 'OWNER') {
+              label = 'created-by: Payload team';
+            } else if (association === 'CONTRIBUTOR') {
+              label = 'created-by: Contributor';
+            }
+
+            if (!label) return;
+
+            github.rest.issues.addLabels({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              labels: [label],
+            });
+            console.log('Added created-by: Payload team label');

.github/workflows/main.yml

@@ -0,0 +1,562 @@
+name: build
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+  push:
+    branches:
+      - main
+      - beta
+
+concurrency:
+  # <workflow_name>-<branch_name>-<true || commit_sha if branch is protected>
+  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.ref_protected && github.sha || ''}}
+  cancel-in-progress: true
+
+env:
+  NODE_VERSION: 22.6.0
+  PNPM_VERSION: 9.7.1
+  DO_NOT_TRACK: 1 # Disable Turbopack telemetry
+  NEXT_TELEMETRY_DISABLED: 1 # Disable Next telemetry
+
+jobs:
+  changes:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read
+    outputs:
+      needs_build: ${{ steps.filter.outputs.needs_build }}
+      templates: ${{ steps.filter.outputs.templates }}
+    steps:
+      # https://github.com/actions/virtual-environments/issues/1187
+      - name: tune linux network
+        run: sudo ethtool -K eth0 tx off rx off
+
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 25
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            needs_build:
+              - '.github/workflows/**'
+              - 'packages/**'
+              - 'test/**'
+              - 'pnpm-lock.yaml'
+              - 'package.json'
+            templates:
+              - 'templates/**'
+      - name: Log all filter results
+        run: |
+          echo "needs_build: ${{ steps.filter.outputs.needs_build }}"
+          echo "templates: ${{ steps.filter.outputs.templates }}"
+
+  lint:
+    if: >
+      github.event_name == 'pull_request' && !contains(github.event.pull_request.title, 'no-lint') && !contains(github.event.pull_request.title, 'skip-lint')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      # https://github.com/actions/virtual-environments/issues/1187
+      - name: tune linux network
+        run: sudo ethtool -K eth0 tx off rx off
+
+      - name: Setup Node@${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: ${{ env.PNPM_VERSION }}
+          run_install: false
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - name: Setup pnpm cache
+        uses: actions/cache@v4
+        timeout-minutes: 720
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            pnpm-store-
+            pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+
+      - run: pnpm install
+      - name: Lint staged
+        run: |
+          git diff --name-only --diff-filter=d origin/${GITHUB_BASE_REF}...${GITHUB_SHA}
+          npx lint-staged --diff="origin/${GITHUB_BASE_REF}...${GITHUB_SHA}"
+
+  build:
+    needs: changes
+    if: ${{ needs.changes.outputs.needs_build == 'true' }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 25
+
+      # https://github.com/actions/virtual-environments/issues/1187
+      - name: tune linux network
+        run: sudo ethtool -K eth0 tx off rx off
+
+      - name: Setup Node@${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: ${{ env.PNPM_VERSION }}
+          run_install: false
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - name: Setup pnpm cache
+        uses: actions/cache@v4
+        timeout-minutes: 720
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            pnpm-store-
+            pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+
+      - run: pnpm install
+      - run: pnpm run build:all
+        env:
+          DO_NOT_TRACK: 1 # Disable Turbopack telemetry
+
+      - name: Cache build
+        uses: actions/cache@v4
+        timeout-minutes: 10
+        with:
+          path: ./*
+          key: ${{ github.sha }}-${{ github.run_number }}
+
+  tests-unit:
+    runs-on: ubuntu-latest
+    needs: build
+
+    steps:
+      # https://github.com/actions/virtual-environments/issues/1187
+      - name: tune linux network
+        run: sudo ethtool -K eth0 tx off rx off
+
+      - name: Setup Node@${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: ${{ env.PNPM_VERSION }}
+          run_install: false
+
+      - name: Restore build
+        uses: actions/cache@v4
+        timeout-minutes: 10
+        with:
+          path: ./*
+          key: ${{ github.sha }}-${{ github.run_number }}
+
+      - name: Unit Tests
+        run: pnpm test:unit
+        env:
+          NODE_OPTIONS: --max-old-space-size=8096
+
+  tests-int:
+    runs-on: ubuntu-latest
+    needs: build
+    strategy:
+      fail-fast: false
+      matrix:
+        database:
+          - mongodb
+          - postgres
+          - postgres-custom-schema
+          - postgres-uuid
+          - supabase
+          - sqlite
+    env:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: payloadtests
+      AWS_ENDPOINT_URL: http://127.0.0.1:4566
+      AWS_ACCESS_KEY_ID: localstack
+      AWS_SECRET_ACCESS_KEY: localstack
+      AWS_REGION: us-east-1
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 25
+      # https://github.com/actions/virtual-environments/issues/1187
+      - name: tune linux network
+        run: sudo ethtool -K eth0 tx off rx off
+
+      - name: Setup Node@${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: ${{ env.PNPM_VERSION }}
+          run_install: false
+
+      - run: pnpm install
+
+      - name: Start LocalStack
+        run: pnpm docker:start
+
+      - name: Start PostgreSQL
+        uses: CasperWA/postgresql-action@v1.2
+        with:
+          postgresql version: '14' # See https://hub.docker.com/_/postgres for available versions
+          postgresql db: ${{ env.POSTGRES_DB }}
+          postgresql user: ${{ env.POSTGRES_USER }}
+          postgresql password: ${{ env.POSTGRES_PASSWORD }}
+        if: startsWith(matrix.database, 'postgres')
+
+      - name: Install Supabase CLI
+        uses: supabase/setup-cli@v1
+        with:
+          version: latest
+        if: matrix.database == 'supabase'
+
+      - name: Initialize Supabase
+        run: |
+          supabase init
+          supabase start
+        if: matrix.database == 'supabase'
+
+      - name: Wait for PostgreSQL
+        run: sleep 30
+        if: startsWith(matrix.database, 'postgres')
+
+      - name: Configure PostgreSQL
+        run: |
+          psql "postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@localhost:5432/$POSTGRES_DB" -c "CREATE ROLE runner SUPERUSER LOGIN;"
+          psql "postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@localhost:5432/$POSTGRES_DB" -c "SELECT version();"
+          echo "POSTGRES_URL=postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@localhost:5432/$POSTGRES_DB" >> $GITHUB_ENV
+        if: startsWith(matrix.database, 'postgres')
+
+      - name: Configure PostgreSQL with custom schema
+        run: |
+          psql "postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@localhost:5432/$POSTGRES_DB" -c "CREATE SCHEMA custom;"
+        if: matrix.database == 'postgres-custom-schema'
+
+      - name: Configure Supabase
+        run: |
+          echo "POSTGRES_URL=postgresql://postgres:postgres@127.0.0.1:54322/postgres" >> $GITHUB_ENV
+        if: matrix.database == 'supabase'
+
+      - name: Integration Tests
+        run: pnpm test:int
+        env:
+          NODE_OPTIONS: --max-old-space-size=8096
+          PAYLOAD_DATABASE: ${{ matrix.database }}
+          POSTGRES_URL: ${{ env.POSTGRES_URL }}
+
+  tests-e2e:
+    runs-on: ubuntu-latest
+    needs: build
+    strategy:
+      fail-fast: false
+      matrix:
+        # find test -type f -name 'e2e.spec.ts' | sort | xargs dirname | xargs -I {} basename {}
+        suite:
+          - _community
+          - access-control
+          - admin__e2e__1
+          - admin__e2e__2
+          - admin-root
+          - auth
+          - field-error-states
+          - fields-relationship
+          - fields
+          - fields__collections__Blocks
+          - fields__collections__Array
+          - fields__collections__Relationship
+          - fields__collections__RichText
+          - fields__collections__Lexical__e2e__main
+          - fields__collections__Lexical__e2e__blocks
+          - fields__collections__Date
+          - fields__collections__Number
+          - fields__collections__Point
+          - fields__collections__Tabs
+          - fields__collections__Text
+          - fields__collections__Upload
+          - live-preview
+          - localization
+          - i18n
+          - plugin-cloud-storage
+          - plugin-form-builder
+          - plugin-nested-docs
+          - plugin-seo
+          - versions
+          - uploads
+    env:
+      SUITE_NAME: ${{ matrix.suite }}
+    steps:
+      # https://github.com/actions/virtual-environments/issues/1187
+      - name: tune linux network
+        run: sudo ethtool -K eth0 tx off rx off
+
+      - name: Setup Node@${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: ${{ env.PNPM_VERSION }}
+          run_install: false
+
+      - name: Restore build
+        uses: actions/cache@v4
+        timeout-minutes: 10
+        with:
+          path: ./*
+          key: ${{ github.sha }}-${{ github.run_number }}
+
+      - name: Start LocalStack
+        run: pnpm docker:start
+        if: ${{ matrix.suite == 'plugin-cloud-storage' }}
+
+      - name: Store Playwright's Version
+        run: |
+          # Extract the version number using a more targeted regex pattern with awk
+          PLAYWRIGHT_VERSION=$(pnpm ls @playwright/test --depth=0 | awk '/@playwright\/test/ {print $2}')
+          echo "Playwright's Version: $PLAYWRIGHT_VERSION"
+          echo "PLAYWRIGHT_VERSION=$PLAYWRIGHT_VERSION" >> $GITHUB_ENV
+
+      - name: Cache Playwright Browsers for Playwright's Version
+        id: cache-playwright-browsers
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/ms-playwright
+          key: playwright-browsers-${{ env.PLAYWRIGHT_VERSION }}
+
+      - name: Setup Playwright - Browsers and Dependencies
+        if: steps.cache-playwright-browsers.outputs.cache-hit != 'true'
+        run: pnpm exec playwright install --with-deps chromium
+
+      - name: Setup Playwright - Dependencies-only
+        if: steps.cache-playwright-browsers.outputs.cache-hit == 'true'
+        run: pnpm exec playwright install-deps chromium
+
+      - name: E2E Tests
+        run: PLAYWRIGHT_JSON_OUTPUT_NAME=results_${{ matrix.suite }}.json pnpm test:e2e:prod:ci ${{ matrix.suite }}
+        env:
+          PLAYWRIGHT_JSON_OUTPUT_NAME: results_${{ matrix.suite }}.json
+          NEXT_TELEMETRY_DISABLED: 1
+
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: test-results-${{ matrix.suite }}
+          path: test/test-results/
+          if-no-files-found: ignore
+          retention-days: 1
+
+      # Disabled until this is fixed: https://github.com/daun/playwright-report-summary/issues/156
+      # - uses: daun/playwright-report-summary@v3
+      #   with:
+      #     report-file: results_${{ matrix.suite }}.json
+      #     report-tag: ${{ matrix.suite }}
+      #     job-summary: true
+
+  app-build-with-packed:
+    if: false # Disable until package resolution in tgzs can be figured out
+    runs-on: ubuntu-latest
+    needs: build
+
+    steps:
+      # https://github.com/actions/virtual-environments/issues/1187
+      - name: tune linux network
+        run: sudo ethtool -K eth0 tx off rx off
+
+      - name: Setup Node@${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: ${{ env.PNPM_VERSION }}
+          run_install: false
+
+      - name: Restore build
+        uses: actions/cache@v4
+        timeout-minutes: 10
+        with:
+          path: ./*
+          key: ${{ github.sha }}-${{ github.run_number }}
+
+      - name: Start MongoDB
+        uses: supercharge/mongodb-github-action@1.11.0
+        with:
+          mongodb-version: 6.0
+
+      - name: Pack and build app
+        run: |
+          set -ex
+          pnpm run script:pack --dest templates/blank
+          cd templates/blank
+          cp .env.example .env
+          ls -la
+          pnpm add ./*.tgz --ignore-workspace
+          pnpm install --ignore-workspace --no-frozen-lockfile
+          cat package.json
+          pnpm run build
+
+  tests-type-generation:
+    runs-on: ubuntu-latest
+    needs: build
+
+    steps:
+      # https://github.com/actions/virtual-environments/issues/1187
+      - name: tune linux network
+        run: sudo ethtool -K eth0 tx off rx off
+
+      - name: Setup Node@${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: ${{ env.PNPM_VERSION }}
+          run_install: false
+
+      - name: Restore build
+        uses: actions/cache@v4
+        timeout-minutes: 10
+        with:
+          path: ./*
+          key: ${{ github.sha }}-${{ github.run_number }}
+
+      - name: Generate Payload Types
+        run: pnpm dev:generate-types fields
+
+      - name: Generate GraphQL schema file
+        run: pnpm dev:generate-graphql-schema graphql-schema-gen
+
+  templates:
+    needs: changes
+    if: false # Disable until templates are updated for 3.0
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        template: [blank, website, ecommerce]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 25
+      # https://github.com/actions/virtual-environments/issues/1187
+      - name: tune linux network
+        run: sudo ethtool -K eth0 tx off rx off
+
+      - name: Setup Node@${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Start MongoDB
+        uses: supercharge/mongodb-github-action@1.11.0
+        with:
+          mongodb-version: 6.0
+
+      - name: Build Template
+        run: |
+          cd templates/${{ matrix.template }}
+          cp .env.example .env
+          yarn install
+          yarn build
+          yarn generate:types
+
+  generated-templates:
+    needs: build
+    if: false # Needs to pull in tgz files from build
+    runs-on: ubuntu-latest
+
+    steps:
+      # https://github.com/actions/virtual-environments/issues/1187
+      - name: tune linux network
+        run: sudo ethtool -K eth0 tx off rx off
+
+      - name: Setup Node@${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: ${{ env.PNPM_VERSION }}
+          run_install: false
+
+      - name: Restore build
+        uses: actions/cache@v4
+        timeout-minutes: 10
+        with:
+          path: ./*
+          key: ${{ github.sha }}-${{ github.run_number }}
+
+      - name: Build all generated templates
+        run: pnpm tsx ./scripts/build-generated-templates.ts
+
+  all-green:
+    name: All Green
+    if: always()
+    runs-on: ubuntu-latest
+    needs:
+      - lint
+      - build
+      - tests-unit
+      - tests-int
+      - tests-e2e
+
+    steps:
+      - if: ${{ always() && (contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')) }}
+        run: exit 1
+
+  publish-canary:
+    name: Publish Canary
+    runs-on: ubuntu-latest
+    needs:
+      - all-green
+
+    steps:
+      # debug github.ref output
+      - run: |
+          echo github.ref: ${{ github.ref }}
+          echo isBeta: ${{ github.ref == 'refs/heads/beta' }}
+          echo isMain: ${{ github.ref == 'refs/heads/main' }}

.github/workflows/pr-title.yml

@@ -0,0 +1,121 @@
+name: pr-title
+
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+permissions:
+  pull-requests: write
+
+jobs:
+  main:
+    name: lint-pr-title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        id: lint_pr_title
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          types: |
+            build
+            chore
+            ci
+            docs
+            feat
+            fix
+            perf
+            refactor
+            revert
+            style
+            test
+            types
+          scopes: |
+            cpa
+            db-\*
+            db-mongodb
+            db-postgres
+            db-sqlite
+            drizzle
+            email-nodemailer
+            eslint
+            graphql
+            live-preview
+            live-preview-react
+            next
+            payload
+            plugin-cloud
+            plugin-cloud-storage
+            plugin-form-builder
+            plugin-nested-docs
+            plugin-redirects
+            plugin-relationship-object-ids
+            plugin-search
+            plugin-sentry
+            plugin-seo
+            plugin-stripe
+            richtext-\*
+            richtext-lexical
+            richtext-slate
+            storage-\*
+            storage-azure
+            storage-gcs
+            storage-vercel-blob
+            storage-s3
+            translations
+            ui
+            templates
+            examples(\/(\w|-)+)?
+            deps
+
+          # Disallow uppercase letters at the beginning of the subject
+          subjectPattern: ^(?![A-Z]).+$
+          subjectPatternError: |
+            The subject "{subject}" found in the pull request title "{title}"
+            didn't match the configured pattern. Please ensure that the subject
+            doesn't start with an uppercase character.
+
+      - uses: marocchino/sticky-pull-request-comment@v2
+        # When the previous steps fails, the workflow would stop. By adding this
+        # condition you can continue the execution with the populated error message.
+        if: always() && (steps.lint_pr_title.outputs.error_message != null)
+        with:
+          header: pr-title-lint-error
+          message: |
+            Pull Request titles must follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and have valid scopes.
+
+            ${{ steps.lint_pr_title.outputs.error_message }}
+
+            ```
+            feat(ui): add Button component
+            ^    ^    ^
+            |    |    |__ Subject
+            |    |_______ Scope
+            |____________ Type
+            ```
+
+      # Delete a previous comment when the issue has been resolved
+      - if: ${{ steps.lint_pr_title.outputs.error_message == null }}
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          header: pr-title-lint-error
+          delete: true
+
+  label-pr-on-open:
+    name: label-pr-on-open
+    runs-on: ubuntu-latest
+    if: github.event.action == 'opened'
+    steps:
+      - name: Tag with main branch with v2
+        if: github.event.pull_request.base.ref == 'main'
+        uses: actions-ecosystem/action-add-labels@v1
+        with:
+          labels: v2
+      - name: Tag with beta branch with v3
+        if: github.event.pull_request.base.ref == 'beta'
+        uses: actions-ecosystem/action-add-labels@v1
+        with:
+          labels: v3

.github/workflows/release-canary.yml

@@ -0,0 +1,36 @@
+name: release-canary
+
+on:
+  workflow_dispatch:
+    branches:
+      - beta
+
+env:
+  NODE_VERSION: 22.6.0
+  PNPM_VERSION: 9.7.1
+  DO_NOT_TRACK: 1 # Disable Turbopack telemetry
+  NEXT_TELEMETRY_DISABLED: 1 # Disable Next telemetry
+
+jobs:
+  release:
+    permissions:
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          pnpm-version: ${{ env.PNPM_VERSION }}
+      - name: Load npm token
+        run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Canary release script
+        # dry run hard-coded to true for testing and no npm token provided
+        run: pnpm tsx ./scripts/publish-canary.ts
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_CONFIG_PROVENANCE: true

.gitignore

@@ -1,6 +1,36 @@
+coverage
+package-lock.json
+dist
+/.idea/*
+!/.idea/runConfigurations
+!/.idea/payload.iml
 
-# Created by https://www.toptal.com/developers/gitignore/api/node,macos,vscode,windows
-# Edit at https://www.toptal.com/developers/gitignore?templates=node,macos,vscode,windows
+test/packed
+test-results
+.devcontainer
+.localstack
+/migrations
+.localstack
+.turbo
+
+meta_client.json
+meta_server.json
+meta_index.json
+meta_shared.json
+
+.turbo
+
+# Ignore test directory media folder/files
+/media
+test/media
+*payloadtests.db
+*payloadtests.db-journal
+*payloadtests.db-shm
+*payloadtests.db-wal
+/versions
+
+# Created by https://www.toptal.com/developers/gitignore/api/node,macos,windows,webstorm,sublimetext,visualstudiocode
+# Edit at https://www.toptal.com/developers/gitignore?templates=node,macos,windows,webstorm,sublimetext,visualstudiocode
 
 ### macOS ###
 # General
@@ -8,9 +38,6 @@
 .AppleDouble
 .LSOverride
 
-# Icon must end with two \r
-Icon
-
 # Thumbnails
 ._*
 
@@ -30,6 +57,10 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
 ### Node ###
 # Logs
 logs
@@ -38,6 +69,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
+.pnpm-debug.log*
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
@@ -74,8 +106,8 @@ build/Release
 node_modules/
 jspm_packages/
 
-
-# TypeScript v1 declaration files
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
 
 # TypeScript cache
 *.tsbuildinfo
@@ -86,6 +118,9 @@ typings/
 # Optional eslint cache
 .eslintcache
 
+# Optional stylelint cache
+.stylelintcache
+
 # Microbundle cache
 .rpt2_cache/
 .rts2_cache_cjs/
@@ -101,10 +136,12 @@ typings/
 # Yarn Integrity file
 .yarn-integrity
 
-
+# dotenv environment variable files
 .env
-.env
-.env.test
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache
@@ -112,10 +149,12 @@ typings/
 
 # Next.js build output
 .next
+out
 
 # Nuxt.js build / generate output
 .nuxt
 dist
+dist_optimized
 
 # Gatsby files
 .cache/
@@ -126,6 +165,12 @@ dist
 # vuepress build output
 .vuepress/dist
 
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
 # Serverless directories
 .serverless/
 
@@ -141,13 +186,91 @@ dist
 # Stores VSCode versions used for testing VSCode extensions
 .vscode-test
 
-
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
+### SublimeText ###
+# Cache files for Sublime Text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# Workspace files are user-specific
+*.sublime-workspace
+
+# Project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using Sublime Text
+# *.sublime-project
+
+# SFTP configuration file
+sftp-config.json
+sftp-config-alt*.json
+
+# Package control specific files
+Package Control.last-run
+Package Control.ca-list
+Package Control.ca-bundle
+Package Control.system-ca-bundle
+Package Control.cache/
+Package Control.ca-certs/
+Package Control.merged-ca-bundle
+Package Control.user-ca-bundle
+oscrypto-ca-bundle.crt
+bh_unicode_properties.cache
+
+# Sublime-github package stores a github token in this file
+# https://packagecontrol.io/packages/sublime-github
+GitHub.sublime-settings
+
+### VisualStudioCode ###
 .vscode/*
 !.vscode/settings.json
 !.vscode/tasks.json
 !.vscode/launch.json
 !.vscode/extensions.json
-!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# CMake
+cmake-build-*/
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
 
 ### Windows ###
 # Windows thumbnail cache files
@@ -175,4 +298,15 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
-
+# End of https://www.toptal.com/developers/gitignore/api/node,macos,windows,webstorm,sublimetext,visualstudiocode
+
+/build
+.swc
+app/(payload)/admin/importMap.js
+test/live-preview/app/(payload)/admin/importMap.js
+/test/live-preview/app/(payload)/admin/importMap.js
+test/admin-root/app/(payload)/admin/importMap.js
+/test/admin-root/app/(payload)/admin/importMap.js
+test/app/(payload)/admin/importMap.js
+/test/app/(payload)/admin/importMap.js
+test/pnpm-lock.yaml

.husky/pre-commit

@@ -0,0 +1 @@
+pnpm run lint-staged --quiet

.idea/payload.iml

@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/payload/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/payload/components" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/payload/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/.swc" />
+      <excludeFolder url="file://$MODULE_DIR$/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/examples" />
+      <excludeFolder url="file://$MODULE_DIR$/media" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/create-payload-app/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/create-payload-app/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/db-mongodb/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/db-mongodb/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/db-postgres/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/db-postgres/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/graphql/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/graphql/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview-react/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview-react/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/next/.swc" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/next/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/next/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/payload/fields" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-cloud-storage/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-cloud-storage/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-cloud/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-cloud/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-form-builder/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-nested-docs/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-nested-docs/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-redirects/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-redirects/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-search/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-search/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-sentry/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-seo/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-seo/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-stripe/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/richtext-lexical/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/richtext-lexical/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/templates" />
+      <excludeFolder url="file://$MODULE_DIR$/test/.swc" />
+      <excludeFolder url="file://$MODULE_DIR$/versions" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/richtext-slate/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/richtext-slate/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/email-nodemailer/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/email-nodemailer/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/email-resend/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/email-resend/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview-vue/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview-vue/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/payload/.swc" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-form-builder/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-relationship-object-ids/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-relationship-object-ids/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-stripe/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/storage-azure/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/storage-azure/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/storage-gcs/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/storage-gcs/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/storage-s3/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/storage-s3/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/storage-uploadthing/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/storage-uploadthing/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/storage-vercel-blob/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/storage-vercel-blob/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/translations/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/translations/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/ui/.swc" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/ui/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/ui/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/drizzle/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/drizzle/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/db-sqlite/.turbo" />
+      <excludeFolder url="file://$MODULE_DIR$/packages/db-sqlite/dist" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

.idea/runConfigurations/Run_Dev_Fields.xml

@@ -0,0 +1,13 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run Dev Fields" type="js.build_tools.npm">
+    <package-json value="$PROJECT_DIR$/package.json" />
+    <command value="run" />
+    <scripts>
+      <script value="dev" />
+    </scripts>
+    <arguments value="fields" />
+    <node-interpreter value="project" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

.idea/runConfigurations/Run_Dev__community.xml

@@ -0,0 +1,13 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run Dev _community" type="js.build_tools.npm">
+    <package-json value="$PROJECT_DIR$/package.json" />
+    <command value="run" />
+    <scripts>
+      <script value="dev" />
+    </scripts>
+    <arguments value="_community" />
+    <node-interpreter value="project" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

.idea/runConfigurations/Run_Dev_admin.xml

@@ -0,0 +1,13 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run Dev admin" type="js.build_tools.npm">
+    <package-json value="$PROJECT_DIR$/package.json" />
+    <command value="run" />
+    <scripts>
+      <script value="dev" />
+    </scripts>
+    <arguments value="admin" />
+    <node-interpreter value="project" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

.idea/runConfigurations/_template__of_JavaScriptTestRunnerJest.xml

@@ -0,0 +1,9 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="true" type="JavaScriptTestRunnerJest">
+    <node-interpreter value="project" />
+    <node-options value="--no-deprecation" />
+    <envs />
+    <scope-kind value="ALL" />
+    <method v="2" />
+  </configuration>
+</component>

.node-version

@@ -0,0 +1 @@
+v22.6.0

.npmrc

@@ -0,0 +1,3 @@
+symlink=true
+node-linker=isolated
+hoist-workspace-packages=false # the default in pnpm v9 is true, but that can break our runtime dependency checks

.nvmrc

@@ -0,0 +1 @@
+v22.6.0

.prettierignore

@@ -0,0 +1,16 @@
+.tmp
+**/.git
+**/.hg
+**/.pnp.*
+**/.svn
+**/.yarn/**
+**/build
+**/dist/**
+**/node_modules
+**/temp
+**/docs/**
+tsconfig.json
+packages/payload/*.js
+packages/payload/*.d.ts
+payload-types.ts
+tsconfig.tsbuildinfo

.prettierrc.js

@@ -1,8 +0,0 @@
-module.exports = {
-  printWidth: 85,
-  parser: 'typescript',
-  semi: false,
-  singleQuote: true,
-  trailingComma: 'all',
-  arrowParens: 'avoid',
-}

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 100,
+  "semi": false
+}

.swcrc

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json.schemastore.org/swcrc",
+  "sourceMaps": "inline",
+  "jsc": {
+    "target": "esnext",
+    "parser": {
+      "syntax": "typescript",
+      "tsx": true,
+      "dts": true
+    },
+    "transform": {
+      "react": {
+        "runtime": "automatic",
+        "pragmaFrag": "React.Fragment",
+        "throwIfNamespace": true,
+        "development": false,
+        "useBuiltins": true
+      }
+    }
+  },
+  "module": {
+    "type": "es6"
+  }
+}

.tool-versions

@@ -0,0 +1,2 @@
+pnpm 9.7.1
+nodejs 22.6.0

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "esbenp.prettier-vscode",
+    "firsttris.vscode-jest-runner",
+    "ms-playwright.playwright"
+  ]
+}

.vscode/launch.json

@@ -3,11 +3,239 @@
   // Hover to view descriptions of existing attributes.
   "configurations": [
     {
-      "command": "ts-node -T ./src/index.ts -n asdf -t blank --db mongodb --no-deps",
+      "command": "pnpm generate:types",
+      "name": "Generate Types CLI",
+      "request": "launch",
+      "type": "node-terminal",
+      "cwd": "${workspaceFolder}"
+    },
+    {
+      "command": "node --no-deprecation test/dev.js _community",
       "cwd": "${workspaceFolder}",
-      "name": "Debug",
+      "name": "Run Dev Community",
       "request": "launch",
       "type": "node-terminal"
     },
-  ]
+    {
+      "command": "node --no-deprecation test/dev.js storage-uploadthing",
+      "cwd": "${workspaceFolder}",
+      "name": "Uploadthing",
+      "request": "launch",
+      "type": "node-terminal",
+      "envFile": "${workspaceFolder}/test/storage-uploadthing/.env"
+    },
+    {
+      "command": "node --no-deprecation test/dev.js live-preview",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Live Preview",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "node --no-deprecation test/loader/init.js",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Loader",
+      "request": "launch",
+      "type": "node-terminal",
+      "env": {
+        "LOADER_TEST_FILE_PATH": "./dependency-test.js"
+        // "LOADER_TEST_FILE_PATH": "../fields/config.ts"
+      }
+    },
+    {
+      "command": "node --no-deprecation test/dev.js admin",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Admin",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "node --no-deprecation test/dev.js auth",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Auth",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "node --no-deprecation test/dev.js fields-relationship",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Fields-Relationship",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "node --no-deprecation test/dev.js login-with-username",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Login-With-Username",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "pnpm run dev plugin-cloud-storage",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev - plugin-cloud-storage",
+      "request": "launch",
+      "type": "node-terminal",
+      "env": {
+        "PAYLOAD_PUBLIC_CLOUD_STORAGE_ADAPTER": "s3"
+      }
+    },
+    {
+      "command": "node --no-deprecation test/dev.js collections-graphql",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev GraphQL",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "node --no-deprecation test/dev.js fields",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Fields",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "node --no-deprecation test/dev.js versions",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Postgres",
+      "request": "launch",
+      "type": "node-terminal",
+      "env": {
+        "PAYLOAD_DATABASE": "postgres"
+      }
+    },
+    {
+      "command": "node --no-deprecation test/dev.js versions",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Versions",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "node --no-deprecation test/dev.js localization",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Localization",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "node --no-deprecation test/dev.js uploads",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Uploads",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "node --no-deprecation test/dev.js field-error-states",
+      "cwd": "${workspaceFolder}",
+      "name": "Run Dev Field Error States",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "pnpm run test:int live-preview",
+      "cwd": "${workspaceFolder}",
+      "name": "Live Preview Int Tests",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "pnpm run test:int plugin-search",
+      "cwd": "${workspaceFolder}",
+      "name": "Search Plugin Int Tests",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "ts-node ./packages/payload/src/bin/index.ts build",
+      "env": {
+        "PAYLOAD_CONFIG_PATH": "test/fields/config.ts",
+        "PAYLOAD_BUNDLER": "vite",
+        "DISABLE_SWC": "true" // SWC messes up debugging the bin scripts
+      },
+      "name": "Build CLI - Vite",
+      "outputCapture": "std",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "ts-node ./packages/payload/src/bin/index.ts build",
+      "env": {
+        "PAYLOAD_CONFIG_PATH": "test/fields/config.ts",
+        "PAYLOAD_ANALYZE_BUNDLE": "true",
+        "DISABLE_SWC": "true" // SWC messes up debugging the bin scripts
+      },
+      "name": "Build CLI - Webpack",
+      "outputCapture": "std",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "ts-node ./packages/payload/src/bin/index.ts migrate:status",
+      "env": {
+        "PAYLOAD_CONFIG_PATH": "test/migrations-cli/config.ts",
+        "PAYLOAD_DATABASE": "postgres",
+        "DISABLE_SWC": "true" // SWC messes up debugging the bin scripts
+        // "PAYLOAD_DROP_DATABASE": "true",
+      },
+      "name": "Migrate CLI - status",
+      "outputCapture": "std",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "ts-node ./packages/payload/src/bin/index.ts migrate:create yass",
+      "env": {
+        "PAYLOAD_CONFIG_PATH": "test/migrations-cli/config.ts",
+        "PAYLOAD_DATABASE": "postgres",
+        "DISABLE_SWC": "true" // SWC messes up debugging the bin scripts
+        // "PAYLOAD_DROP_DATABASE": "true",
+      },
+      "name": "Migrate CLI - create",
+      "outputCapture": "std",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "ts-node ./packages/payload/src/bin/index.ts migrate:down",
+      "env": {
+        "PAYLOAD_CONFIG_PATH": "test/migrations-cli/config.ts",
+        "PAYLOAD_DATABASE": "mongoose",
+        "DISABLE_SWC": "true" // SWC messes up debugging the bin scripts
+        // "PAYLOAD_DROP_DATABASE": "true",
+      },
+      "name": "Migrate CLI - down",
+      "outputCapture": "std",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "ts-node ./packages/payload/src/bin/index.ts migrate:reset",
+      "env": {
+        "PAYLOAD_CONFIG_PATH": "test/migrations-cli/config.ts",
+        "PAYLOAD_DATABASE": "mongoose",
+        "DISABLE_SWC": "true" // SWC messes up debugging the bin scripts
+        // "PAYLOAD_DROP_DATABASE": "true",
+      },
+      "name": "Migrate CLI - reset",
+      "outputCapture": "std",
+      "request": "launch",
+      "type": "node-terminal"
+    },
+    {
+      "command": "ts-node ./packages/payload/src/bin/index.ts migrate:refresh",
+      "env": {
+        "PAYLOAD_CONFIG_PATH": "test/migrations-cli/config.ts",
+        "PAYLOAD_DATABASE": "mongoose",
+        "DISABLE_SWC": "true" // SWC messes up debugging the bin scripts
+        // "PAYLOAD_DROP_DATABASE": "true",
+      },
+      "name": "Migrate CLI - refresh",
+      "outputCapture": "std",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ],
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0"
 }

.vscode/settings.json

@@ -0,0 +1,56 @@
+{
+  "npm.packageManager": "pnpm",
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": "explicit"
+    }
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": "explicit"
+    }
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": "explicit"
+    }
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "editor.formatOnSaveMode": "file",
+  "eslint.rules.customizations": [
+    // Defaultt all ESLint errors to 'warn' to differentate from TypeScript's 'error' level
+    { "rule": "*", "severity": "warn" },
+
+    // Silence some warnings that will get auto-fixed
+    { "rule": "perfectionist/*", "severity": "off", "fixable": true },
+    { "rule": "curly", "severity": "off", "fixable": true },
+    { "rule": "object-shorthand", "severity": "off", "fixable": true }
+  ],
+  "typescript.tsdk": "node_modules/typescript/lib",
+  // Load .git-blame-ignore-revs file
+  "gitlens.advanced.blame.customArguments": ["--ignore-revs-file", ".git-blame-ignore-revs"],
+  "[javascript][typescript][typescriptreact]": {
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": "explicit"
+    }
+  },
+  "files.insertFinalNewline": true,
+  "jestrunner.jestCommand": "pnpm exec cross-env NODE_OPTIONS=\"--no-deprecation\" node 'node_modules/jest/bin/jest.js'",
+  "jestrunner.debugOptions": {
+    "runtimeArgs": ["--no-deprecation"]
+  }
+}

CONTRIBUTING.md

@@ -0,0 +1,124 @@
+# Contributing to Payload
+
+Below you'll find a set of guidelines for how to contribute to Payload.
+
+## Opening issues
+
+Before you submit an issue, please check all existing [open and closed issues](https://github.com/payloadcms/payload/issues) to see if your issue has previously been resolved or is already known. If there is already an issue logged, feel free to upvote it by adding a :thumbsup: [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). If you would like to submit a new issue, please fill out our Issue Template to the best of your ability so we can accurately understand your report.
+
+## Security issues & vulnerabilities
+
+If you come across an issue related to security, or a potential attack vector within Payload or one of its dependencies, please DO NOT create a publicly viewable issue. Instead, please contact us directly at [`dev@payloadcms.com`](mailto:dev@payloadcms.com). We will do everything we can to respond to the issue as soon as possible.
+
+If you find a vulnerability within the core Payload repository, and we determine that it is remediable and of significant nature, we will be happy to pay you a reward for your findings and diligence. [`Contact us`](mailto:dev@payloadcms.com) to find out more.
+
+## Documentation edits
+
+Payload documentation can be found directly within its codebase, and you can feel free to make changes / improvements to any of it through opening a PR. We utilize these files directly in our website and will periodically deploy documentation updates as necessary.
+
+## Building additional features
+
+If you're an incredibly awesome person and want to help us make Payload even better through new features or additions, we would be thrilled to work with you.
+
+## Design Contributions
+
+When it comes to design-related changes or additions, it's crucial for us to ensure a cohesive user experience and alignment with our broader design vision. Before embarking on any implementation that would affect the design or UI/UX, we ask that you **first share your design proposal** with us for review and approval.
+
+Our design review ensures that proposed changes fit seamlessly with other components, both existing and planned. This step is meant to prevent unintentional design inconsistencies and to save you from investing time in implementing features that might need significant design alterations later.
+
+### Before Starting
+
+To help us work on new features, you can create a new feature request post in [GitHub Discussion](https://github.com/payloadcms/payload/discussions) or discuss it in our [Discord](https://discord.com/invite/payload). New functionality often has large implications across the entire Payload repo, so it is best to discuss the architecture and approach before starting work on a pull request.
+
+### Installation & Requirements
+
+Payload is structured as a Monorepo, encompassing not only the core Payload platform but also various plugins and packages. To install all required dependencies, you have to run `pnpm install` once in the root directory. **PNPM IS REQUIRED!** Yarn or npm will not work - you will have to use pnpm to develop in the core repository. In most systems, the easiest way to install pnpm is to run `corepack enable` in your terminal.
+
+If you're coming from a very outdated version of payload, it is recommended to nuke the node_modules folder before running pnpm install. On UNIX systems, you can easily do that using the `pnpm clean:unix` command, which will delete all node_modules folders and build artefacts.
+
+It is also recommended to use at least Node v18 or higher. You can check your current node version by typing `node --version` in your terminal. The easiest way to switch between different node versions is to use [nvm](https://github.com/nvm-sh/nvm#intro).
+
+### Code
+
+Most new functionality should keep testing in mind. All top-level directories within the `test/` directory are for testing a specific category: `fields`, `collections`, etc.
+
+If it makes sense to add your feature to an existing test directory, please do so.
+
+A typical directory with `test/` will be structured like this:
+
+```text
+.
+├── config.ts
+├── int.spec.ts
+├── e2e.spec.ts
+└── payload-types.ts
+```
+
+- `config.ts` - This is the _granular_ Payload config for testing. It should be as lightweight as possible. Reference existing configs for an example
+- `int.spec.ts` - This is the test file run by jest. Any test file must have a `*int.spec.ts` suffix.
+- `e2e.spec.ts` - This is the end-to-end test file that will load up the admin UI using the above config and run Playwright tests. These tests are typically only needed if a large change is being made to the Admin UI.
+- `payload-types.ts` - Generated types from `config.ts`. Generate this file by running `pnpm dev:generate-types my-test-dir`. Replace `my-test-dir` with the name of your testing directory.
+
+Each test directory is split up in this way specifically to reduce friction when creating tests and to add the ability to boot up Payload with that specific config.
+
+The following command will start Payload with your config: `pnpm dev my-test-dir`. Example: `pnpm dev fields` for the test/`fields` test suite. This command will start up Payload using your config and refresh a test database on every restart. If you're using VS Code, the most common run configs are automatically added to your editor - you should be able to find them in your VS Code launch tab.
+
+By default, payload will [automatically log you in](https://payloadcms.com/docs/authentication/overview#admin-autologin) with the default credentials. To disable that, you can either pass in the --no-auto-login flag (example: `pnpm dev my-test-dir --no-auto-login`) or set the `PAYLOAD_PUBLIC_DISABLE_AUTO_LOGIN` environment variable to `false`.
+
+The default credentials are `dev@payloadcms.com` as E-Mail and `test` as password. These are used in the auto-login.
+
+### Testing with your own MongoDB database
+
+If you wish to use your own MongoDB database for the `test` directory instead of using the in memory database, all you need to do is add the following env vars to the `test/dev.ts` file:
+
+- `process.env.NODE_ENV`
+- `process.env.PAYLOAD_TEST_MONGO_URL`
+- Simply set `process.env.NODE_ENV` to `test` and set `process.env.PAYLOAD_TEST_MONGO_URL` to your MongoDB URL e.g. `mongodb://127.0.0.1/your-test-db`.
+
+### Using Postgres
+
+If you have postgres installed on your system, you can also run the test suites using postgres. By default, mongodb is used.
+
+To do that, simply set the `PAYLOAD_DATABASE` environment variable to `postgres`.
+
+### Running the e2e and int tests
+
+You can run the entire test suite using `pnpm test`. If you wish to only run e2e tests, you can use `pnpm test:e2e`. If you wish to only run int tests, you can use `pnpm test:int`.
+
+By default, `pnpm test:int` will only run int test against MongoDB. To run int tests against postgres, you can use `pnpm test:int:postgres`. You will have to have postgres installed on your system for this to work.
+
+### Commits
+
+We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for our commit messages. Please follow this format when creating commits. Here are some examples:
+
+- `feat: adds new feature`
+- `fix: fixes bug`
+- `docs: adds documentation`
+- `chore: does chore`
+
+Here's a breakdown of the format. At the top-level, we use the following types to categorize our commits:
+
+- `feat`: new feature that adds functionality. These are automatically added to the changelog when creating new releases.
+- `fix`: a fix to an existing feature. These are automatically added to the changelog when creating new releases.
+- `docs`: changes to [docs](./docs) only. These do not appear in the changelog.
+- `chore`: changes to code that is neither a fix nor a feature (e.g. refactoring, adding tests, etc.). These do not appear in the changelog.
+
+If you are committing to [templates](./templates) or [examples](./examples), use the `chore` type with the proper scope, like this:
+
+- `chore(templates): adds feature to template`
+- `chore(examples): fixes bug in example`
+
+## Pull Requests
+
+For all Pull Requests, you should be extremely descriptive about both your problem and proposed solution. If there are any affected open or closed issues, please leave the issue number in your PR message.
+
+## Previewing docs
+
+This is how you can preview changes you made locally to the docs:
+
+1. Clone our [website repository](https://github.com/payloadcms/website)
+2. Run `yarn install`
+3. Duplicate the `.env.example` file and rename it to `.env`
+4. Add a `DOCS_DIR` environment variable to the `.env` file which points to the absolute path of your modified docs folder. For example `DOCS_DIR=/Users/yourname/Documents/GitHub/payload/docs`
+5. Run `yarn run fetchDocs:local`. If this was successful, you should see no error messages and the following output: _Docs successfully written to /.../website/src/app/docs.json_. There could be error messages if you have incorrect markdown in your local docs folder. In this case, it will tell you how you can fix it
+6. You're done! Now you can start the website locally using `yarn run dev` and preview the docs under [http://localhost:3000/docs/](http://localhost:3000/docs/)

ISSUE_GUIDE.md

@@ -0,0 +1,69 @@
+# Reporting an issue
+
+To report an issue, please follow the steps below:
+
+1. Fork this repository
+2. Add necessary collections/globals/fields to the `test/_community` directory to recreate the issue you are experiencing
+3. Create an issue and add a link to your forked repo
+
+**The goal is to isolate the problem by reducing the number of fields/collections you add to the test/\_community folder. This folder is not meant for you to copy your project into, but to recreate the issue you are experiencing with minimal config.**
+
+## Test directory file tree explanation
+
+```text
+.
+├── config.ts
+├── int.spec.ts
+├── e2e.spec.ts
+└── payload-types.ts
+```
+
+- `config.ts` - This is the _granular_ Payload config for testing. It should be as lightweight as possible. Reference existing configs for an example
+- `int.spec.ts` [Optional] - This is the test file run by jest. Any test file must have a `*int.spec.ts` suffix.
+- `e2e.spec.ts` [Optional] - This is the end-to-end test file that will load up the admin UI using the above config and run Playwright tests.
+- `payload-types.ts` - Generated types from `config.ts`. Generate this file by running `pnpm dev:generate-types _community`.
+
+The directory split up in this way specifically to reduce friction when creating tests and to add the ability to boot up Payload with that specific config. You should modify the files in `test/_community` to get started.
+
+## How to start test collection admin UI
+
+To start the admin panel so you can manually recreate your issue, you can run the following command:
+
+```bash
+# This command will start up Payload using your config
+# NOTE: it will wipe the test database on restart
+pnpm dev _community
+```
+
+## Testing is optional but encouraged
+
+An issue does not need to have failing tests — reproduction steps with your forked repo are enough at this point. Some people like to dive deeper and we want to give you the guidance/tools to do so. Read more below.
+
+### How to run integration tests (Payload API tests)
+
+There are a couple ways to do this:
+
+- **Granularly** - you can run individual tests in vscode by installing the Jest Runner plugin and using that to run individual tests. Clicking the `debug` button will run the test in debug mode allowing you to set break points.
+
+  <img src="https://raw.githubusercontent.com/payloadcms/payload/main/src/admin/assets/images/github/int-debug.png" />
+
+- **Manually** - you can run all int tests in the `/test/_community/int.spec.ts` file by running the following command:
+
+  ```bash
+  pnpm test:int _community
+  ```
+
+### How to run E2E tests (Admin Panel UI tests)
+
+The easiest way to run E2E tests is to install
+
+- [Playwright Test for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright)
+- [Playwright Runner](https://marketplace.visualstudio.com/items?itemName=ortoni.ortoni)
+
+Once they are installed you can open the `testing` tab in vscode sidebar and drill down to the test you want to run, i.e. `/test/_community/e2e.spec.ts`
+
+<img src="https://raw.githubusercontent.com/payloadcms/payload/main/src/admin/assets/images/github/e2e-debug.png" />
+
+#### Notes
+
+- It is recommended to add the test credentials (located in `test/credentials.ts`) to your autofill for `localhost:3000/admin` as this will be required on every nodemon restart. The default credentials are `dev@payloadcms.com` as email and `test` as password.

README.md

@@ -1,34 +1,129 @@
-# Create Payload App
+<a href="https://payloadcms.com"><img width="100%" src="https://github.com/payloadcms/payload/blob/main/packages/payload/src/admin/assets/images/github-banner-alt.jpg?raw=true" alt="Payload headless CMS Admin panel built with React" /></a>
+<br />
+<br />
 
-CLI for easily starting new Payload project
+<p align="left">
+  <a href="https://github.com/payloadcms/payload/actions"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/payloadcms/payload/main.yml?style=flat-square"></a>
+  &nbsp;
+  <a href="https://discord.gg/payload"><img alt="Discord" src="https://img.shields.io/discord/967097582721572934?label=Discord&color=7289da&style=flat-square" /></a>
+  &nbsp;
+  <a href="https://www.npmjs.com/package/payload"><img alt="npm" src="https://img.shields.io/npm/v/payload?style=flat-square" /></a>
+  &nbsp;
+  <a href="https://twitter.com/payloadcms"><img src="https://img.shields.io/badge/follow-payloadcms-1DA1F2?logo=twitter&style=flat-square" alt="Payload Twitter" /></a>
+</p>
+<hr/>
+<h4>
+<a target="_blank" href="https://payloadcms.com/docs/getting-started/what-is-payload" rel="dofollow"><strong>Explore the Docs</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://payloadcms.com/community-help" rel="dofollow"><strong>Community Help</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://demo.payloadcms.com/" rel="dofollow"><strong>Try Live Demo</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://github.com/payloadcms/payload/discussions/1539" rel="dofollow"><strong>Roadmap</strong></a>&nbsp;·&nbsp;<a target="_blank" href="https://www.g2.com/products/payload-cms/reviews#reviews" rel="dofollow"><strong>View G2 Reviews</strong></a>
+</h4>
+<hr/>
 
-## Usage
+> [!IMPORTANT]
+> 🎉 <strong>Payload 2.0 is now available!</strong> Read more in the <a target="_blank" href="https://payloadcms.com/blog/payload-2-0" rel="dofollow"><strong>announcement post</strong></a>.
+
+<h3>Benefits over a regular CMS</h3>
+<ul>
+  <li>Don’t hit some third-party SaaS API, hit your own API</li>
+  <li>Use your own database and own your data</li>
+  <li>It's just Express - do what you want outside of Payload</li>
+  <li>No need to learn how Payload works - if you know JS, you know Payload</li>
+  <li>No vendor lock-in</li>
+  <li>Avoid microservices hell - get everything (even auth) in one place</li>
+  <li>Never touch ancient WP code again</li>
+  <li>Build faster, never hit a roadblock</li>
+  <li>Both admin and backend are 100% extensible</li>
+</ul>
+
+## ☁️ Deploy instantly with Payload Cloud.
+
+Create a cloud account, connect your GitHub, and [deploy in minutes](https://payloadcms.com/new).
+
+## 🚀 Get started by self-hosting completely free, forever.
+
+Before beginning to work with Payload, make sure you have all of the [required software](https://payloadcms.com/docs/getting-started/installation).
 
 ```text
-
-  USAGE
-
-      $ npx create-payload-app
-      $ npx create-payload-app my-project
-      $ npx create-payload-app -n my-project -t blog
-
-  OPTIONS
-
-      -n     my-payload-app         Set project name
-      -t     template_name          Choose specific template
-
-        Available templates:
-
-        blank                       Blank Template
-        website                     Website Template
-        ecommerce                   E-commerce Template
-        plugin                      Template for creating a Payload plugin
-        payload-demo                Payload demo site at https://demo.payloadcms.com
-        payload-website             Payload website CMS at https://payloadcms.com
-
-      --use-npm                     Use npm to install dependencies
-      --use-yarn                    Use yarn to install dependencies
-      --use-pnpm                    Use pnpm to install dependencies
-      --no-deps                     Do not install any dependencies
-      -h                            Show help
+npx create-payload-app@latest
 ```
+
+Alternatively, it only takes about five minutes to [create an app from scratch](https://payloadcms.com/docs/getting-started/installation#from-scratch).
+
+## 🖱️ 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.
+
+### [🛒 E-Commerce](https://github.com/payloadcms/payload/tree/main/templates/ecommerce)
+
+Eliminate the need to combine Shopify and a CMS, and instead do it all with Payload + Stripe. Comes with a beautiful, fully functional front-end complete with shopping cart, checkout, orders, and much more.
+
+### [🌐 Website](https://github.com/payloadcms/payload/tree/main/templates/website)
+
+Build any kind of website, blog, or portfolio from small to enterprise. Comes with a beautiful, fully functional front-end complete with posts, projects, comments, and much more.
+
+We're constantly adding more templates to our [Templates Directory](https://github.com/payloadcms/payload/tree/main/templates). If you maintain your own template, consider adding the `payload-template` topic to your GitHub repository for others to find.
+
+- [Official Templates](https://github.com/payloadcms/payload/tree/main/templates)
+- [Community Templates](https://github.com/topics/payload-template)
+
+## ✨ Features
+
+- Completely free and open-source
+- [GraphQL](https://payloadcms.com/docs/graphql/overview), [REST](https://payloadcms.com/docs/rest-api/overview), and [Local](https://payloadcms.com/docs/local-api/overview) APIs
+- [Easily customizable ReactJS Admin](https://payloadcms.com/docs/admin/overview)
+- [Fully self-hosted](https://payloadcms.com/docs/production/deployment)
+- [Extensible Authentication](https://payloadcms.com/docs/authentication/overview)
+- [Local file storage & upload](https://payloadcms.com/docs/upload/overview)
+- [Version History and Drafts](https://payloadcms.com/docs/versions/overview)
+- [Field-based Localization](https://payloadcms.com/docs/configuration/localization)
+- [Block-based Layout Builder](https://payloadcms.com/docs/fields/blocks)
+- [Extensible SlateJS rich text editor](https://payloadcms.com/docs/fields/rich-text)
+- [Array field type](https://payloadcms.com/docs/fields/array)
+- [Field conditional logic](https://payloadcms.com/docs/fields/overview#conditional-logic)
+- Extremely granular [Access Control](https://payloadcms.com/docs/access-control/overview)
+- [Document and field-level hooks](https://payloadcms.com/docs/hooks/overview) for every action Payload provides
+- Built with Typescript & very Typescript-friendly
+- Intensely fast API
+- Highly secure thanks to HTTP-only cookies, CSRF protection, and more
+
+<a target="_blank" href="https://github.com/payloadcms/payload/discussions"><strong>Request Feature</strong></a>
+
+## 🗒️ Documentation
+
+Check out the [Payload website](https://payloadcms.com/docs/getting-started/what-is-payload) to find in-depth documentation for everything that Payload offers.
+
+Migrating from v1 to v2? Check out the [2.0 Release Notes](https://github.com/payloadcms/payload/releases/tag/v2.0.0) on how to do it.
+
+## 🙋 Contributing
+
+If you want to add contributions to this repository, please follow the instructions in [contributing.md](./CONTRIBUTING.md).
+
+## 📚 Examples
+
+The [Examples Directory](./examples) 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.
+
+- [Examples Directory](./examples)
+- [Payload Blog](https://payloadcms.com/blog)
+- [Payload YouTube](https://www.youtube.com/@payloadcms)
+
+## 🔌 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.
+
+- [Official Plugins](https://github.com/orgs/payloadcms/repositories?q=topic%3Apayload-plugin)
+- [Community Plugins](https://github.com/topics/payload-plugin)
+
+## 🚨 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. :point_down:
+
+- [GitHub Discussions](https://github.com/payloadcms/payload/discussions)
+- [GitHub Issues](https://github.com/payloadcms/payload/issues)
+- [Discord](https://t.co/30APlsQUPB)
+- [Community Help](https://payloadcms.com/community-help)
+
+## ⭐ Like what we're doing? Give us a star
+
+![payload-github-star](https://cms.payloadcms.com/media/payload-github-star.gif)
+
+## 👏 Thanks to all our contributors
+
+<img align="left" src="https://contributors-img.web.app/image?repo=payloadcms/payload"/>

SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+Please report any security issues or concerns to [info@payloadcms.com](mailto:info@payloadcms.com).

app/(app)/layout.tsx

@@ -0,0 +1,14 @@
+import React from 'react'
+
+export const metadata = {
+  description: 'Generated by Next.js',
+  title: 'Next.js',
+}
+
+export default function RootLayout({ children }: { children: React.ReactNode }) {
+  return (
+    <html lang="en">
+      <body>{children}</body>
+    </html>
+  )
+}

app/(app)/test/page.tsx

@@ -0,0 +1,11 @@
+import configPromise from '@payload-config'
+import { getPayloadHMR } from '@payloadcms/next/utilities'
+
+export const Page = async ({ params, searchParams }) => {
+  const payload = await getPayloadHMR({
+    config: configPromise,
+  })
+  return <div>test ${payload?.config?.collections?.length}</div>
+}
+
+export default Page

app/(payload)/admin/[[...segments]]/not-found.tsx

@@ -0,0 +1,25 @@
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
+import type { Metadata } from 'next'
+
+import config from '@payload-config'
+/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+import { NotFoundPage, generatePageMetadata } from '@payloadcms/next/views'
+
+import { importMap } from '../importMap.js'
+
+type Args = {
+  params: {
+    segments: string[]
+  }
+  searchParams: {
+    [key: string]: string | string[]
+  }
+}
+
+export const generateMetadata = ({ params, searchParams }: Args): Promise<Metadata> =>
+  generatePageMetadata({ config, params, searchParams })
+
+const NotFound = ({ params, searchParams }: Args) =>
+  NotFoundPage({ config, importMap, params, searchParams })
+
+export default NotFound

app/(payload)/admin/[[...segments]]/page.tsx

@@ -0,0 +1,25 @@
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
+import type { Metadata } from 'next'
+
+import config from '@payload-config'
+/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+import { RootPage, generatePageMetadata } from '@payloadcms/next/views'
+
+import { importMap } from '../importMap.js'
+
+type Args = {
+  params: {
+    segments: string[]
+  }
+  searchParams: {
+    [key: string]: string | string[]
+  }
+}
+
+export const generateMetadata = ({ params, searchParams }: Args): Promise<Metadata> =>
+  generatePageMetadata({ config, params, searchParams })
+
+const Page = ({ params, searchParams }: Args) =>
+  RootPage({ config, importMap, params, searchParams })
+
+export default Page

app/(payload)/api/[...slug]/route.ts

@@ -0,0 +1,10 @@
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
+/* DO NOT MODIFY it because it could be re-written at any time. */
+import config from '@payload-config'
+import { REST_DELETE, REST_GET, REST_OPTIONS, REST_PATCH, REST_POST } from '@payloadcms/next/routes'
+
+export const GET = REST_GET(config)
+export const POST = REST_POST(config)
+export const DELETE = REST_DELETE(config)
+export const PATCH = REST_PATCH(config)
+export const OPTIONS = REST_OPTIONS(config)

app/(payload)/api/graphql-playground/route.ts

@@ -0,0 +1,6 @@
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
+/* DO NOT MODIFY it because it could be re-written at any time. */
+import config from '@payload-config'
+import { GRAPHQL_PLAYGROUND_GET } from '@payloadcms/next/routes'
+
+export const GET = GRAPHQL_PLAYGROUND_GET(config)

app/(payload)/api/graphql/route.ts

@@ -0,0 +1,6 @@
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
+/* DO NOT MODIFY it because it could be re-written at any time. */
+import config from '@payload-config'
+import { GRAPHQL_POST } from '@payloadcms/next/routes'
+
+export const POST = GRAPHQL_POST(config)

app/(payload)/custom.scss

@@ -0,0 +1,8 @@
+#custom-css {
+  font-family: monospace;
+  background-image: url('/placeholder.png');
+}
+
+#custom-css::after {
+  content: 'custom-css';
+}

app/(payload)/layout.tsx

@@ -0,0 +1,23 @@
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
+import configPromise from '@payload-config'
+import { RootLayout } from '@payloadcms/next/layouts'
+
+import { importMap } from './admin/importMap.js'
+
+// import '@payloadcms/ui/styles.css' // Uncomment this line if `@payloadcms/ui` in `tsconfig.json` points to `/ui/dist` instead of `/ui/src`
+/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+import React from 'react'
+
+import './custom.scss'
+
+type Args = {
+  children: React.ReactNode
+}
+
+const Layout = ({ children }: Args) => (
+  <RootLayout config={configPromise} importMap={importMap}>
+    {children}
+  </RootLayout>
+)
+
+export default Layout

app/my-route/route.ts

@@ -0,0 +1,5 @@
+export const GET = () => {
+  return Response.json({
+    hello: 'elliot',
+  })
+}

bin/cli.js

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-require('../dist/index.js')

docs/access-control/collections.mdx

@@ -0,0 +1,339 @@
+---
+title: Collection Access Control
+label: Collections
+order: 20
+desc: With Collection-level Access Control you can define which users can create, read, update or delete Collections.
+keywords: collections, access control, permissions, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+Collection Access Control is [Access Control](../access-control) used to restrict access to Documents within a [Collection](../collections/overview), as well as what they can and cannot see within the [Admin Panel](../admin/overview) as it relates to that Collection.
+
+To add Access Control to a Collection, use the `access` property in your [Collection Config](../configuration/collections):
+
+```ts
+import type { CollectionConfig } from 'payload';
+
+export const CollectionWithAccessControl: CollectionConfig = {
+  // ...
+  access: { // highlight-line
+    // ...
+  },
+}
+```
+
+## Config Options
+
+Access Control is specific to the operation of the request.
+
+To add Access Control to a Collection, use the `access` property in your [Collection Config](../configuration/collections):
+
+```ts
+import type { CollectionConfig } from 'payload';
+
+export const CollectionWithAccessControl: CollectionConfig = {
+  // ...
+  // highlight-start
+  access: {
+    create: () => {...},
+    read: () => {...},
+    update: () => {...},
+    delete: () => {...},
+
+    // Auth-enabled Collections only
+    admin: () => {...},
+    unlock: () => {...},
+
+    // Version-enabled Collections only
+    readVersions: () => {...},
+  },
+  // highlight-end
+}
+```
+
+The following options are available:
+
+| Function                | Allows/Denies Access                         |
+| ----------------------- | -------------------------------------------- |
+| **`create`** | Used in the `create` operation. [More details](#create). |
+| **`read`**     | Used in the `find` and `findByID` operations. [More details](#read). |
+| **`update`** | Used in the `update` operation. [More details](#update). |
+| **`delete`** | Used in the `delete` operation. [More details](#delete). |
+
+If a Collection supports [`Authentication`](../authentication/overview), the following additional options are available:
+
+| Function                | Allows/Denies Access                                           |
+| ----------------------- | -------------------------------------------------------------- |
+| **`admin`**   | Used to restrict access to the [Admin Panel](../admin/overview). [More details](#admin). |
+| **`unlock`** | Used to restrict which users can access the `unlock` operation. [More details](#unlock). |
+
+If a Collection supports [Versions](../versions/overview), the following additional options are available:
+
+| Function           | Allows/Denies Access                                                                                                   |
+| ------------------ | ---------------------------------------------------------------------------------------------------------------------- |
+| **`readVersions`** | Used to control who can read versions, and who can't. Will automatically restrict the Admin UI version viewing access. [More details](#read-versions). |
+
+### Create
+
+Returns a boolean which allows/denies access to the `create` request.
+
+To add create Access Control to a Collection, use the `create` property in the [Collection Config](../collections/overview):
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const CollectionWithCreateAccess: CollectionConfig = {
+  // ...
+  access: {
+    // highlight-start
+    create: ({ req: { user }, data }) => {
+      return Boolean(user)
+    },
+    // highlight-end
+  },
+}
+```
+
+The following arguments are provided to the `create` function:
+
+| Option     | Description                                                                                                                  |
+| ---------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| **`req`**  | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
+| **`data`** | The data passed to create the document with.                                                                                 |
+
+### Read
+
+Returns a boolean which allows/denies access to the `read` request.
+
+To add read Access Control to a Collection, use the `read` property in the [Collection Config](../collections/overview):
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const CollectionWithReadAccess: CollectionConfig = {
+  // ...
+  access: {
+    // highlight-start
+    read: ({ req: { user } }) => {
+      return Boolean(user)
+    },
+    // highlight-end
+  },
+}
+```
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  Return a [Query](../queries/overview) to limit the Documents to only those that match the constraint. This can be helpful to restrict users' access to specific Documents. [More details](../queries/overview).
+</Banner>
+
+As your application becomes more complex, you may want to define your function in a separate file and import them into your Collection Config:
+
+```ts
+import type { Access } from 'payload'
+
+export const canReadPage: Access = ({ req: { user } }) => {
+  // Allow authenticated users
+  if (user) {
+    return true
+  }
+
+  // By returning a Query, guest users can read public Documents
+  // Note: this assumes you have a `isPublic` checkbox field on your Collection
+  return {
+    isPublic: {
+      equals: true,
+    },
+  }
+}
+```
+
+The following arguments are provided to the `read` function:
+
+| Option    | Description                                                                |
+| --------- | -------------------------------------------------------------------------- |
+| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
+| **`id`**  | `id` of document requested, if within `findByID`.                           |
+
+### Update
+
+Returns a boolean which allows/denies access to the `update` request.
+
+To add update Access Control to a Collection, use the `update` property in the [Collection Config](../collections/overview):
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const CollectionWithUpdateAccess: CollectionConfig = {
+  // ...
+  access: {
+    // highlight-start
+    update: ({ req: { user }}) => {
+      return Boolean(user)
+    },
+    // highlight-end
+  },
+}
+```
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  Return a [Query](../queries/overview) to limit the Documents to only those that match the constraint. This can be helpful to restrict users' access to specific Documents. [More details](../queries/overview).
+</Banner>
+
+As your application becomes more complex, you may want to define your function in a separate file and import them into your Collection Config:
+
+```ts
+import type { Access } from 'payload'
+
+export const canUpdateUser: Access = ({ req: { user }, id }) => {
+  // Allow users with a role of 'admin'
+  if (user.roles && user.roles.some((role) => role === 'admin')) {
+    return true
+  }
+
+  // allow any other users to update only oneself
+  return user.id === id
+}
+```
+
+The following arguments are provided to the `update` function:
+
+| Option     | Description                                                                |
+| ---------- | -------------------------------------------------------------------------- |
+| **`req`**  | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
+| **`id`**   | `id` of document requested to update.                                       |
+| **`data`** | The data passed to update the document with.                                |
+
+### Delete
+
+Similarly to the Update function, returns a boolean or a [query constraint](/docs/queries/overview) to limit which documents can be deleted by which users.
+
+To add delete Access Control to a Collection, use the `delete` property in the [Collection Config](../collections/overview):
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const CollectionWithDeleteAccess: CollectionConfig = {
+  // ...
+  access: {
+    // highlight-start
+    delete: ({ req: { user }}) => {
+      return Boolean(user)
+    },
+    // highlight-end
+  },
+}
+```
+
+As your application becomes more complex, you may want to define your function in a separate file and import them into your Collection Config:
+
+```ts
+import type { Access } from 'payload'
+
+export const canDeleteCustomer: Access = async ({ req, id }) => {
+  if (!id) {
+    // allow the admin UI to show controls to delete since it is indeterminate without the `id`
+    return true
+  }
+
+  // Query another Collection using the `id`
+  const result = await req.payload.find({
+    collection: 'contracts',
+    limit: 0,
+    depth: 0,
+    where: {
+      customer: { equals: id },
+    },
+  })
+
+  return result.totalDocs === 0
+}
+```
+
+The following arguments are provided to the `delete` function:
+
+| Option    | Description                                                                                         |
+| --------- | --------------------------------------------------------------------------------------------------- |
+| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object with additional `user` property, which is the currently logged in user. |
+| **`id`**  | `id` of document requested to delete.
+
+### Admin
+
+If the Collection is use to access the [Admin Panel](../admin/overview#the-admin-user-collection), the `Admin` Access Control function determines whether or not the currently logged in user can access the admin UI.
+
+To add Admin Access Control to a Collection, use the `admin` property in the [Collection Config](../collections/overview):
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const CollectionWithAdminAccess: CollectionConfig = {
+  // ...
+  access: {
+    // highlight-start
+    admin: ({ req: { user }}) => {
+      return Boolean(user)
+    },
+    // highlight-end
+  },
+}
+```
+
+The following arguments are provided to the `admin` function:
+
+| Option    | Description                                                                |
+| --------- | -------------------------------------------------------------------------- |
+| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
+
+### Unlock
+
+Determines which users can [unlock](/docs/authentication/operations#unlock) other users who may be blocked from authenticating successfully due to [failing too many login attempts](/docs/authentication/overview#options).
+
+To add Unlock Access Control to a Collection, use the `unlock` property in the [Collection Config](../collections/overview):
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const CollectionWithUnlockAccess: CollectionConfig = {
+  // ...
+  access: {
+    // highlight-start
+    unlock: ({ req: { user }}) => {
+      return Boolean(user)
+    },
+    // highlight-end
+  },
+}
+```
+
+The following arguments are provided to the `unlock` function:
+
+| Option    | Description                                                                |
+| --------- | -------------------------------------------------------------------------- |
+| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
+
+### Read Versions
+
+If the Collection has [Versions](../versions/overview) enabled, the `readVersions` Access Control function determines whether or not the currently logged in user can access the version history of a Document.
+
+To add Read Versions Access Control to a Collection, use the `readVersions` property in the [Collection Config](../collections/overview):
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const CollectionWithVersionsAccess: CollectionConfig = {
+  // ...
+  access: {
+    // highlight-start
+    readVersions: ({ req: { user }}) => {
+      return Boolean(user)
+    },
+    // highlight-end
+  },
+}
+```
+
+The following arguments are provided to the `readVersions` function:
+
+| Option    | Description                                                                |
+| --------- | -------------------------------------------------------------------------- |
+| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |

docs/access-control/fields.mdx

@@ -0,0 +1,103 @@
+---
+title: Field-level Access Control
+label: Fields
+order: 40
+desc: Field-level Access Control is specified within a field's config, and allows you to define which users can create, read or update Fields.
+keywords: fields, access control, permissions, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+Field Access Control is [Access Control](../access-control) used to restrict access to specific [Fields](../fields/overview) within a Document.
+
+To add Access Control to a Field, use the `access` property in your [Field Config](../fields/overview):
+
+```ts
+import type { Field } from 'payload';
+
+export const FieldWithAccessControl: Field = {
+  // ...
+  access: { // highlight-line
+    // ...
+  },
+}
+```
+
+<Banner type="warning">
+  <strong>Note:</strong>
+  Field Access Controls does not support returning [Query](../queries/overview) constraints like [Collection Access Control](./collections) does.
+</Banner>
+
+## Config Options
+
+Access Control is specific to the operation of the request.
+
+To add Access Control to a Field, use the `access` property in the [Field Config](../fields/overview):
+
+```ts
+import { CollectionConfig } from 'payload';
+
+export const Posts: CollectionConfig = {
+  slug: 'posts',
+  fields: [
+    {
+      name: 'title',
+      type: 'text',
+      // highlight-start
+      access: {
+        create: ({ req: { user } }) => { ... },
+        read: ({ req: { user } }) => { ... },
+        update: ({ req: { user } }) => { ... },
+      },
+      // highlight-end
+    };
+  ],
+};
+```
+
+The following options are available:
+
+| Function                | Purpose                                                                          |
+| ----------------------- | -------------------------------------------------------------------------------- |
+| **`create`** | Allows or denies the ability to set a field's value when creating a new document. [More details](#create). |
+| **`read`**     | Allows or denies the ability to read a field's value. [More details](#read).       |
+| **`update`** | Allows or denies the ability to update a field's value [More details](#update).    |
+
+### Create
+
+Returns a boolean which allows or denies the ability to set a field's value when creating a new document. If `false` is returned, any passed values will be discarded.
+
+**Available argument properties:**
+
+| Option            | Description                                                                |
+| ----------------- | -------------------------------------------------------------------------- |
+| **`req`**         | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user` |
+| **`data`**        | The full data passed to create the document.                               |
+| **`siblingData`** | Immediately adjacent field data passed to create the document.             |
+
+### Read
+
+Returns a boolean which allows or denies the ability to read a field's value. If `false`, the entire property is omitted from the resulting document.
+
+**Available argument properties:**
+
+| Option            | Description                                                                |
+| ----------------- | -------------------------------------------------------------------------- |
+| **`req`**         | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user` |
+| **`id`**          | `id` of the document being read                                            |
+| **`doc`**         | The full document data.                                                    |
+| **`siblingData`** | Immediately adjacent field data of the document being read.                |
+
+### Update
+
+Returns a boolean which allows or denies the ability to update a field's value. If `false` is returned, any passed values will be discarded.
+
+If `false` is returned and you attempt to update the field's value, the operation will **not** throw an error however the field will be omitted from the update operation and the value will remain unchanged.
+
+**Available argument properties:**
+
+| Option            | Description                                                                |
+| ----------------- | -------------------------------------------------------------------------- |
+| **`req`**         | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user` |
+| **`id`**          | `id` of the document being updated                                         |
+| **`data`**        | The full data passed to update the document.                               |
+| **`siblingData`** | Immediately adjacent field data passed to update the document with.        |
+| **`doc`**         | The full document data, before the update is applied.                      |

docs/access-control/globals.mdx

@@ -0,0 +1,142 @@
+---
+title: Globals Access Control
+label: Globals
+order: 30
+desc: Global-level Access Control is specified within each Global's `access` property and allows you to define which users can read or update Globals.
+keywords: globals, access control, permissions, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+Global Access Control is [Access Control](../access-control) used to restrict access to [Global](../globals/overview) Documents, as well as what they can and cannot see within the [Admin Panel](../admin/overview) as it relates to that Global.
+
+To add Access Control to a Global, use the `access` property in your [Global Config](../configuration/globals):
+
+```ts
+import type { GlobalConfig } from 'payload';
+
+export const GlobalWithAccessControl: GlobalConfig = {
+  // ...
+  access: { // highlight-line
+    // ...
+  },
+}
+```
+
+## Config Options
+
+Access Control is specific to the operation of the request.
+
+To add Access Control to a [Global](../configuration/globals), use the `access` property in the [Global Config](../globals/overview):
+
+```ts
+import { GlobalConfig } from 'payload'
+
+const GlobalWithAccessControl: GlobalConfig = {
+  // ...
+  // highlight-start
+  access: {
+    read: ({ req: { user } }) => {...},
+    update: ({ req: { user } }) => {...},
+
+    // Version-enabled Globals only
+    readVersion: () => {...},
+  },
+  // highlight-end
+}
+
+export default Header
+```
+
+The following options are available:
+
+| Function                | Allows/Denies Access                   |
+| ----------------------- | -------------------------------------- |
+| **`read`**     | Used in the `findOne` Global operation. [More details](#read). |
+| **`update`** | Used in the `update` Global operation. [More details](#update). |
+
+If a Global supports [Versions](../versions/overview), the following additional options are available:
+
+| Function           | Allows/Denies Access                                                                                                   |
+| ------------------ | ---------------------------------------------------------------------------------------------------------------------- |
+| **`readVersions`** | Used to control who can read versions, and who can't. Will automatically restrict the Admin UI version viewing access. [More details](#read-versions). |
+
+### Read
+
+Returns a boolean result or optionally a [query constraint](../queries/overview) which limits who can read this global based on its current properties.
+
+To add read Access Control to a [Global](../configuration/globals), use the `read` property in the [Global Config](../globals/overview):
+
+```ts
+import { GlobalConfig } from 'payload'
+
+const Header: GlobalConfig = {
+  // ...
+  // highlight-start
+  read: {
+    read: ({ req: { user } }) => {
+      return Boolean(user)
+    },
+  }
+  // highlight-end
+}
+```
+
+The following arguments are provided to the `read` function:
+
+| Option    | Description                                                                |
+| --------- | -------------------------------------------------------------------------- |
+| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
+
+### Update
+
+Returns a boolean result or optionally a [query constraint](../queries/overview) which limits who can update this global based on its current properties.
+
+To add update Access Control to a [Global](../configuration/globals), use the `access` property in the [Global Config](../globals/overview):
+
+```ts
+import { GlobalConfig } from 'payload'
+
+const Header: GlobalConfig = {
+  // ...
+  // highlight-start
+  access: {
+    update: ({ req: { user }, data }) => {
+      return Boolean(user)
+    },
+  }
+  // highlight-end
+}
+```
+
+The following arguments are provided to the `update` function:
+
+| Option     | Description                                                                |
+| ---------- | -------------------------------------------------------------------------- |
+| **`req`**  | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
+| **`data`** | The data passed to update the global with.                                 |
+
+### Read Versions
+
+If the Global has [Versions](../versions/overview) enabled, the `readVersions` Access Control function determines whether or not the currently logged in user can access the version history of a Document.
+
+To add Read Versions Access Control to a Collection, use the `readVersions` property in the [Global Config](../globals/overview):
+
+```ts
+import type { GlobalConfig } from 'payload'
+
+export const GlobalWithVersionsAccess: GlobalConfig = {
+  // ...
+  access: {
+    // highlight-start
+    readVersions: ({ req: { user }}) => {
+      return Boolean(user)
+    },
+    // highlight-end
+  },
+}
+```
+
+The following arguments are provided to the `readVersions` function:
+
+| Option    | Description                                                                |
+| --------- | -------------------------------------------------------------------------- |
+| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |

docs/access-control/overview.mdx

@@ -0,0 +1,60 @@
+---
+title: Access Control
+label: Overview
+order: 10
+desc: Payload makes it simple to define and manage Access Control. By declaring roles, you can set permissions and restrict what your users can interact with.
+keywords: overview, access control, permissions, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+<YouTube id="DoPLyXG26Dg" title="Overview of Payload Access Control" />
+
+Access Control determines what a user can and cannot do with any given Document, as well as what they can and cannot see within the [Admin Panel](../admin/overview). By implementing Access Control, you can define granular restrictions based on the user, their roles (RBAC), Document data, or any other criteria your application requires.
+
+Access Control functions are scoped to the _operation_, meaning you can have different rules for `create`, `read`, `update`, `delete`, etc. Access Control functions are executed _before_ any changes are made and _before_ any operations are completed. This allows you to determine if the user has the necessary permissions before fulfilling the request.
+
+There are many use cases for Access Control, including:
+
+- Allowing anyone `read` access to all posts
+- Only allowing public access to posts where a `status` field is equal to `published`
+- Giving only users with a `role` field equal to `admin` the ability to delete posts
+- Allowing anyone to submit contact forms, but only logged in users to `read`, `update` or `delete` them
+- Restricting a user to only be able to see their own orders, but noone else's
+- Allowing users that belong to a certain organization to access only that organization's resources
+
+There are three main types of Access Control in Payload:
+
+- [Collection Access Control](./collections)
+- [Global Access Control](./globals)
+- [Field Access Control](./fields)
+
+## Default Access Control
+
+Payload provides default Access Control so that your data is secured behind [Authentication](../authentication) without additional configuration. To do this, Payload sets a default function that simply checks if a user is present on the request. You can override this default behavior by defining your own Access Control functions as needed.
+
+Here is the default Access Control that Payload provides:
+
+```ts
+const defaultPayloadAccess = ({ req: { user } }) => {
+  // Return `true` if a user is found
+  // and `false` if it is undefined or null
+  return Boolean(user) // highlight-line
+}
+```
+
+<Banner type="warning">
+  <strong>Important:</strong>
+  In the [Local API](../local-api/overview), all Access Control is _skipped_ by default. This allows your server to have full control over your application. To opt back in, you can set the `overrideAccess` option to `false` in your requests.
+</Banner>
+
+## The Access Operation
+
+The Admin Panel responds dynamically to your changes to Access Control. For example, if you restrict editing `ExampleCollection` to only users that feature an "admin" role, Payload will **hide** that Collection from the Admin Panel entirely. This is super powerful and allows you to control who can do what within your Admin Panel using the same functions that secure your APIs.
+
+To accomplish this, Payload exposes the [Access Operation](../authentication/operations#access). Upon login, Payload executes each Access Control function at the top level, across all Collections, Globals, and Fields, and returns a response that contains a reflection of what the currently authenticated user can do within your application.
+
+<Banner type="warning">
+  <strong>Important:</strong>
+  When your access control functions are executed via the [Access Operation](../authentication/operations#access),  the `id` and `data` arguments will be `undefined`. This is because Payload is executing your functions without referencing a specific Document.
+</Banner>
+
+If you use `id` or `data` within your access control functions, make sure to check that they are defined first. If they are not, then you can assume that your Access Control is being executed via the Access Operation to determine solely what the user can do within the Admin Panel.

docs/admin/collections.mdx

@@ -0,0 +1,173 @@
+---
+title: Collection Admin Config
+label: Collections
+order: 20
+desc:
+keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+The behavior of [Collections](../configuration/collections) within the [Admin Panel](./overview) can be fully customized to fit the needs of your application. This includes grouping or hiding their navigation links, adding [Custom Components](./components), selecting which fields to display in the List View, and more.
+
+To configure Admin Options for Collections, use the `admin` property in your Collection Config:
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const MyCollection: CollectionConfig = {
+  // ...
+  admin: { // highlight-line
+    // ...
+  },
+}
+```
+
+## Admin Options
+
+The following options are available:
+
+| Option                       | Description                                                                                                                                                                                           |
+| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`group`**                      | Text used as a label for grouping Collection and Global links together in the navigation.                                                                                                             |
+| **`hidden`**                     | Set to true or a function, called with the current user, returning true to exclude this Collection from navigation and admin routing.                                                                 |
+| **`hooks`**                      | Admin-specific hooks for this Collection. [More details](../hooks/collections).                                                                                                                                        |
+| **`useAsTitle`**                 | Specify a top-level field to use for a document title throughout the Admin Panel. If no field is defined, the ID of the document is used as the title.                                                |
+| **`description`**                | Text to display below the Collection label in the List View to give editors more information. Alternatively, you can use the `admin.components.Description` to render a React component. [More details](#components). |
+| **`defaultColumns`**             | Array of field names that correspond to which columns to show by default in this Collection's List View.                                                                                              |
+| **`hideAPIURL`**                 | Hides the "API URL" meta field while editing documents within this Collection.                                                                                                                        |
+| **`enableRichTextLink`**         | The [Rich Text](../fields/rich-text) field features a `Link` element which allows for users to automatically reference related documents within their rich text. Set to `true` by default.         |
+| **`enableRichTextRelationship`** | The [Rich Text](../fields/rich-text) field features a `Relationship` element which allows for users to automatically reference related documents within their rich text. Set to `true` by default. |
+| **`meta`**                       | Page metadata overrides to apply to this Collection within the Admin Panel. [More details](./metadata).                                                                           |
+| **`preview`**                    | Function to generate preview URLs within the Admin Panel that can point to your app. [More details](#preview).                                                                                                |
+| **`livePreview`**                | Enable real-time editing for instant visual feedback of your front-end application. [More details](../live-preview/overview).                                                                              |
+| **`components`**                 | Swap in your own React components to be used within this Collection. [More details](#components).                                                                                       |
+| **`listSearchableFields`**       | Specify which fields should be searched in the List search view. [More details](#list-searchable-fields).                                                                                                      |
+| **`pagination`**             | Set pagination-specific options for this Collection. [More details](#pagination).                                                                                                                              |
+
+### Components
+
+Collections can set their own [Custom Components](./components) which only apply to [Collection](../configuration/collections)-specific UI within the [Admin Panel](./overview). This includes elements such as the Save Button, or entire layouts such as the Edit View.
+
+To override Collection Components, use the `admin.components` property in your [Collection Config](../configuration/collections):
+
+```ts
+import type { SanitizedCollectionConfig } from 'payload'
+
+export const MyCollection: SanitizedCollectionConfig = {
+  // ...
+  admin: {
+    components: { // highlight-line
+      // ...
+    },
+  },
+}
+```
+
+The following options are available:
+
+| Path                       | Description                                                                                                            |
+| -------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| **`beforeList`**           | An array of components to inject _before_ the built-in List View                                                          |
+| **`beforeListTable`**      | An array of components to inject _before_ the built-in List View's table                                                  |
+| **`afterList`**            | An array of components to inject _after_ the built-in List View                                                           |
+| **`afterListTable`**       | An array of components to inject _after_ the built-in List View's table
+| **`Description`**          | A component to render below the Collection label in the List View. An alternative to the `admin.description` property. |
+| **`edit.SaveButton`**      | Replace the default Save Button with a Custom Component. [Drafts](../versions/drafts) must be disabled.                                     |
+| **`edit.SaveDraftButton`** | Replace the default Save Draft Button with a Custom Component. [Drafts](../versions/drafts) must be enabled and autosave must be disabled. |
+| **`edit.PublishButton`**   | Replace the default Publish Button with a Custom Component. [Drafts](../versions/drafts) must be enabled.                                  |
+| **`edit.PreviewButton`**   | Replace the default Preview Button with a Custom Component. [Preview](#preview) must be enabled.                                         |
+| **`views`**                | Override or create new views within the Admin Panel. [More details](./views).                                     |
+
+<Banner type="success">
+  <strong>Note:</strong>
+  For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components).
+</Banner>
+
+### Preview
+
+It is possible to display a Preview Button within the Edit View of the Admin Panel. This will allow editors to visit the frontend of your app the corresponds to the document they are actively editing. This way they can preview the latest, potentially unpublished changes.
+
+To configure the Preview Button, set the `admin.preview` property to a function in your [Collection Config](../configuration/collections):
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const Posts: CollectionConfig = {
+  // ...
+  admin: {
+    // highlight-start
+    preview: (doc, { locale }) => {
+      if (doc?.slug) {
+        return `/${doc.slug}?locale=${locale}`
+      }
+
+      return null
+    },
+    // highlight-end
+  },
+}
+```
+
+The preview function receives two arguments:
+
+| Argument | Description |
+| --- | --- |
+| **`doc`** | The Document being edited. |
+| **`ctx`** | An object containing `locale` and `token` properties. The `token` is the currently logged-in user's JWT. |
+
+<Banner type="success">
+  <strong>Note:</strong>
+  For fully working example of this, check of the official [Draft Preview Example](https://github.com/payloadcms/payload/tree/main/examples/draft-preview) in the [Examples Directory](https://github.com/payloadcms/payload/tree/main/examples).
+</Banner>
+
+### Pagination
+
+All Collections receive their own List View which displays a paginated list of documents that can be sorted and filtered. The pagination behavior of the List View can be customized on a per-Collection basis, and uses the same [Pagination](../queries/pagination) API that Payload provides.
+
+To configure pagination options, use the `admin.pagination` property in your [Collection Config](../configuration/collections):
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const Posts: CollectionConfig = {
+  // ...
+  admin: {
+    // highlight-start
+    pagination: {
+      defaultLimit: 10,
+      limits: [10, 20, 50],
+    },
+    // highlight-end
+  },
+}
+```
+
+The following options are available:
+
+| Option         | Description                                                                                         |
+| -------------- | --------------------------------------------------------------------------------------------------- |
+| `defaultLimit` | Integer that specifies the default per-page limit that should be used. Defaults to 10.              |
+| `limits`       | Provide an array of integers to use as per-page options for admins to choose from in the List View. |
+
+### List Searchable Fields
+
+In the List View, there is a "search" box that allows you to quickly find a document through a simple text search. By default, it searches on the ID field. If defined, the `admin.useAsTitle` field is used. Or, you can explicitly define which fields to search based on the needs of your application.
+
+To define which fields should be searched, use the `admin.listSearchableFields` property in your [Collection Config](../configuration/collections):
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const Posts: CollectionConfig = {
+  // ...
+  admin: {
+    // highlight-start
+    listSearchableFields: ['title', 'slug'],
+    // highlight-end
+  },
+}
+```
+
+<Banner type="warning">
+  <strong>Tip:</strong>
+  If you are adding `listSearchableFields`, make sure you index each of these fields so your admin queries can remain performant.
+</Banner>

docs/admin/components.mdx

@@ -0,0 +1,600 @@
+---
+title: Swap in your own React components
+label: Custom Components
+order: 40
+desc: Fully customize your Admin Panel by swapping in your own React components. Add fields, remove views, update routes and change functions to sculpt your perfect Dashboard.
+keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+The Payload [Admin Panel](./overview) is designed to be as minimal and straightforward as possible to allow for both easy customization and full control over the UI. In order for Payload to support this level of customization, Payload provides a pattern for you to supply your own React components through your [Payload Config](../configuration/overview).
+
+All Custom Components in Payload are [React Server Components](https://react.dev/reference/rsc/server-components) by default, with the exception of [Custom Providers](#custom-providers). This enables the use of the [Local API](../local-api) directly on the front-end. Custom Components are available for nearly every part of the Admin Panel for extreme granularity and control.
+
+<Banner type="success">
+  <strong>Note:</strong>
+  Client Components continue to be fully supported. To use Client Components in your app, simply include the `use client` directive. Payload will automatically detect and remove all default, [non-serializable props](https://react.dev/reference/rsc/use-client#serializable-types) before rendering your component. [More details](#client-components).
+</Banner>
+
+There are four main types of Custom Components in Payload:
+
+- [Root Components](#root-components)
+- [Collection Components](./collections#components)
+- [Global Components](./globals#components)
+- [Field Components](./fields)
+
+To swap in your own Custom Component, consult the list of available components. Determine the scope that corresponds to what you are trying to accomplish, then [author your React component(s)](#building-custom-components) accordingly.
+
+
+## Defining Custom Components in the Payload Config
+
+In the Payload Config, you can define custom React Components to enhance the admin interface. However, these components should not be imported directly into the server-only Payload Config to avoid including client-side code. Instead, you specify the path to the component. Here’s how you can do it:
+
+
+src/components/Logout.tsx
+```tsx
+'use client'
+import React from 'react'
+
+export const MyComponent = () => {
+  return (
+    <button>Click me!</button>
+  )
+}
+```
+
+payload.config.ts:
+```ts
+import { buildConfig } from 'payload'
+
+const config = buildConfig({
+  // ...
+  admin: { // highlight-line
+    components: {
+      logout: {
+        Button: '/src/components/Logout#MyComponent'
+      }
+    }
+  },
+})
+```
+
+In the path `/src/components/Logout#MyComponent`, `/src/components/Logout` is the file path, and `MyComponent` is the named export. If the component is the default export, the export name can be omitted. Path and export name are separated by a `#`.
+
+### Configuring the Base Directory
+
+Component paths, by default, are relative to your working directory - this is usually where your Next.js config lies. To simplify component paths, you have the option to configure the *base directory* using the `admin.baseDir.baseDir` property:
+
+```ts
+import { buildConfig } from 'payload'
+import { fileURLToPath } from 'node:url'
+import path from 'path'
+const filename = fileURLToPath(import.meta.url)
+const dirname = path.dirname(filename)
+
+const config = buildConfig({
+  // ...
+  admin: { // highlight-line
+     importMap: {
+      baseDir: path.resolve(dirname, 'src'),
+    },
+    components: {
+      logout: {
+        Button: '/components/Logout#MyComponent'
+      }
+    }
+  },
+})
+```
+
+In this example, we set the base directory to the `src` directory - thus we can omit the `/src/` part of our component path string.
+
+### Passing Props
+
+Each React Component in the Payload Config is typed as `PayloadComponent`. This usually is a string, but can also be an object containing the following properties:
+
+| Property      | Description                                                                                                                   |
+|---------------|-------------------------------------------------------------------------------------------------------------------------------|
+| `clientProps` | Props to be passed to the React Component if it's a Client Component                                                          |
+| `exportName`  | Instead of declaring named exports using `#` in the component path, you can also omit them from `path` and pass them in here. |
+| `path`        | Path to the React Component. Named exports can be appended to the end of the path, separated by a `#`                         |
+| `serverProps` | Props to be passed to the React Component if it's a Server Component                                                          |
+
+To pass in props from the config, you can use the `clientProps` and/or `serverProps` properties. This alleviates the need to use an HOC (Higher-Order-Component) to declare a React Component with props passed in.
+
+Here is an example:
+
+src/components/Logout.tsx
+```tsx
+'use client'
+import React from 'react'
+
+export const MyComponent = ({ text }: { text: string }) => {
+  return (
+    <button>Click me! {text}</button>
+  )
+}
+```
+
+payload.config.ts:
+```ts
+import { buildConfig } from 'payload'
+
+const config = buildConfig({
+  // ...
+  admin: { // highlight-line
+    components: {
+      logout: {
+        Button: {
+          path: '/src/components/Logout',
+          clientProps: {
+            text: 'Some Text.'
+          },
+          exportName: 'MyComponent'
+        }
+      }
+    }
+  },
+})
+```
+
+### Import Maps
+
+It's essential to understand how `PayloadComponent` paths function behind the scenes. Directly importing React Components into your Payload Config using import statements can introduce client-only modules like CSS into your server-only config. This could error when attempting to load the Payload Config in server-only environments and unnecessarily increase the size of the Payload Config, which should remain streamlined and efficient for server use.
+
+Instead, we utilize component paths to reference React Components. This method enhances the Payload Config with actual React Component imports on the client side, without affecting server-side usage. A script is deployed to scan the Payload Config, collecting all component paths and creating an `importMap.js`. This file, located in app/(payload)/admin/importMap.js, must be statically imported by your Next.js root page and layout. The script imports all the React Components from the specified paths into a Map, associating them with their respective paths (the ones you defined).
+
+When constructing the `ClientConfig`, Payload uses the component paths as keys to fetch the corresponding React Component imports from the Import Map. It then substitutes the `PayloadComponent` with a `MappedComponent`. A `MappedComponent` includes the React Component and additional metadata, such as whether it's a server or a client component and which props it should receive. These components are then rendered through the `<RenderComponent />` component within the Payload Admin Panel.
+
+Import maps are regenerated whenever you modify any element related to component paths. This regeneration occurs at startup and whenever Hot Module Replacement (HMR) runs. If the import maps fail to regenerate during HMR, you can restart your application and execute the `payload generate:importmap` command to manually create a new import map. If you encounter any errors running this command, see the [Troubleshooting](/docs/beta/local-api/outside-nextjs#troubleshooting) section.
+
+### Component paths in external packages
+
+Component paths are resolved relative to your project's base directory, which is either your current working directory or the directory specified in `config.admin.baseDir`. When using custom components from external packages, you can't use relative paths. Instead, use an import path that's accessible as if you were writing an import statement in your project's base directory.
+
+For example, to export a field with a custom component from an external package named `my-external-package`:
+
+```ts
+import type { Field } from 'payload'
+export const MyCustomField: Field = {
+  type: 'text',
+  name: 'MyField',
+  admin: {
+    components: {
+      Field: 'my-external-package/client#MyFieldComponent'
+    }
+  }
+}
+```
+
+Despite `MyFieldComponent` living in `src/components/MyFieldComponent.tsx` in `my-external-package`, this will not be accessible from the consuming project. Instead, we recommend exporting all custom components from one file in the external package. For example, you can define a `src/client.ts file in `my-external-package`:
+
+```ts
+'use client'
+export { MyFieldComponent } from './components/MyFieldComponent'
+```
+
+Then, update the package.json of `my-external-package:
+
+```json
+{
+...
+  "exports": {
+    "./client": {
+        "import": "./dist/client.js",
+        "types": "./dist/client.d.ts",
+        "default": "./dist/client.js"
+    }
+  }
+}
+```
+
+This setup allows you to specify the component path as `my-external-package/client#MyFieldComponent` as seen above. The import map will generate:
+
+```ts
+import { MyFieldComponent } from 'my-external-package/client'
+```
+
+which is a valid way to access MyFieldComponent that can be resolved by the consuming project.
+
+### Custom Components from unknown locations
+
+By default, any component paths from known locations are added to the import map. However, if you need to add any components from unknown locations to the import map, you can do so by adding them to the `admin.dependencies` array in your Payload Config. This is mostly only relevant for plugin authors and not for regular Payload users.
+
+Example:
+
+```ts
+export default {
+  // ...
+  admin: {
+    // ...
+    dependencies: {
+      myTestComponent: { // myTestComponent is the key - can be anything
+        path: '/components/TestComponent.js#TestComponent',
+        type: 'component',
+        clientProps: {
+          test: 'hello',
+        },
+      },
+    },
+  }
+}
+```
+
+This way, `TestComponent` is added to the import map, no matter if it's referenced in a known location or not. On the client, you can then use the component like this:
+
+```tsx
+'use client'
+
+import { RenderComponent, useConfig } from '@payloadcms/ui'
+import React from 'react'
+
+export const CustomView = () => {
+  const { config } = useConfig()
+  return (
+    <div>
+      <RenderComponent mappedComponent={config.admin.dependencies?.myTestComponent} />
+    </div>
+  )
+}
+```
+
+## Root Components
+
+Root Components are those that effect the [Admin Panel](./overview) generally, such as the logo or the main nav.
+
+To override Root Components, use the `admin.components` property in your [Payload Config](../getting-started/overview):
+
+```ts
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  // ...
+  admin: {
+    // highlight-start
+    components: {
+      // ...
+    },
+    // highlight-end
+  },
+})
+```
+
+_For details on how to build Custom Components, see [Building Custom Components](#building-custom-components)._
+
+The following options are available:
+
+| Path                  | Description                                                                                                                                                                                                         |
+|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`Nav`**             | Contains the sidebar / mobile menu in its entirety.                                                                                                                                                                 |
+| **`beforeNavLinks`**  | An array of Custom Components to inject into the built-in Nav, _before_ the links themselves.                                                                                                                       |
+| **`afterNavLinks`**   | An array of Custom Components to inject into the built-in Nav, _after_ the links.                                                                                                                                   |
+| **`beforeDashboard`** | An array of Custom Components to inject into the built-in Dashboard, _before_ the default dashboard contents.                                                                                                       |
+| **`afterDashboard`**  | An array of Custom Components to inject into the built-in Dashboard, _after_ the default dashboard contents.                                                                                                        |
+| **`beforeLogin`**     | An array of Custom Components to inject into the built-in Login, _before_ the default login form.                                                                                                                   |
+| **`afterLogin`**      | An array of Custom Components to inject into the built-in Login, _after_ the default login form.                                                                                                                    |
+| **`logout.Button`**   | The button displayed in the sidebar that logs the user out.                                                                                                                                                         |
+| **`graphics.Icon`**   | The simplified logo used in contexts like the the `Nav` component.                                                                                                                                                  |
+| **`graphics.Logo`**   | The full logo used in contexts like the `Login` view.                                                                                                                                                               |
+| **`providers`**       | Custom [React Context](https://react.dev/learn/scaling-up-with-reducer-and-context) providers that will wrap the entire Admin Panel. [More details](#custom-providers).                                       |
+| **`actions`**         | An array of Custom Components to be rendered in the header of the Admin Panel, providing additional interactivity and functionality.                                                                  |
+| **`views`**           | Override or create new views within the Admin Panel. [More details](./views).                                                                                                                                 |
+
+<Banner type="success">
+  <strong>Note:</strong>
+  You can also use set [Collection Components](./collections#components) and [Global Components](./globals#components) in their respective configs.
+</Banner>
+
+### Custom Providers
+
+As you add more and more Custom Components to your [Admin Panel](./overview), you may find it helpful to add additional [React Context](https://react.dev/learn/scaling-up-with-reducer-and-context)(s). Payload allows you to inject your own context providers in your app so you can export your own custom hooks, etc.
+
+To add a Custom Provider, use the `admin.components.providers` property in your [Payload Config](../getting-started/overview):
+
+```ts
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  // ...
+  admin: {
+    components: {
+      providers: ['/path/to/MyProvider'], // highlight-line
+    },
+  },
+})
+```
+
+Then build your Custom Provider as follows:
+
+```tsx
+'use client'
+import React, { createContext, useContext } from 'react'
+
+const MyCustomContext = React.createContext(myCustomValue)
+
+export const MyProvider: React.FC = ({ children }) => {
+  return (
+    <MyCustomContext.Provider value={myCustomValue}>
+      {children}
+    </MyCustomContext.Provider>
+  )
+}
+
+export const useMyCustomContext = () => useContext(MyCustomContext)
+```
+
+<Banner type="warning">
+  <strong>Reminder:</strong> Custom Providers are by definition Client Components. This means they must include the `use client` directive at the top of their files and cannot use server-only code.
+</Banner>
+
+## Building Custom Components
+
+All Custom Components in Payload are [React Server Components](https://react.dev/reference/rsc/server-components) by default, with the exception of [Custom Providers](#custom-providers). This enables the use of the [Local API](../local-api) directly on the front-end, among other things.
+
+To make building Custom Components as easy as possible, Payload automatically provides common props, such as the [`payload`](../local-api/overview) class and the [`i18n`](../configuration/i18n) object. This means that when building Custom Components within the Admin Panel, you do not have to get these yourself.
+
+Here is an example:
+
+```tsx
+import React from 'react'
+
+const MyServerComponent = async ({
+  payload // highlight-line
+}) => {
+  const page = await payload.findByID({
+    collection: 'pages',
+    id: '123',
+  })
+
+  return (
+    <p>{page.title}</p>
+  )
+}
+```
+
+Each Custom Component receives the following props by default:
+
+| Prop                      | Description                                                                                           |
+| ------------------------- | ----------------------------------------------------------------------------------------------------- |
+| `payload`                 | The [Payload](../local-api/overview) class.                                                           |
+| `i18n`                    | The [i18n](../i18n) object.                                                                           |
+
+Custom Components also receive various other props that are specific to the context in which the Custom Component is being rendered. For example, [Custom Views](./views) receive the `user` prop. For a full list of available props, consult the documentation related to the specific component you are working with.
+
+<Banner type="success">
+  See [Root Components](#root-components), [Collection Components](#collection-components), [Global Components](#global-components), or [Field Components](#custom-field-components) for a complete list of all available components.
+</Banner>
+
+### Client Components
+
+When [Building Custom Components](#building-custom-components), it's still possible to use client-side code such as `useState` or the `window` object. To do this, simply add the `use client` directive at the top of your file. Payload will automatically detect and remove all default, [non-serializable props](https://react.dev/reference/rsc/use-client#serializable-types) before rendering your component.
+
+```tsx
+'use client' // highlight-line
+import React, { useState } from 'react'
+
+export const MyClientComponent: React.FC = () => {
+  const [count, setCount] = useState(0)
+
+  return (
+    <button onClick={() => setCount(count + 1)}>
+      Clicked {count} times
+    </button>
+  )
+}
+```
+
+<Banner type="warning">
+  <strong>Reminder:</strong>
+  Client Components cannot be passed [non-serializable props](https://react.dev/reference/rsc/use-client#serializable-types). If you are rendering your Client Component _from within_ a Server Component, ensure that its props are serializable.
+</Banner>
+
+### Accessing the Payload Config
+
+From any Server Component, the [Payload Config](../configuration/overview) can be accessed directly from the `payload` prop:
+
+```tsx
+import React from 'react'
+
+export default async function MyServerComponent({
+  payload: {
+    config // highlight-line
+  }
+}) {
+  return (
+    <Link href={config.serverURL}>
+      Go Home
+    </Link>
+  )
+}
+```
+
+But, the Payload Config is [non-serializable](https://react.dev/reference/rsc/use-client#serializable-types) by design. It is full of custom validation functions, React components, etc. This means that the Payload Config, in its entirety, cannot be passed directly to Client Components.
+
+For this reason, Payload creates a Client Config and passes it into the Config Provider. This is a serializable version of the Payload Config that can be accessed from any Client Component via the [`useConfig`](./hooks#useconfig) hook:
+
+```tsx
+import React from 'react'
+import { useConfig } from '@payloadcms/ui'
+
+export const MyClientComponent: React.FC = () => {
+  const { config: { serverURL } } = useConfig() // highlight-line
+
+  return (
+    <Link href={serverURL}>
+      Go Home
+    </Link>
+  )
+}
+```
+
+<Banner type="success">
+  See [Using Hooks](#using-hooks) for more details.
+</Banner>
+
+All [Field Components](./fields) automatically receive their respective Field Config through a common [`field`](./fields#the-field-prop) prop:
+
+```tsx
+'use client'
+import React from 'react'
+import type { TextFieldClientComponent } from 'payload'
+
+export const MyClientFieldComponent: TextFieldClientComponent = ({ field: { name } }) => {
+  return (
+    <p>
+      {`This field's name is ${name}`}
+    </p>
+  )
+}
+```
+
+### Using Hooks
+
+To make it easier to [build your Custom Components](#building-custom-components), you can use [Payload's built-in React Hooks](./hooks) in any Client Component. For example, you might want to interact with one of Payload's many React Contexts:
+
+```tsx
+'use client'
+import React from 'react'
+import { useDocumentInfo } from '@payloadcms/ui'
+
+export const MyClientComponent: React.FC = () => {
+  const { slug } = useDocumentInfo() // highlight-line
+
+  return (
+    <p>{`Entity slug: ${slug}`}</p>
+  )
+}
+```
+
+<Banner type="success">
+  See the [Hooks](./hooks) documentation for a full list of available hooks.
+</Banner>
+
+### Getting the Current Language
+
+All Custom Components can support multiple languages to be consistent with Payload's [Internationalization](../configuration/i18n). To do this, first add your translation resources to the [I18n Config](../configuration/i18n).
+
+From any Server Component, you can translate resources using the `getTranslation` function from `@payloadcms/translations`. All Server Components automatically receive the `i18n` object as a prop by default.
+
+```tsx
+import React from 'react'
+import { getTranslation } from '@payloadcms/translations'
+
+export default async function MyServerComponent({ i18n }) {
+  const translatedTitle = getTranslation(myTranslation, i18n) // highlight-line
+
+  return (
+    <p>{translatedTitle}</p>
+  )
+}
+```
+
+The best way to do this within a Client Component is to import the `useTranslation` hook from `@payloadcms/ui`:
+
+```tsx
+import React from 'react'
+import { useTranslation } from '@payloadcms/ui'
+
+export const MyClientComponent: React.FC = () => {
+  const { t, i18n } = useTranslation() // highlight-line
+
+  return (
+    <ul>
+      <li>{t('namespace1:key', { variable: 'value' })}</li>
+      <li>{t('namespace2:key', { variable: 'value' })}</li>
+      <li>{i18n.language}</li>
+    </ul>
+  )
+}
+```
+
+<Banner type="success">
+  See the [Hooks](./hooks) documentation for a full list of available hooks.
+</Banner>
+
+### Getting the Current Locale
+
+All [Custom Views](./views) can support multiple locales to be consistent with Payload's [Localization](../configuration/localization). They automatically receive the `locale` object as a prop by default. This can be used to scope API requests, etc.:
+
+```tsx
+import React from 'react'
+
+export default async function MyServerComponent({ payload, locale }) {
+  const localizedPage = await payload.findByID({
+    collection: 'pages',
+    id: '123',
+    locale,
+  })
+
+  return (
+    <p>{localizedPage.title}</p>
+  )
+}
+```
+
+The best way to do this within a Client Component is to import the `useLocale` hook from `@payloadcms/ui`:
+
+```tsx
+import React from 'react'
+import { useLocale } from '@payloadcms/ui'
+
+const Greeting: React.FC = () => {
+  const locale = useLocale() // highlight-line
+
+  const trans = {
+    en: 'Hello',
+    es: 'Hola',
+  }
+
+  return (
+    <span>{trans[locale.code]}</span>
+  )
+}
+```
+
+<Banner type="success">
+  See the [Hooks](./hooks) documentation for a full list of available hooks.
+</Banner>
+
+### Styling Custom Components
+
+Payload has a robust [CSS Library](./customizing-css) that you can use to style your Custom Components similarly to Payload's built-in styling. This will ensure that your Custom Components match the existing design system, and so that they automatically adapt to any theme changes that might occur.
+
+To apply custom styles, simply import your own `.css` or `.scss` file into your Custom Component:
+
+```tsx
+import './index.scss'
+
+export const MyComponent: React.FC = () => {
+  return (
+    <div className="my-component">
+      My Custom Component
+    </div>
+  )
+}
+```
+
+Then to colorize your Custom Component's background, for example, you can use the following CSS:
+
+```scss
+.my-component {
+  background-color: var(--theme-elevation-500);
+}
+```
+
+Payload also exports its [SCSS](https://sass-lang.com) library for reuse which includes mixins, etc. To use this, simply import it as follows into your `.scss` file:
+
+```scss
+@import '~payload/scss';
+
+.my-component {
+  @include mid-break {
+    background-color: var(--theme-elevation-900);
+  }
+}
+
+```
+
+<Banner type="success">
+  <strong>Note:</strong>
+  You can also drill into Payload's own component styles, or easily apply global, app-wide CSS. More on that [here](./customizing-css).
+</Banner>

docs/admin/customizing-css.mdx

@@ -0,0 +1,73 @@
+---
+title: Customizing CSS & SCSS
+label: Customizing CSS
+order: 80
+desc: Customize the Payload Admin Panel further by adding your own CSS or SCSS style sheet to the configuration, powerful theme and design options are waiting for you.
+keywords: admin, css, scss, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+Customizing the Payload [Admin Panel](./overview) through CSS alone is one of the easiest and most powerful ways to customize the look and feel of the dashboard. To allow for this level of customization, Payload:
+
+1. Exposes a [root-level stylesheet](#global-css) for you to easily to inject custom selectors
+1. Provides a [CSS library](#css-library) that can be easily overridden or extended
+1. Uses [BEM naming conventions](http://getbem.com) so that class names are globally accessible
+
+To customize the CSS within the Admin UI, determine scope and change you'd like to make, and then add your own CSS or SCSS to the configuration as needed.
+
+## Global CSS
+
+Global CSS refers to the CSS that is applied to the entire [Admin Panel](./overview). This is where you can have a significant impact to the look and feel of the Admin UI through just a few lines of code.
+
+You can add your own global CSS through the root `custom.scss` file of your app. This file is loaded into the root of the Admin Panel and can be used to inject custom selectors or styles however needed.
+
+Here is an example of how you might target the Dashboard View and change the background color:
+
+```scss
+.dashboard {
+  background-color: red; // highlight-line
+}
+```
+
+<Banner type="warning">
+  <strong>Note:</strong>
+  If you are building [Custom Components](./overview), it is best to import your own stylesheets directly into your components, rather than using the global stylesheet. You can continue to use the [CSS library](#css-library) as needed.
+</Banner>
+
+## Re-using Payload SCSS variables and utilities
+
+You can re-use Payload's SCSS variables and utilities in your own stylesheets by importing it from the UI package.
+
+```scss
+@import '~@payloadcms/ui/scss';
+```
+
+## CSS Library
+
+To make it as easy as possible for you to override default styles, Payload uses [BEM naming conventions](http://getbem.com/) for all CSS within the Admin UI. If you provide your own CSS, you can override any built-in styles easily, including targeting nested components and their various component states.
+
+You can also override Payload's built-in [CSS Variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties). These variables are widely consumed by the Admin Panel, so modifying them has a significant impact on the look and feel of the Admin UI.
+
+The following variables are defined and can be overridden:
+
+- [Breakpoints](https://github.com/payloadcms/payload/blob/beta/packages/ui/src/scss/queries.scss)
+- [Colors](https://github.com/payloadcms/payload/blob/beta/packages/ui/src/scss/colors.scss)
+  - Base color shades (white to black by default)
+  - Success / warning / error color shades
+  - Theme-specific colors (background, input background, text color, etc.)
+  - Elevation colors (used to determine how "bright" something should be when compared to the background)
+- [Sizing](https://github.com/payloadcms/payload/blob/beta/packages/ui/src/scss/app.scss)
+  - Horizontal gutter
+  - Transition speeds
+  - Font sizes
+  - Etc.
+
+For an up-to-date, comprehensive list of all available variables, please refer to the [Source Code](https://github.com/payloadcms/payload/blob/main/packages/ui/src/scss).
+
+<Banner type="warning">
+  <strong>Warning:</strong>
+  If you're overriding colors or theme elevations, make sure to consider how [your changes will affect dark mode](#dark-mode).
+</Banner>
+
+#### Dark Mode
+
+Colors are designed to automatically adapt to theme of the [Admin Panel](./overview). By default, Payload automatically overrides all `--theme-elevation` colors and inverts all success / warning / error shades to suit dark mode. We also update some base theme variables like `--theme-bg`, `--theme-text`, etc.

docs/admin/fields.mdx

@@ -0,0 +1,567 @@
+---
+title: Customizing Fields
+label: Customizing Fields
+order: 60
+desc:
+keywords:
+---
+
+[Fields](../fields/overview) within the [Admin Panel](./overview) can be endlessly customized in their appearance and behavior without affecting their underlying data structure. Fields are designed to withstand heavy modification or even complete replacement through the use of [Custom Field Components](#field-components), [Conditional Logic](#conditional-logic), [Custom Validations](../fields/overview#validation), and more.
+
+For example, your app might need to render a specific interface that Payload does not inherently support, such as a color picker. To do this, you could replace the default [Text Field](../fields/text) input with your own user-friendly component that formats the data into a valid color value.
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  Don't see a built-in field type that you need? Build it! Using a combination of [Field Validations](../fields/overview#validation)
+  and [Custom Components](./components), you can override the entirety of how a component functions within the [Admin Panel](./overview) to effectively create your own field type.
+</Banner>
+
+## Admin Options
+
+You can customize the appearance and behavior of fields within the [Admin Panel](./overview) through the `admin` property of any [Field Config](../fields/overview):
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const CollectionConfig: CollectionConfig = {
+  // ...
+  fields: [
+    // ...
+    {
+      name: 'myField',
+      type: 'text',
+      admin: { // highlight-line
+        // ...
+      },
+    }
+  ]
+}
+```
+
+The following options are available:
+
+| Option              | Description                                                                                                                                                                                                                      |
+| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`condition`**         | Programmatically show / hide fields based on other fields. [More details](../admin/fields#conditional-logic).                                                                                               |
+| **`components`**        | All Field Components can be swapped out for [Custom Components](../admin/components) that you define. [More details](../admin/fields).                                                                             |
+| **`description`**       | Helper text to display alongside the field to provide more information for the editor. [More details](../admin/fields#description).                                                                                                 |
+| **`position`**          | Specify if the field should be rendered in the sidebar by defining `position: 'sidebar'`.                                                                                                                                        |
+| **`width`**             | Restrict the width of a field. You can pass any string-based value here, be it pixels, percentages, etc. This property is especially useful when fields are nested within a `Row` type where they can be organized horizontally. |
+| **`style`**         | [CSS Properties](https://developer.mozilla.org/en-US/docs/Web/CSS) to inject into the root element of the field.                                                                                                           |
+| **`className`**         | Attach a [CSS class attribute](https://developer.mozilla.org/en-US/docs/Web/CSS/Class_selectors) to the root DOM element of a field.                                                                                                                                                                      |
+| **`readOnly`**          | Setting a field to `readOnly` has no effect on the API whatsoever but disables the admin component's editability to prevent editors from modifying the field's value.                                                            |
+| **`disabled`**          | If a field is `disabled`, it is completely omitted from the [Admin Panel](../admin/overview).                                                                                                                                                         |
+| **`disableBulkEdit`**   | Set `disableBulkEdit` to `true` to prevent fields from appearing in the select options when making edits for multiple documents.                                                                                                 |
+| **`disableListColumn`** | Set `disableListColumn` to `true` to prevent fields from appearing in the list view column selector.                                                                                                                             |
+| **`disableListFilter`** | Set `disableListFilter` to `true` to prevent fields from appearing in the list view filter options.                                                                                                                              |
+| **`hidden`**            | Will transform the field into a `hidden` input type. Its value will still submit with requests in the Admin Panel, but the field itself will not be visible to editors.        |
+
+## Field Components
+
+Within the [Admin Panel](./overview), fields are rendered in three distinct places:
+
+- [Field](#the-field-component) - The actual form field rendered in the Edit View.
+- [Cell](#the-cell-component) - The table cell component rendered in the List View.
+- [Filter](#the-filter-component) - The filter component rendered in the List View.
+
+To easily swap in Field Components with your own, use the `admin.components` property in your [Field Config](../fields/overview):
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const CollectionConfig: CollectionConfig = {
+  // ...
+  fields: [
+    // ...
+    {
+      // ...
+      admin: {
+        components: { // highlight-line
+          // ...
+        },
+      },
+    }
+  ]
+}
+```
+
+The following options are available:
+
+| Component    | Description                                                                                                                 |
+| ---------- | --------------------------------------------------------------------------------------------------------------------------- |
+| **`Field`**  | The form field rendered of the Edit View. [More details](#the-field-component).                                                |
+| **`Cell`**   | The table cell rendered of the List View. [More details](#the-cell-component).              |
+| **`Filter`** | The filter component rendered in the List View. [More details](#the-filter-component). || Component         | Description                                                                                                     |
+| **`Label`**       | Override the default Label of the Field Component. [More details](#the-label-component).                                    |
+| **`Error`**       | Override the default Error of the Field Component. [More details](#the-error-component).                                    |
+| **`Description`** | Override the default Description of the Field Component. [More details](#the-description-component).                      |
+| **`beforeInput`** | An array of elements that will be added before the input of the Field Component. [More details](#afterinput-and-beforeinput).|
+| **`afterInput`**  | An array of elements that will be added after the input of the Field Component. [More details](#afterinput-and-beforeinput). |
+
+_\* **`beforeInput`** and **`afterInput`** are only supported in fields that do not contain other fields, such as [`Text`](../fields/text), and [`Textarea`](../fields/textarea)._
+
+### The Field Component
+
+The Field Component is the actual form field rendered in the Edit View. This is the input that user's will interact with when editing a document.
+
+To easily swap in your own Field Component, use the `admin.components.Field` property in your [Field Config](../fields/overview):
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const CollectionConfig: CollectionConfig = {
+  // ...
+  fields: [
+    // ...
+    {
+      // ...
+      admin: {
+        components: {
+          Field: '/path/to/MyFieldComponent', // highlight-line
+        },
+      },
+    }
+  ]
+}
+```
+
+_For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components)._
+
+<Banner type="warning">
+  Instead of replacing the entire Field Component, you can alternately replace or slot-in only specific parts by using the [`Label`](#the-label-component), [`Error`](#the-error-component), [`beforeInput`](#afterinput-and-beforinput), and [`afterInput`](#afterinput-and-beforinput) properties.
+</Banner>
+
+All Field Components receive the following props:
+
+| Property         | Description                                                                                                                                                                                                                      |
+| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`docPreferences`** | An object that contains the [Preferences](./preferences) for the document.
+| **`field`** | The field's config. [More details](#the-field-prop) |
+| **`locale`**     | The locale of the field. [More details](../configuration/localization).                                                                                                                                                                   |
+| **`readOnly`**   | A boolean value that represents if the field is read-only or not.                                                                                                                                                                  |
+| **`user`**       | The currently authenticated user. [More details](../authentication/overview). |
+| **`validate`**   | A function that can be used to validate the field.                                                                                                                                                                                 |
+
+<Banner type="success">
+  <strong>Reminder:</strong>
+  All [Custom Server Components](./components) receive the `payload` and `i18n` properties by default. See [Building Custom Components](./components#building-custom-components) for more details.
+</Banner>
+
+#### Sending and receiving values from the form
+
+When swapping out the `Field` component, you are responsible for sending and receiving the field's `value` from the form itself.
+
+To do so, import the [`useField`](./hooks#usefield) hook from `@payloadcms/ui` and use it to manage the field's value:
+
+```tsx
+'use client'
+import { useField } from '@payloadcms/ui'
+
+export const CustomTextField: React.FC = () => {
+  const { value, setValue } = useField() // highlight-line
+
+  return (
+    <input
+      onChange={(e) => setValue(e.target.value)}
+      value={value}
+    />
+  )
+}
+```
+
+<Banner type="success">
+  For a complete list of all available React hooks, see the [Payload React Hooks](./hooks) documentation. For additional help, see [Building Custom Components](./components#building-custom-components).
+</Banner>
+
+#### TypeScript
+
+When building Custom Field Components, you can import the component type to ensure type safety. There is an explicit type for the Field Component, one for every [Field Type](../fields/overview) and for every client/server environment. The convention is to prepend the field type onto the target type, i.e. `TextFieldClientComponent`:
+
+```tsx
+import type {
+  TextFieldClientComponent,
+  TextFieldServerComponent,
+  TextFieldClientProps,
+  TextFieldServerProps,
+  // ...and so on for each Field Type
+} from 'payload'
+```
+
+### The `field` Prop
+
+All Field Components are passed their own Field Config through a common `field` prop. Within a Server Component, this is the raw Field Config. Within Client Components, however, the raw Field Config is [non-serializable](https://react.dev/reference/rsc/use-client#serializable-types). Instead, Client Components receives a [Client Config](./components#accessing-the-payload-config), which is a sanitizes version of the Field Config that is safe to pass into Client Components.
+
+The exact shape of this prop is unique to the specific [Field Type](../fields/overview) being rendered, minus all non-serializable properties. Any [Custom Components](../components) are also resolved into a "mapped component" that is safe to pass.
+
+```tsx
+import React from 'react'
+import type { TextFieldServerComponent } from 'payload'
+
+export const MyServerTextField: TextFieldServerComponent = ({ payload, field: { name } }) => {
+  const result = await payload.find({
+    collection: 'myCollection',
+    depth: 1,
+  })
+
+  // ...
+}
+```
+
+Client Component:
+
+```tsx
+'use client'
+import React from 'react'
+import type { TextFieldClientComponent } from 'payload'
+
+export const MyClientTextField: TextFieldClientComponent = ({ field: { name } }) => {
+  return (
+    <p>
+      {`This field's name is ${name}`}
+    </p>
+  )
+}
+```
+
+The following additional properties are also provided to the `field` prop:
+
+| Property         | Description                                                                                                                                                                                                                      |
+| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`_isPresentational`** | A boolean indicating that the field is purely visual and does not directly affect data or change data shape, i.e. the [UI Field](../fields/ui). |
+| **`_path`** | A string representing the direct, dynamic path to the field at runtime, i.e. `myGroup.myArray[0].myField`. |
+| **`_schemaPath`** | A string representing the direct, static path to the [Field Config](../fields/overview), i.e. `myGroup.myArray.myField` |
+
+<Banner type="info">
+  <strong>Note:</strong>
+  These properties are underscored to denote that they are not part of the original Field Config, and instead are attached during client sanitization to make fields easier to work with on the front-end.
+</Banner>
+
+#### TypeScript
+
+When building Custom Field Components, you can import the client field props to ensure type safety in your component. There is an explicit type for the Field Component, one for every [Field Type](../fields/overview) and server/client environment. The convention is to prepend the field type onto the target type, i.e. `TextFieldClientComponent`:
+
+```tsx
+import type {
+  TextFieldClientComponent,
+  TextFieldServerComponent,
+  TextFieldClientProps,
+  TextFieldServerProps,
+  // ...and so on for each Field Type
+} from 'payload'
+```
+
+### The Cell Component
+
+The Cell Component is rendered in the table of the List View. It represents the value of the field when displayed in a table cell.
+
+To easily swap in your own Cell Component, use the `admin.components.Cell` property in your [Field Config](../fields/overview):
+
+```ts
+import type { Field } from 'payload'
+
+export const myField: Field = {
+  name: 'myField',
+  type: 'text',
+  admin: {
+    components: {
+      Cell: '/path/to/MyCustomCellComponent', // highlight-line
+    },
+  },
+}
+```
+
+_For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components)._
+
+All Cell Components receive the following props:
+
+| Property         | Description                                                       |
+| ---------------- | ----------------------------------------------------------------- |
+| **`field`** | The sanitized, client-friendly version of the field's config. [More details](#the-field-prop) |
+| **`link`** | A boolean representing whether this cell should be wrapped in a link. |
+| **`onClick`** | A function that is called when the cell is clicked. |
+
+<Banner type="info">
+  <strong>Tip:</strong>
+  Use the [`useTableCell`](./hooks#usetablecell) hook to subscribe to the field's `cellData` and `rowData`.
+</Banner>
+
+<Banner type="success">
+  <strong>Reminder:</strong>
+  All [Custom Server Components](./components) receive the `payload` and `i18n` properties by default. See [Building Custom Components](./components#building-custom-components) for more details.
+</Banner>
+
+### The Label Component
+
+The Label Component is rendered anywhere a field needs to be represented by a label. This is typically used in the Edit View, but can also be used in the List View and elsewhere.
+
+To easily swap in your own Label Component, use the `admin.components.Label` property in your [Field Config](../fields/overview):
+
+```ts
+import type { Field } from 'payload'
+
+export const myField: Field = {
+  name: 'myField',
+  type: 'text',
+  admin: {
+    components: {
+      Label: '/path/to/MyCustomLabelComponent', // highlight-line
+    },
+  },
+}
+```
+
+_For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components)._
+
+Custom Label Components receive all [Field Component](#the-field-component) props, plus the following props:
+
+| Property       | Description                                                      |
+| -------------- | ---------------------------------------------------------------- |
+| **`field`** | The sanitized, client-friendly version of the field's config. [More details](#the-field-prop) |
+
+<Banner type="success">
+  <strong>Reminder:</strong>
+  All [Custom Server Components](./components) receive the `payload` and `i18n` properties by default. See [Building Custom Components](./components#building-custom-components) for more details.
+</Banner>
+
+#### TypeScript
+
+When building Custom Label Components, you can import the component props to ensure type safety in your component. There is an explicit type for the Label Component, one for every [Field Type](../fields/overview) and server/client environment. The convention is to append `LabelServerComponent` or `LabelClientComponent` to the type of field, i.e. `TextFieldLabelClientComponent`.
+
+```tsx
+import type {
+  TextFieldLabelServerComponent,
+  TextFieldLabelClientComponent,
+  // ...and so on for each Field Type
+} from 'payload'
+```
+
+### The Error Component
+
+The Error Component is rendered when a field fails validation. It is typically displayed beneath the field input in a visually-compelling style.
+
+To easily swap in your own Error Component, use the `admin.components.Error` property in your [Field Config](../fields/overview):
+
+```ts
+import type { Field } from 'payload'
+
+export const myField: Field = {
+  name: 'myField',
+  type: 'text',
+  admin: {
+    components: {
+      Error: '/path/to/MyCustomErrorComponent', // highlight-line
+    },
+  },
+}
+```
+
+_For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components)._
+
+Custom Error Components receive all [Field Component](#the-field-component) props, plus the following props:
+
+| Property        | Description                                                   |
+| --------------- | ------------------------------------------------------------- |
+| **`field`** | The sanitized, client-friendly version of the field's config. [More details](#the-field-prop) |
+
+<Banner type="success">
+  <strong>Reminder:</strong>
+  All [Custom Server Components](./components) receive the `payload` and `i18n` properties by default. See [Building Custom Components](./components#building-custom-components) for more details.
+</Banner>
+
+#### TypeScript
+
+When building Custom Error Components, you can import the component props to ensure type safety in your component. There is an explicit type for the Error Component, one for every [Field Type](../fields/overview) and server/client environment. The convention is to append `ErrorServerComponent` or `ErrorClientComponent` to the type of field, i.e. `TextFieldErrorClientComponent`.
+
+```tsx
+import type {
+  TextFieldErrorServerComponent,
+  TextFieldErrorClientComponent,
+  // And so on for each Field Type
+} from 'payload'
+```
+
+### The Description Property
+
+Field Descriptions are used to provide additional information to the editor about a field, such as special instructions. Their placement varies from field to field, but typically are displayed with subtle style differences beneath the field inputs.
+
+A description can be configured in three ways:
+
+  - As a string.
+  - As a function which returns a string. [More details](#description-functions).
+  - As a React component. [More details](#the-description-component).
+
+To easily add a Custom Description to a field, use the `admin.description` property in your [Field Config](../fields/overview):
+
+```ts
+import type { SanitizedCollectionConfig } from 'payload'
+
+export const MyCollectionConfig: SanitizedCollectionConfig = {
+  // ...
+  fields: [
+    // ...
+    {
+      name: 'myField',
+      type: 'text',
+      admin: {
+        description: 'Hello, world!' // highlight-line
+      },
+    },
+  ]
+}
+```
+
+<Banner type="warning">
+  <strong>Reminder:</strong>
+  To replace the Field Description with a [Custom Component](./components), use the `admin.components.Description` property. [More details](#the-description-component).
+</Banner>
+
+#### Description Functions
+
+Custom Descriptions can also be defined as a function. Description Functions are executed on the server and can be used to format simple descriptions based on the user's current [Locale](../configuration/localization).
+
+To easily add a Description Function to a field, set the `admin.description` property to a _function_ in your [Field Config](../fields/overview):
+
+```ts
+import type { SanitizedCollectionConfig } from 'payload'
+
+export const MyCollectionConfig: SanitizedCollectionConfig = {
+  // ...
+  fields: [
+    // ...
+    {
+      name: 'myField',
+      type: 'text',
+      admin: {
+        description: ({ t }) => `${t('Hello, world!')}` // highlight-line
+      },
+    },
+  ]
+}
+```
+
+All Description Functions receive the following arguments:
+
+| Argument       | Description                                                      |
+| -------------- | ---------------------------------------------------------------- |
+| **`t`**        | The `t` function used to internationalize the Admin Panel. [More details](../configuration/i18n) |
+
+### The Description Component
+
+Alternatively to the [Description Property](#the-description-property), you can also use a [Custom Component](./components) as the Field Description. This can be useful when you need to provide more complex feedback to the user, such as rendering dynamic field values or other interactive elements.
+
+To easily add a Description Component to a field, use the `admin.components.Description` property in your [Field Config](../fields/overview):
+
+```ts
+import type { SanitizedCollectionConfig } from 'payload'
+
+export const MyCollectionConfig: SanitizedCollectionConfig = {
+  // ...
+  fields: [
+    // ...
+    {
+      name: 'myField',
+      type: 'text',
+      admin: {
+        components: {
+          Description: '/path/to/MyCustomDescriptionComponent', // highlight-line
+        }
+      }
+    }
+  ]
+}
+```
+
+_For details on how to build a Custom Description, see [Building Custom Components](./components#building-custom-components)._
+
+Custom Description Components receive all [Field Component](#the-field-component) props, plus the following props:
+
+| Property       | Description                                                      |
+| -------------- | ---------------------------------------------------------------- |
+| **`field`** | The sanitized, client-friendly version of the field's config. [More details](#the-field-prop) |
+
+<Banner type="success">
+  <strong>Reminder:</strong>
+  All [Custom Server Components](./components) receive the `payload` and `i18n` properties by default. See [Building Custom Components](./components#building-custom-components) for more details.
+</Banner>
+
+#### TypeScript
+
+When building Custom Description Components, you can import the component props to ensure type safety in your component. There is an explicit type for the Description Component, one for every [Field Type](../fields/overview) and server/client environment. The convention is to append `DescriptionServerComponent` or `DescriptionClientComponent` to the type of field, i.e. `TextFieldDescriptionClientComponent`.
+
+```tsx
+import type {
+  TextFieldDescriptionServerComponent,
+  TextFieldDescriptionClientComponent,
+  // And so on for each Field Type
+} from 'payload'
+```
+
+### afterInput and beforeInput
+
+With these properties you can add multiple components _before_ and _after_ the input element, as their name suggests. This is useful when you need to render additional elements alongside the field without replacing the entire field component.
+
+To add components before and after the input element, use the `admin.components.beforeInput` and `admin.components.afterInput` properties in your [Field Config](../fields/overview):
+
+```ts
+import type { SanitizedCollectionConfig } from 'payload'
+
+export const MyCollectionConfig: SanitizedCollectionConfig = {
+  // ...
+  fields: [
+    // ...
+    {
+      name: 'myField',
+      type: 'text',
+      admin: {
+        components: {
+          // highlight-start
+          beforeInput: ['/path/to/MyCustomComponent'],
+          afterInput: ['/path/to/MyOtherCustomComponent'],
+          // highlight-end
+        }
+      }
+    }
+  ]
+}
+```
+
+_For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components)._
+
+## Conditional Logic
+
+You can show and hide fields based on what other fields are doing by utilizing conditional logic on a field by field basis. The `condition` property on a field's admin config accepts a function which takes three arguments:
+
+- `data` - the entire document's data that is currently being edited
+- `siblingData` - only the fields that are direct siblings to the field with the condition
+- `{ user }` - the final argument is an object containing the currently authenticated user
+
+The `condition` function should return a boolean that will control if the field should be displayed or not.
+
+**Example:**
+
+```ts
+{
+  fields: [
+    {
+      name: 'enableGreeting',
+      type: 'checkbox',
+      defaultValue: false,
+    },
+    {
+      name: 'greeting',
+      type: 'text',
+      admin: {
+        // highlight-start
+        condition: (data, siblingData, { user }) => {
+          if (data.enableGreeting) {
+            return true
+          } else {
+            return false
+          }
+        },
+        // highlight-end
+      },
+    },
+  ]
+}
+```

docs/admin/globals.mdx

@@ -0,0 +1,107 @@
+---
+title: Global Admin Config
+label: Globals
+order: 30
+desc:
+keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+The behavior of [Globals](../configuration/globals) within the [Admin Panel](./overview) can be fully customized to fit the needs of your application. This includes grouping or hiding their navigation links, adding [Custom Components](./components), setting page metadata, and more.
+
+To configure Admin Options for Globals, use the `admin` property in your Global Config:
+
+```ts
+import { GlobalConfig } from 'payload'
+
+export const MyGlobal: GlobalConfig = {
+  // ...
+  admin: { // highlight-line
+    // ...
+  },
+}
+```
+
+## Admin Options
+
+The following options are available:
+
+| Option        | Description                                                                                                                       |
+| ------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| **`group`**       | Text used as a label for grouping Collection and Global links together in the navigation.                                         |
+| **`hidden`**      | Set to true or a function, called with the current user, returning true to exclude this Global from navigation and admin routing. |
+| **`components`**  | Swap in your own React components to be used within this Global. [More details](#components).                           |
+| **`preview`**     | Function to generate a preview URL within the Admin Panel for this Global that can point to your app. [More details](#preview).           |
+| **`livePreview`** | Enable real-time editing for instant visual feedback of your front-end application. [More details](../live-preview/overview).          |
+| **`hideAPIURL`**  | Hides the "API URL" meta field while editing documents within this collection.                                                    |
+| **`meta`**        | Page metadata overrides to apply to this Global within the Admin Panel. [More details](./metadata).                                                                           |
+
+### Components
+
+Globals can set their own [Custom Components](./components) which only apply to [Global](../configuration/globals)-specific UI within the [Admin Panel](./overview). This includes elements such as the Save Button, or entire layouts such as the Edit View.
+
+To override Global Components, use the `admin.components` property in your [Global Config](../configuration/globals):
+
+```ts
+import type { SanitizedGlobalConfig } from 'payload'
+
+export const MyGlobal: SanitizedGlobalConfig = {
+  // ...
+  admin: {
+    components: { // highlight-line
+      // ...
+    },
+  },
+}
+```
+
+The following options are available:
+
+| Path                           | Description                                                                                                            |
+| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
+| **`elements.SaveButton`**      | Replace the default Save Button with a Custom Component. [Drafts](../versions/drafts) must be disabled.                                    |
+| **`elements.SaveDraftButton`** | Replace the default Save Draft Button with a Custom Component. [Drafts](../versions/drafts) must be enabled and autosave must be disabled. |
+| **`elements.PublishButton`**   | Replace the default Publish Button with a Custom Component. [Drafts](../versions/drafts) must be enabled.                                  |
+| **`elements.PreviewButton`**   | Replace the default Preview Button with a Custom Component. [Preview](#preview) must be enabled.                                         |
+| **`views`**                    | Override or create new views within the Admin Panel. [More details](./views).                                     |
+
+<Banner type="success">
+  <strong>Note:</strong>
+  For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components).
+</Banner>
+
+### Preview
+
+It is possible to display a Preview Button within the Edit View of the Admin Panel. This will allow editors to visit the frontend of your app the corresponds to the document they are actively editing. This way they can preview the latest, potentially unpublished changes.
+
+To configure the Preview Button, set the `admin.preview` property to a function in your Global Config:
+
+```ts
+import { GlobalConfig } from 'payload'
+
+export const MainMenu: GlobalConfig = {
+  // ...
+  admin: {
+    // highlight-start
+    preview: (doc, { locale }) => {
+      if (doc?.slug) {
+        return `/${doc.slug}?locale=${locale}`
+      }
+
+      return null
+    },
+    // highlight-end
+  },
+}
+```
+
+The preview function receives two arguments:
+
+| Argument | Description |
+| --- | --- |
+| **`doc`** | The Document being edited. |
+| **`ctx`** | An object containing `locale` and `token` properties. The `token` is the currently logged-in user's JWT. |
+
+<Banner type="success">
+  <strong>Note:</strong>
+  For fully working example of this, check of the official [Draft Preview Example](https://github.com/payloadcms/payload/tree/main/examples/draft-preview) in the [Examples Directory](https://github.com/payloadcms/payload/tree/main/examples).
+</Banner>

docs/admin/hooks.mdx

@@ -0,0 +1,949 @@
+---
+title: React Hooks
+label: React Hooks
+order: 70
+desc: Make use of all of the powerful React hooks that Payload provides.
+keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+Payload provides a variety of powerful [React Hooks](https://react.dev/reference/react-dom/hooks) that can be used within your own [Custom Components](./components), such as [Custom Fields](./fields). With them, you can interface with Payload itself to build just about any type of complex customization you can think of.
+
+<Banner type="warning">
+  <strong>Reminder:</strong>
+  All Custom Components are [React Server Components](https://react.dev/reference/rsc/server-components) by default. Hooks, on the other hand, are only available in client-side environments. To use hooks, [ensure your component is a client component](./components#client-components).
+</Banner>
+
+## useField
+
+The `useField` hook is used internally within all field components. It manages sending and receiving a field's state from its parent form. When you build a [Custom Field Component](./fields), you will be responsible for sending and receiving the field's `value` to and from the form yourself.
+
+To do so, import the `useField` hook as follows:
+
+```tsx
+'use client'
+import { useField } from '@payloadcms/ui'
+
+const CustomTextField: React.FC = () => {
+  const { value, setValue, path } = useField() // highlight-line
+
+  return (
+    <div>
+      <p>
+        {path}
+      </p>
+      <input
+        onChange={(e) => { setValue(e.target.value) }}
+        value={value}
+      />
+    </div>
+  )
+}
+```
+
+The `useField` hook accepts the following arguments:
+
+| Property          | Description                                                                                                                                                                                                                   |
+| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `path`            | If you do not provide a `path` or a `name`, this hook will look for one using the [`useFieldProps`](#usefieldprops) hook.                                                                                                                         |
+| `validate`        | A validation function executed client-side _before_ submitting the form to the server. Different than [Field-level Validation](../fields/overview#validation) which runs strictly on the server. |
+| `disableFormData` | If `true`, the field will not be included in the form data when the form is submitted.                                                                                                                                         |
+| `hasRows` | If `true`, the field will be treated as a field with rows. This is useful for fields like `array` and `blocks`.                                                                                                                                         |
+
+The `useField` hook returns the following object:
+
+```ts
+type FieldType<T> = {
+  errorMessage?: string
+  errorPaths?: string[]
+  filterOptions?: FilterOptionsResult
+  formInitializing: boolean
+  formProcessing: boolean
+  formSubmitted: boolean
+  initialValue?: T
+  path: string
+  permissions: FieldPermissions
+  readOnly?: boolean
+  rows?: Row[]
+  schemaPath: string
+  setValue: (val: unknown, disableModifyingForm?: boolean) => void
+  showError: boolean
+  valid?: boolean
+  value: T
+}
+```
+
+## useFieldProps
+
+[Custom Field Components](./fields#the-field-component) can be rendered on the server. When using a server component as a custom field component, you can access dynamic props from within any client component rendered by your custom server component. This is done using the `useFieldProps` hook. This is important because some fields can be dynamic, such as when nested in an [`array`](../fields/array) or [`blocks`](../fields/block) field. For example, items can be added, re-ordered, or deleted on-the-fly.
+
+You can use the `useFieldProps` hooks to access dynamic props like `path`:
+
+```tsx
+'use client'
+import { useFieldProps } from '@payloadcms/ui'
+
+const CustomTextField: React.FC = () => {
+  const { path } = useFieldProps() // highlight-line
+
+  return (
+    <div>
+      {path}
+    </div>
+  )
+}
+```
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  The [`useField`](#usefield) hook calls the `useFieldProps` hook internally, so you don't need to use both in the same component unless explicitly needed.
+</Banner>
+
+## useFormFields
+
+There are times when a custom field component needs to have access to data from other fields, and you have a few options to do so. The `useFormFields` hook is a powerful and highly performant way to retrieve a form's field state, as well as to retrieve the `dispatchFields` method, which can be helpful for setting other fields' form states from anywhere within a form.
+
+<Banner type="success">
+  <strong>This hook is great for retrieving only certain fields from form state</strong> because it
+  ensures that it will only cause a rerender when the items that you ask for change.
+</Banner>
+
+Thanks to the awesome package [`use-context-selector`](https://github.com/dai-shi/use-context-selector), you can retrieve a specific field's state easily. This is ideal because you can ensure you have an up-to-date field state, and your component will only re-render when _that field's state_ changes.
+
+You can pass a Redux-like selector into the hook, which will ensure that you retrieve only the field that you want. The selector takes an argument with type of `[fields: Fields, dispatch: React.Dispatch<Action>]]`.
+
+```tsx
+'use client'
+import type { useFormFields } from '@payloadcms/ui'
+
+const MyComponent: React.FC = () => {
+  // Get only the `amount` field state, and only cause a rerender when that field changes
+  const amount = useFormFields(([fields, dispatch]) => fields.amount)
+
+  // Do the same thing as above, but to the `feePercentage` field
+  const feePercentage = useFormFields(([fields, dispatch]) => fields.feePercentage)
+
+  if (typeof amount?.value !== 'undefined' && typeof feePercentage?.value !== 'undefined') {
+    return <span>The fee is ${(amount.value * feePercentage.value) / 100}</span>
+  }
+}
+```
+
+## useAllFormFields
+
+**To retrieve more than one field**, you can use the `useAllFormFields` hook. Your component will re-render when _any_ field changes, so use this hook only if you absolutely need to. Unlike the `useFormFields` hook, this hook does not accept a "selector", and it always returns an array with type of `[fields: Fields, dispatch: React.Dispatch<Action>]]`.
+
+You can do lots of powerful stuff by retrieving the full form state, like using built-in helper functions to reduce field state to values only, or to retrieve sibling data by path.
+
+```tsx
+'use client'
+import { useAllFormFields } from '@payloadcms/ui'
+import { reduceFieldsToValues, getSiblingData } from 'payload/shared'
+
+const ExampleComponent: React.FC = () => {
+  // the `fields` const will be equal to all fields' state,
+  // and the `dispatchFields` method is usable to send field state up to the form
+  const [fields, dispatchFields] = useAllFormFields();
+
+  // Pass in fields, and indicate if you'd like to "unflatten" field data.
+  // The result below will reflect the data stored in the form at the given time
+  const formData = reduceFieldsToValues(fields, true);
+
+  // Pass in field state and a path,
+  // and you will be sent all sibling data of the path that you've specified
+  const siblingData = getSiblingData(fields, 'someFieldName');
+
+  return (
+    // return some JSX here if necessary
+  )
+};
+```
+
+#### Updating other fields' values
+
+If you are building a Custom Component, then you should use `setValue` which is returned from the `useField` hook to programmatically set your field's value. But if you're looking to update _another_ field's value, you can use `dispatchFields` returned from `useFormFields`.
+
+You can send the following actions to the `dispatchFields` function.
+
+| Action                 | Description                                                                |
+| ---------------------- | -------------------------------------------------------------------------- |
+| **`ADD_ROW`**          | Adds a row of data (useful in array / block field data)                    |
+| **`DUPLICATE_ROW`**    | Duplicates a row of data (useful in array / block field data)              |
+| **`MODIFY_CONDITION`** | Updates a field's conditional logic result (true / false)                  |
+| **`MOVE_ROW`**         | Moves a row of data (useful in array / block field data)                   |
+| **`REMOVE`**           | Removes a field from form state                                            |
+| **`REMOVE_ROW`**       | Removes a row of data from form state (useful in array / block field data) |
+| **`REPLACE_STATE`**    | Completely replaces form state                                             |
+| **`UPDATE`**           | Update any property of a specific field's state                            |
+
+To see types for each action supported within the `dispatchFields` hook, check out the Form types [here](https://github.com/payloadcms/payload/blob/main/packages/payload/src/admin/components/forms/Form/types.ts).
+
+## useForm
+
+The `useForm` hook can be used to interact with the form itself, and sends back many methods that can be used to reactively fetch form state without causing rerenders within your components each time a field is changed. This is useful if you have action-based callbacks that your components fire, and need to interact with form state _based on a user action_.
+
+<Banner type="warning">
+  <strong>Warning:</strong>
+  <br />
+  This hook is optimized to avoid causing rerenders when fields change, and as such, its `fields`
+  property will be out of date. You should only leverage this hook if you need to perform actions
+  against the form in response to your users' actions. Do not rely on its returned "fields" as being
+  up-to-date. They will be removed from this hook's response in an upcoming version.
+</Banner>
+
+The `useForm` hook returns an object with the following properties:
+
+<TableWithDrawers
+  columns={[
+    'Action',
+    'Description',
+    'Example',
+  ]}
+  rows={[
+    [
+      {
+        value: <strong><code>fields</code></strong>,
+      },
+      {
+        value: "Deprecated. This property cannot be relied on as up-to-date.",
+      },
+      {
+        value: ''
+      }
+    ],
+    [
+      {
+        value: <strong><code>submit</code></strong>,
+      },
+      {
+        value: "Method to trigger the form to submit",
+      },
+      {
+        value: ''
+      }
+    ],
+    [
+      {
+        value: <strong><code>dispatchFields</code></strong>,
+      },
+      {
+        value: "Dispatch actions to the form field state",
+      },
+      {
+        value: ''
+      }
+    ],
+    [
+      {
+        value: <strong><code>validateForm</code></strong>,
+      },
+      {
+        value: "Trigger a validation of the form state",
+      },
+      {
+        value: ''
+      }
+    ],
+    [
+      {
+        value: <strong><code>createFormData</code></strong>,
+      },
+      {
+        value: <>Create a <code>multipart/form-data</code> object from the current form's state</>,
+      },
+      {
+        value: ''
+      }
+    ],
+    [
+      {
+        value: <strong><code>disabled</code></strong>,
+      },
+      {
+        value: "Boolean denoting whether or not the form is disabled",
+      },
+      {
+        value: ''
+      }
+    ],
+    [
+      {
+        value: <strong><code>getFields</code></strong>,
+      },
+      {
+        value: 'Gets all fields from state',
+      },
+      {
+        value: '',
+      }
+    ],
+    [
+      {
+        value: <strong><code>getField</code></strong>,
+      },
+      {
+        value: 'Gets a single field from state by path',
+      },
+      {
+        value: '',
+      },
+    ],
+    [
+      {
+        value: <strong><code>getData</code></strong>,
+      },
+      {
+        value: 'Returns the data stored in the form',
+      },
+      {
+        value: '',
+      },
+    ],
+    [
+      {
+        value: <strong><code>getSiblingData</code></strong>,
+      },
+      {
+        value: 'Returns form sibling data for the given field path',
+      },
+      {
+        value: '',
+      },
+    ],
+    [
+      {
+        value: <strong><code>setModified</code></strong>,
+      },
+      {
+        value: <>Set the form\'s <code>modified</code> state</>,
+      },
+      {
+        value: '',
+      },
+    ],
+    [
+      {
+        value: <strong><code>setProcessing</code></strong>,
+      },
+      {
+        value: <>Set the form\'s <code>processing</code> state</>,
+      },
+      {
+        value: '',
+      },
+    ],
+    [
+      {
+        value: <strong><code>setSubmitted</code></strong>,
+      },
+      {
+        value: <>Set the form\'s <code>submitted</code> state</>,
+      },
+      {
+        value: '',
+      },
+    ],
+    [
+      {
+        value: <strong><code>formRef</code></strong>,
+      },
+      {
+        value: 'The ref from the form HTML element',
+      },
+      {
+        value: '',
+      },
+    ],
+    [
+      {
+        value: <strong><code>reset</code></strong>,
+      },
+      {
+        value: 'Method to reset the form to its initial state',
+      },
+      {
+        value: '',
+      },
+    ],
+    [
+      {
+        value: <strong><code>addFieldRow</code></strong>,
+      },
+      {
+        value: "Method to add a row on an array or block field",
+      },
+      {
+        drawerTitle: 'addFieldRow',
+        drawerDescription: 'A useful method to programmatically add a row to an array or block field.',
+        drawerSlug: 'addFieldRow',
+        drawerContent: (
+<>
+  <TableWithDrawers
+    columns={[
+      'Prop',
+      'Description',
+    ]}
+    rows={[
+      [
+        {
+          value: <strong><code>path</code></strong>,
+        },
+        {
+          value: "The path to the array or block field",
+        },
+      ],
+      [
+        {
+          value: <strong><code>rowIndex</code></strong>,
+        },
+        {
+          value: "The index of the row to add. If omitted, the row will be added to the end of the array.",
+        },
+      ],
+      [
+        {
+          value: <strong><code>data</code></strong>,
+        },
+        {
+          value: "The data to add to the row",
+        },
+      ],
+    ]}
+  />
+
+{' '}
+
+<br />
+
+{' '}
+
+<pre>
+  {`import { useForm } from "payload/components/forms";
+
+export const CustomArrayManager = () => {
+  const { addFieldRow } = useForm()
+
+  return (
+    <button
+      type="button"
+      onClick={() => {
+        addFieldRow({
+          path: "arrayField",
+          rowIndex: 0,
+          data: {
+            textField: "text",
+            // blockType: "yourBlockSlug",
+            // ^ if managing a block array, you need to specify the block type
+          },
+        })
+      }}
+    >
+      Add Row
+    </button>
+  )
+}`}
+</pre>
+
+  <p>An example config to go along with the Custom Component</p>
+  <pre>
+{`const ExampleCollection = {
+  slug: "example-collection",
+  fields: [
+    {
+      name: "arrayField",
+      type: "array",
+      fields: [
+        {
+          name: "textField",
+          type: "text",
+        },
+      ],
+    },
+    {
+      type: "ui",
+      name: "customArrayManager",
+      admin: {
+        components: {
+          Field: '/path/to/CustomArrayManagerField',
+        },
+      },
+    },
+  ],
+}`}
+  </pre>
+</>
+        )
+      }
+    ],
+    [
+      {
+        value: <strong><code>removeFieldRow</code></strong>,
+      },
+      {
+        value: "Method to remove a row from an array or block field",
+      },
+      {
+        drawerTitle: 'removeFieldRow',
+        drawerDescription: 'A useful method to programmatically remove a row from an array or block field.',
+        drawerSlug: 'removeFieldRow',
+        drawerContent: (
+<>
+  <TableWithDrawers
+    columns={[
+      'Prop',
+      'Description',
+    ]}
+    rows={[
+      [
+        {
+          value: <strong><code>path</code></strong>,
+        },
+        {
+          value: "The path to the array or block field",
+        },
+      ],
+      [
+        {
+          value: <strong><code>rowIndex</code></strong>,
+        },
+        {
+          value: "The index of the row to remove",
+        },
+      ],
+    ]}
+  />
+
+{' '}
+
+<br />
+
+{' '}
+
+<pre>
+  {`import { useForm } from "payload/components/forms";
+
+export const CustomArrayManager = () => {
+  const { removeFieldRow } = useForm()
+
+  return (
+    <button
+      type="button"
+      onClick={() => {
+        removeFieldRow({
+          path: "arrayField",
+          rowIndex: 0,
+        })
+      }}
+    >
+      Remove Row
+    </button>
+  )
+}`}
+</pre>
+
+  <p>An example config to go along with the Custom Component</p>
+  <pre>
+{`const ExampleCollection = {
+  slug: "example-collection",
+  fields: [
+    {
+      name: "arrayField",
+      type: "array",
+      fields: [
+        {
+          name: "textField",
+          type: "text",
+        },
+      ],
+    },
+    {
+      type: "ui",
+      name: "customArrayManager",
+      admin: {
+        components: {
+          Field: '/path/to/CustomArrayManagerField',
+        },
+      },
+    },
+  ],
+}`}
+  </pre>
+</>
+        )
+      }
+    ],
+    [
+      {
+        value: <strong><code>replaceFieldRow</code></strong>,
+      },
+      {
+        value: "Method to replace a row from an array or block field",
+      },
+      {
+        drawerTitle: 'replaceFieldRow',
+        drawerDescription: 'A useful method to programmatically replace a row from an array or block field.',
+        drawerSlug: 'replaceFieldRow',
+        drawerContent: (
+<>
+  <TableWithDrawers
+    columns={[
+      'Prop',
+      'Description',
+    ]}
+    rows={[
+      [
+        {
+          value: <strong><code>path</code></strong>,
+        },
+        {
+          value: "The path to the array or block field",
+        },
+      ],
+      [
+        {
+          value: <strong><code>rowIndex</code></strong>,
+        },
+        {
+          value: "The index of the row to replace",
+        },
+      ],
+      [
+        {
+          value: <strong><code>data</code></strong>,
+        },
+        {
+          value: "The data to replace within the row",
+        },
+      ],
+    ]}
+  />
+
+{' '}
+
+<br />
+
+{' '}
+
+<pre>
+  {`import { useForm } from "payload/components/forms";
+
+export const CustomArrayManager = () => {
+  const { replaceFieldRow } = useForm()
+
+  return (
+    <button
+      type="button"
+      onClick={() => {
+        replaceFieldRow({
+          path: "arrayField",
+          rowIndex: 0,
+          data: {
+            textField: "updated text",
+            // blockType: "yourBlockSlug",
+            // ^ if managing a block array, you need to specify the block type
+          },
+        })
+      }}
+    >
+      Replace Row
+    </button>
+  )
+}`}
+</pre>
+
+  <p>An example config to go along with the Custom Component</p>
+  <pre>
+{`const ExampleCollection = {
+  slug: "example-collection",
+  fields: [
+    {
+      name: "arrayField",
+      type: "array",
+      fields: [
+        {
+          name: "textField",
+          type: "text",
+        },
+      ],
+    },
+    {
+      type: "ui",
+      name: "customArrayManager",
+      admin: {
+        components: {
+          Field: '/path/to/CustomArrayManagerField',
+        },
+      },
+    },
+  ],
+}`}
+  </pre>
+</>
+        )
+      }
+    ],
+  ]}
+/>
+
+## useCollapsible
+
+The `useCollapsible` hook allows you to control parent collapsibles:
+
+| Property                  | Description                                                                                                   |
+| ------------------------- | ------------------------------------------------------------------------------------------------------------- |
+| **`isCollapsed`**         | State of the collapsible. `true` if open, `false` if collapsed.                                               |
+| **`isVisible`**           | If nested, determine if the nearest collapsible is visible. `true` if no parent is closed, `false` otherwise. |
+| **`toggle`**              | Toggles the state of the nearest collapsible.                                                                 |
+| **`isWithinCollapsible`** | Determine when you are within another collapsible.                                                            |
+
+**Example:**
+
+```tsx
+'use client'
+import React from 'react'
+
+import { useCollapsible } from '@payloadcms/ui'
+
+const CustomComponent: React.FC = () => {
+  const { isCollapsed, toggle } = useCollapsible()
+
+  return (
+    <div>
+      <p className="field-type">I am {isCollapsed ? 'closed' : 'open'}</p>
+      <button onClick={toggle} type="button">
+        Toggle
+      </button>
+    </div>
+  )
+}
+```
+
+## useDocumentInfo
+
+The `useDocumentInfo` hook provides lots of information about the document currently being edited, including the following:
+
+| Property                  | Description                                                                                                        |
+| ------------------------- | ------------------------------------------------------------------------------------------------------------------ |
+| **`collection`**          | If the doc is a collection, its Collection Config will be returned                                                 |
+| **`global`**              | If the doc is a global, its Global Config will be returned                                                         |
+| **`id`**                  | If the doc is a collection, its ID will be returned                                                                |
+| **`preferencesKey`**      | The `preferences` key to use when interacting with document-level user preferences                                 |
+| **`versions`**            | Versions of the current doc                                                                                        |
+| **`unpublishedVersions`** | Unpublished versions of the current doc                                                                            |
+| **`publishedDoc`**        | The currently published version of the doc being edited                                                            |
+| **`getVersions`**         | Method to trigger the retrieval of document versions                                                               |
+| **`docPermissions`**      | The current documents permissions. Collection document permissions fallback when no id is present (i.e. on create) |
+| **`getDocPermissions`**   | Method to trigger the retrieval of document level permissions                                                      |
+
+**Example:**
+
+```tsx
+'use client'
+import { useDocumentInfo } from '@payloadcms/ui'
+
+const LinkFromCategoryToPosts: React.FC = () => {
+  // highlight-start
+  const { id } = useDocumentInfo()
+  // highlight-end
+
+  // id will be undefined on the create form
+  if (!id) {
+    return null
+  }
+
+  return (
+    <a href={`/admin/collections/posts?where[or][0][and][0][category][in][0]=[${id}]`}>
+      View posts
+    </a>
+  )
+}
+```
+
+## useLocale
+
+In any Custom Component you can get the selected locale object with the `useLocale` hook. `useLocale`gives you the full locale object, consisting of a `label`, `rtl`(right-to-left) property, and then `code`. Here is a simple example:
+
+```tsx
+'use client'
+import { useLocale } from '@payloadcms/ui'
+
+const Greeting: React.FC = () => {
+  // highlight-start
+  const locale = useLocale()
+  // highlight-end
+
+  const trans = {
+    en: 'Hello',
+    es: 'Hola',
+  }
+
+  return <span> {trans[locale.code]} </span>
+}
+```
+
+## useAuth
+
+Useful to retrieve info about the currently logged in user as well as methods for interacting with it. It sends back an object with the following properties:
+
+| Property                 | Description                                                                             |
+| ------------------------ | --------------------------------------------------------------------------------------- |
+| **`user`**               | The currently logged in user                                                            |
+| **`logOut`**             | A method to log out the currently logged in user                                        |
+| **`refreshCookie`**      | A method to trigger the silent refreshing of a user's auth token                        |
+| **`setToken`**           | Set the token of the user, to be decoded and used to reset the user and token in memory |
+| **`token`**              | The logged in user's token (useful for creating preview links, etc.)                    |
+| **`refreshPermissions`** | Load new permissions (useful when content that effects permissions has been changed)    |
+| **`permissions`**        | The permissions of the current user                                                     |
+
+```tsx
+'use client'
+import { useAuth } from '@payloadcms/ui'
+import type { User } from '../payload-types.ts'
+
+const Greeting: React.FC = () => {
+  // highlight-start
+  const { user } = useAuth<User>()
+  // highlight-end
+
+  return <span>Hi, {user.email}!</span>
+}
+```
+
+## useConfig
+
+Used to easily retrieve the Payload [Client Config](./components#accessing-the-payload-config).
+
+```tsx
+'use client'
+import { useConfig } from '@payloadcms/ui'
+
+const MyComponent: React.FC = () => {
+  // highlight-start
+  const { config } = useConfig()
+  // highlight-end
+
+  return <span>{config.serverURL}</span>
+}
+```
+
+## useEditDepth
+
+Sends back how many editing levels "deep" the current component is. Edit depth is relevant while adding new documents / editing documents in modal windows and other cases.
+
+```tsx
+'use client'
+import { useEditDepth } from '@payloadcms/ui'
+
+const MyComponent: React.FC = () => {
+  // highlight-start
+  const editDepth = useEditDepth()
+  // highlight-end
+
+  return <span>My component is {editDepth} levels deep</span>
+}
+```
+
+## usePreferences
+
+Returns methods to set and get user preferences. More info can be found [here](https://payloadcms.com/docs/admin/preferences).
+
+## useTheme
+
+Returns the currently selected theme (`light`, `dark` or `auto`), a set function to update it and a boolean `autoMode`, used to determine if the theme value should be set automatically based on the user's device preferences.
+
+```tsx
+'use client'
+import { useTheme } from '@payloadcms/ui'
+
+const MyComponent: React.FC = () => {
+  // highlight-start
+  const { autoMode, setTheme, theme } = useTheme()
+  // highlight-end
+
+  return (
+    <>
+      <span>
+        The current theme is {theme} and autoMode is {autoMode}
+      </span>
+      <button
+        type="button"
+        onClick={() => setTheme((prev) => (prev === 'light' ? 'dark' : 'light'))}
+      >
+        Toggle theme
+      </button>
+    </>
+  )
+}
+```
+
+## useTableColumns
+
+Returns methods to manipulate table columns
+
+```tsx
+'use client'
+import { useTableColumns } from '@payloadcms/ui'
+
+const MyComponent: React.FC = () => {
+  // highlight-start
+  const { setActiveColumns } = useTableColumns()
+
+  const resetColumns = () => {
+    setActiveColumns(['id', 'createdAt', 'updatedAt'])
+  }
+  // highlight-end
+
+  return (
+    <button type="button" onClick={resetColumns}>
+      Reset columns
+    </button>
+  )
+}
+```
+
+## useTableCell
+
+Similar to [`useFieldProps`](#usefieldprops), all [Custom Cell Components](./fields#the-cell-component) are rendered on the server, and as such, only have access to static props at render time. But, some props need to be dynamic, such as the field value itself.
+
+For this reason, dynamic props like `cellData` are managed in their own React context, which can be accessed using the `useTableCell` hook.
+
+```tsx
+'use client'
+import { useTableCell } from '@payloadcms/ui'
+
+const MyComponent: React.FC = () => {
+  const { cellData } = useTableCell() // highlight-line
+
+  return (
+    <div>
+      {cellData}
+    </div>
+  )
+}
+```
+
+## useDocumentEvents
+
+The `useDocumentEvents` hook provides a way of subscribing to cross-document events, such as updates made to nested documents within a drawer. This hook will report document events that are outside the scope of the document currently being edited. This hook provides the following:
+
+| Property               | Description                                                                                                                             |
+| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
+| **`mostRecentUpdate`** | An object containing the most recently updated document. It contains the `entitySlug`, `id` (if collection), and `updatedAt` properties |
+| **`reportUpdate`**     | A method used to report updates to documents. It accepts the same arguments as the `mostRecentUpdate` property.                         |
+
+**Example:**
+
+```tsx
+'use client'
+import { useDocumentEvents } from '@payloadcms/ui'
+
+const ListenForUpdates: React.FC = () => {
+  const { mostRecentUpdate } = useDocumentEvents()
+
+  return <span>{JSON.stringify(mostRecentUpdate)}</span>
+}
+```
+
+<Banner type="info">
+  Right now the `useDocumentEvents` hook only tracks recently updated documents, but in the future
+  it will track more document-related events as needed, such as document creation, deletion, etc.
+</Banner>

docs/admin/metadata.mdx

@@ -0,0 +1,216 @@
+---
+title: Page Metadata
+label: Metadata
+order: 70
+desc: Customize the metadata of your pages within the Admin Panel
+keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+Every page within the Admin Panel automatically receives dynamic, auto-generated metadata derived from live document data, the user's current locale, and more, without any additional configuration. This includes the page title, description, og:image and everything in between. Metadata is fully configurable at the root level and cascades down to individual collections, documents, and custom views, allowing for the ability to control metadata on any page with high precision.
+
+Within the Admin Panel, metadata can be customized at the following levels:
+
+- [Root Metadata](#root-metadata)
+- [Collection Metadata](#collection-metadata)
+- [Global Metadata](#global-metadata)
+- [View Metadata](#view-metadata)
+
+All of these types of metadata share a similar structure, with a few key differences on the Root level. To customize metadata, consult the list of available scopes. Determine the scope that corresponds to what you are trying to accomplish, then author your metadata within the Payload Config accordingly.
+
+## Root Metadata
+
+Root Metadata is the metadata that is applied to all pages within the Admin Panel. This is where you can control things like the suffix appended onto each page's title, the favicon displayed in the browser's tab, and the Open Graph data that is used when sharing the Admin Panel on social media.
+
+To customize Root Metadata, use the `admin.meta` key in your Payload Config:
+
+```ts
+{
+  // ...
+  admin: {
+    // highlight-start
+    meta: {
+    // highlight-end
+      title: 'My Admin Panel',
+      description: 'The best admin panel in the world',
+      icons: [
+        {
+          rel: 'icon',
+          type: 'image/png',
+          href: '/favicon.png',
+        },
+      ],
+    },
+  },
+}
+```
+
+The following options are available for Root Metadata:
+
+| Key | Type | Description |
+| --- | --- | --- |
+| **`title`** | `string` | The title of the Admin Panel. |
+| **`description`** | `string` | The description of the Admin Panel. |
+| **`defaultOGImageType`** | `dynamic` (default), `static`, or `off` | The type of default OG image to use. If set to `dynamic`, Payload will use Next.js image generation to create an image with the title of the page. If set to `static`, Payload will use the `defaultOGImage` URL. If set to `off`, Payload will not generate an OG image. |
+| **`icons`** | `IconConfig[]` | An array of icon objects. [More details](#icons) |
+| **`keywords`** | `string` | A comma-separated list of keywords to include in the metadata of the Admin Panel. |
+| **`openGraph`** | `OpenGraphConfig` | An object containing Open Graph metadata. [More details](#open-graph) |
+| **`titleSuffix`** | `string` | A suffix to append to the end of the title of every page. Defaults to "- Payload". |
+
+<Banner type="success">
+  <strong>Reminder:</strong>
+  These are the _root-level_ options for the Admin Panel. You can also customize [Collection Metadata](./collections), [Global Metadata](./globals), and [Document Metadata](./documents) in their respective configs.
+</Banner>
+
+### Icons
+
+The Icons Config corresponds to the `<link>` tags that are used to specify icons for the Admin Panel. The `icons` key is an array of objects, each of which represents an individual icon. Icons are differentiated from one another by their `rel` attribute, which specifies the relationship between the document and the icon.
+
+The most common icon type is the favicon, which is displayed in the browser tab. This is specified by the `rel` attribute `icon`. Other common icon types include `apple-touch-icon`, which is used by Apple devices when the Admin Panel is saved to the home screen, and `mask-icon`, which is used by Safari to mask the Admin Panel icon.
+
+To customize icons, use the `icons` key within the `admin.meta` object in your Payload Config:
+
+```ts
+{
+  // ...
+  admin: {
+    meta: {
+      // highlight-start
+      icons: [
+      // highlight-end
+        {
+          rel: 'icon',
+          type: 'image/png',
+          href: '/favicon.png',
+        },
+        {
+          rel: 'apple-touch-icon',
+          type: 'image/png',
+          href: '/apple-touch-icon.png',
+        },
+      ],
+    },
+  },
+}
+```
+
+The following options are available for Icons:
+
+| Key | Type | Description |
+| --- | --- | --- |
+| **`rel`** | `string` | The HTML `rel` attribute of the icon. |
+| **`type`** | `string` | The MIME type of the icon. |
+| **`color`** | `string` | The color of the icon. |
+| **`fetchPriority`** | `string` | The [fetch priority](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/fetchPriority) of the icon. |
+| **`media`** | `string` | The [media query](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_media_queries/Using_media_queries) of the icon. |
+| **`sizes`** | `string` | The [sizes](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/sizes) of the icon. |
+| **`url`** | `string` | The URL pointing the resource of the icon. |
+
+### Open Graph
+
+Open Graph metadata is a set of tags that are used to control how URLs are displayed when shared on social media platforms. Open Graph metadata is automatically generated by Payload, but can be customized at the Root level.
+
+To customize Open Graph metadata, use the `openGraph` key within the `admin.meta` object in your Payload Config:
+
+```ts
+{
+  // ...
+  admin: {
+    meta: {
+      // highlight-start
+      openGraph: {
+      // highlight-end
+        description: 'The best admin panel in the world',
+        images: [
+          {
+            url: 'https://example.com/image.jpg',
+            width: 800,
+            height: 600,
+          },
+        ],
+        siteName: 'Payload',
+        title: 'My Admin Panel',
+      },
+    },
+  },
+}
+```
+
+The following options are available for Open Graph Metadata:
+
+| Key | Type | Description |
+| --- | --- | --- |
+| **`description`** | `string` | The description of the Admin Panel. |
+| **`images`** | `OGImageConfig | OGImageConfig[]` | An array of image objects. |
+| **`siteName`** | `string` | The name of the site. |
+| **`title`** | `string` | The title of the Admin Panel. |
+
+## Collection Metadata
+
+Collection Metadata is the metadata that is applied to all pages within any given Collection within the Admin Panel. This metadata is used to customize the title and description of all views within any given Collection, unless overridden by the view itself.
+
+To customize Collection Metadata, use the `admin.meta` key within your Collection Config:
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const MyCollection: CollectionConfig = {
+  // ...
+  admin: {
+    // highlight-start
+    meta: {
+    // highlight-end
+      title: 'My Collection',
+      description: 'The best collection in the world',
+    },
+  },
+}
+```
+
+The Collection Meta config has the same options as the [Root Metadata](#root-metadata) config.
+
+## Global Metadata
+
+Global Metadata is the metadata that is applied to all pages within any given Global within the Admin Panel. This metadata is used to customize the title and description of all views within any given Global, unless overridden by the view itself.
+
+To customize Global Metadata, use the `admin.meta` key within your Global Config:
+
+```ts
+import { GlobalConfig } from 'payload'
+
+export const MyGlobal: GlobalConfig = {
+  // ...
+  admin: {
+    // highlight-start
+    meta: {
+    // highlight-end
+      title: 'My Global',
+      description: 'The best
+    },
+  },
+}
+```
+
+The Global Meta config has the same options as the [Root Metadata](#root-metadata) config.
+
+## View Metadata
+
+View Metadata is the metadata that is applied to specific [Views](./views) within the Admin Panel. This metadata is used to customize the title and description of a specific view, overriding any metadata set at the [Root](#root-metadata), [Collection](#collection-metadata), or [Global](#global-metadata) level.
+
+To customize View Metadata, use the `meta` key within your View Config:
+
+```ts
+{
+  // ...
+  admin: {
+    views: {
+      dashboard: {
+        // highlight-start
+        meta: {
+        // highlight-end
+          title: 'My Dashboard',
+          description: 'The best dashboard in the world',
+        }
+      },
+    },
+  },
+}

docs/admin/overview.mdx

@@ -0,0 +1,243 @@
+---
+title: The Admin Panel
+label: Overview
+order: 10
+desc: Manage your data and customize the Payload Admin Panel by swapping in your own React components. Create, modify or remove views, fields, styles and much more.
+keywords: admin, components, custom, customize, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+Payload dynamically generates a beautiful, [fully type-safe](../typescript/overview) Admin Panel to manage your users and data. It is highly performant, even with 100+ fields, and is translated in over 30 languages. Within the Admin Panel you can manage content, [render your site](../live-preview/overview), preview drafts, [diff versions](../versions/overview), and so much more.
+
+The Admin Panel is designed to [white-label your brand](https://payloadcms.com/blog/white-label-admin-ui). You can endlessly customize and extend the Admin UI by swapping in your own [Custom Components](./components)—everything from simple field labels to entire views can be modified or replaced to perfectly tailor the interface for your editors.
+
+The Admin Panel is written in [TypeScript](https://www.typescriptlang.org) and built with [React](https://react.dev) using the [Next.js App Router](https://nextjs.org/docs/app). It supports [React Server Components](https://react.dev/reference/rsc/server-components), enabling the use of the [Local API](/docs/local-api/overview) on the front-end. You can install Payload into any [existing Next.js app in just one line](../getting-started/installation) and [deploy it anywhere](../production).
+
+<Banner type="success">
+  The Payload Admin Panel is designed to be as minimal and straightforward as possible to allow easy customization and control. [Learn more](./components).
+</Banner>
+
+<LightDarkImage
+  srcLight="https://payloadcms.com/images/docs/admin.jpg"
+  srcDark="https://payloadcms.com/images/docs/admin-dark.jpg"
+  alt="Admin Panel with collapsible sidebar"
+  caption="Redesigned Admin Panel with a collapsible sidebar that's open by default, providing greater extensibility and enhanced horizontal real estate."
+/>
+
+## Project Structure
+
+The Admin Panel serves as the entire HTTP layer for Payload, providing a full CRUD interface for your app. This means that both the [REST](../rest-api/overview) and [GraphQL](../graphql/overview) APIs are simply [Next.js Routes](https://nextjs.org/docs/app/building-your-application/routing) that exist directly alongside your front-end application.
+
+Once you [install Payload](../getting-started/installation), the following files and directories will be created in your app:
+
+```plaintext
+app/
+├─ (payload)/
+├── admin/
+├─── [[...segments]]/
+├──── page.tsx
+├──── not-found.tsx
+├── api/
+├─── [...slug]/
+├──── route.ts
+├── graphql/
+├──── route.ts
+├── graphql-playground/
+├──── route.ts
+├── custom.scss
+├── layout.tsx
+```
+
+<Banner type="info">
+  If you are not familiar with Next.js project structure, you can [learn more about it here](https://nextjs.org/docs/getting-started/project-structure).
+</Banner>
+
+As shown above, all Payload routes are nested within the `(payload)` route group. This creates a boundary between the Admin Panel and the rest of your application by scoping all layouts and styles. The `layout.tsx` file within this directory, for example, is where Payload manages the `html` tag of the document to set proper [`lang`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang) and [`dir`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir) attributes, etc.
+
+The `admin` directory contains all the _pages_ related to the interface itself, whereas the `api` and `graphql` directories contains all the _routes_ related to the [REST API](../rest-api/overview) and [GraphQL API](../graphql/overview). All admin routes are [easily configurable](#customizing-routes) to meet your application's exact requirements.
+
+<Banner type="warning">
+  <strong>Note:</strong>
+  If you don't use the [REST API](../rest/overview) or [GraphQL API](../graphql/overview), you can delete the [Next.js files corresponding to those routes](../admin/overview#project-structure), however, the overhead of this API is completely constrained to these endpoints, and will not slow down or affect Payload outside of the endpoints.
+</Banner>
+
+Finally, the `custom.scss` file is where you can add or override globally-oriented styles in the Admin Panel, such as modify the color palette. Customizing the look and feel through CSS alone is a powerful feature of the Admin Panel, [more on that here](./customizing-css).
+
+All auto-generated files will contain the following comments at the top of each file:
+
+```tsx
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */,
+/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+```
+
+## Admin Options
+
+All options for the Admin Panel are defined in your [Payload Config](../configuration/overview) under the `admin` property:
+
+```ts
+import { buildConfig } from 'payload'
+
+const config = buildConfig({
+  // ...
+  admin: { // highlight-line
+    // ...
+  },
+})
+```
+
+The following options are available:
+
+| Option        | Description                                                                                                                                                           |
+|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **`avatar`**      | Set account profile picture. Options: `gravatar`, `default` or a custom React component.                                                                              |
+| **`autoLogin`**   | Used to automate log-in for dev and demonstration convenience. [More details](../authentication/overview).                                                            |
+| **`buildPath`**   | Specify an absolute path for where to store the built Admin bundle used in production. Defaults to `path.resolve(process.cwd(), 'build')`.                            |
+| **`components`**  | Component overrides that affect the entirety of the Admin Panel. [More details](./components).                                                                        |
+| **`custom`**      | Any custom properties you wish to pass to the Admin Panel.                                                                                                            |
+| **`dateFormat`**  | The date format that will be used for all dates within the Admin Panel. Any valid [date-fns](https://date-fns.org/) format pattern can be used.                       |
+| **`disable`**     | If set to `true`, the entire Admin Panel will be disabled.                                                                                                            |
+| **`livePreview`** | Enable real-time editing for instant visual feedback of your front-end application. [More details](../live-preview/overview).                                         |
+| **`meta`**        | Base metadata to use for the Admin Panel. [More details](./metadata). |
+| **`routes`**      | Replace built-in Admin Panel routes with your own custom routes. [More details](#customizing-routes).                                                                 |
+| **`user`**        | The `slug` of the Collection that you want to allow to login to the Admin Panel. [More details](#the-admin-user-collection).                                          |
+
+<Banner type="success">
+  <strong>Reminder:</strong>
+  These are the _root-level_ options for the Admin Panel. You can also customize [Collection Admin Options](./collections) and [Global Admin Options](./globals) through their respective `admin` keys.
+</Banner>
+
+### The Admin User Collection
+
+To specify which Collection to allow to login to the Admin Panel, pass the `admin.user` key equal to the slug of any auth-enabled Collection:
+
+```ts
+import { buildConfig } from 'payload'
+
+const config = buildConfig({
+  // ...
+  admin: {
+    user: 'admins', // highlight-line
+  },
+})
+```
+
+<Banner type="warning">
+  <strong>Important:</strong>
+  <br />
+  The Admin Panel can only be used by a single auth-enabled Collection. To enable authentication for a Collection, simply set `auth: true` in the Collection's configuration. See [Authentication](../authentication/overview) for more information.
+</Banner>
+
+By default, if you have not specified a Collection, Payload will automatically provide a `User` Collection with access to the Admin Panel. You can customize or override the fields and settings of the default `User` Collection by adding your own Collection with `slug: 'users'`. Doing this will force Payload to use your provided `User` Collection instead of its default version.
+
+You can use whatever Collection you'd like to access the Admin Panel as long as the Collection supports [Authentication](/docs/authentication/overview). It doesn't need to be called `users`. For example, you may wish to have two Collections that both support authentication:
+
+- `admins` - meant to have a higher level of permissions to manage your data and access the Admin Panel
+- `customers` - meant for end users of your app that should not be allowed to log into the Admin Panel
+
+To do this, specify `admin: { user: 'admins' }` in your config. This will provide access to the Admin Panel to only `admins`. Any users authenticated as `customers` will be prevented from accessing the Admin Panel.  See [Access Control](/docs/access-control/overview) for full details.
+
+### Role-based Access Control
+
+It is also possible to allow multiple user types into the Admin Panel with limited permissions, known as role-based access control (RBAC). For example, you may wish to have two roles within the `admins` Collection:
+
+- `super-admin` - full access to the Admin Panel to perform any action
+- `editor` - limited access to the Admin Panel to only manage content
+
+To do this, add a `roles` or similar field to your auth-enabled Collection, then use the `access.admin` property to grant or deny access based on the value of that field. See [Access Control](/docs/access-control/overview) for full details. For a complete, working example of role-based access control, check out the official [Auth Example](https://github.com/payloadcms/payload/tree/main/examples/auth/payload).
+
+## Customizing Routes
+
+You have full control over the routes that Payload binds itself to. This includes both [Root-level Routes](#root-level-routes) such as the [REST API](../rest-api/overview), and [Admin-level Routes](#admin-level-routes) such as the user's account page. You can customize these routes to meet the needs of your application simply by specifying the desired paths in your config.
+
+### Root-level Routes
+
+Root-level routes are those that are not behind the `/admin` path, such as the [REST API](../rest-api/overview) and [GraphQL API](../graphql/overview), or the root path of the Admin Panel itself.
+
+To customize root-level routes, use the `routes` property in your [Payload Config](../configuration/overview):
+
+```ts
+import { buildConfig } from 'payload'
+
+const config = buildConfig({
+  // ...
+  routes: {
+    admin: '/custom-admin-route' // highlight-line
+  }
+})
+```
+
+The following options are available:
+
+| Option              | Default route         | Description                                       |
+|---------------------|-----------------------|---------------------------------------------------|
+| `admin`             | `/admin`              | The Admin Panel itself.                           |
+| `api`               | `/api`                | The [REST API](../rest-api/overview) base path.   |
+| `graphQL`           | `/graphql`            | The [GraphQL API](../graphql/overview) base path. |
+| `graphQLPlayground` | `/graphql-playground` | The GraphQL Playground.                           |
+
+<Banner type="success">
+  <strong>Tip:</strong>
+   You can easily add _new_ routes to the Admin Panel through [Custom Endpoints](../rest-api/overview#custom-endpoints) and [Custom Views](./views).
+</Banner>
+
+#### Customizing Root-level Routes
+
+You can change the Root-level Routes as needed, such as to mount the Admin Panel at the root of your application.
+
+Changing Root-level Routes also requires a change to [Project Structure](#project-structure) to match the new route. For example, if you set `routes.admin` to `/`, you would need to completely remove the `admin` directory from the project structure:
+
+```plaintext
+app/
+├─ (payload)/
+├── [[...segments]]/
+├──── ...
+```
+
+<Banner type="warning">
+  <strong>Note:</strong>
+  If you set Root-level Routes _before_ auto-generating the Admin Panel, your [Project Structure](#project-structure) will already be set up correctly.
+</Banner>
+
+### Admin-level Routes
+
+Admin-level routes are those behind the `/admin` path. These are the routes that are part of the Admin Panel itself, such as the user's account page, the login page, etc.
+
+To customize admin-level routes, use the `admin.routes` property in your [Payload Config](../configuration/overview):
+
+```ts
+import { buildConfig } from 'payload'
+
+const config = buildConfig({
+  // ...
+  admin: {
+    routes: {
+      account: '/my-account' // highlight-line
+    }
+  },
+})
+```
+
+The following options are available:
+
+| Option            | Default route           | Description                                     |
+| ----------------- | ----------------------- | ----------------------------------------------- |
+| `account`         | `/account`              | The user's account page.                        |
+| `createFirstUser` | `/create-first-user`    | The page to create the first user.              |
+| `forgot`          | `/forgot`               | The password reset page.                        |
+| `inactivity`      | `/logout-inactivity`    | The page to redirect to after inactivity.       |
+| `login`           | `/login`                | The login page.                                 |
+| `logout`          | `/logout`               | The logout page.                                |
+| `reset`           | `/reset`                | The password reset page.                        |
+| `unauthorized`    | `/unauthorized`         | The unauthorized page.                          |
+
+<Banner type="success">
+  <strong>Note:</strong>
+  You can also swap out entire _views_ out for your own, using the `admin.views` property of the Payload Config. See [Custom Views](./views) for more information.
+</Banner>
+
+## I18n
+
+The Payload Admin Panel is translated in over [30 languages and counting](https://github.com/payloadcms/payload/tree/beta/packages/translations). Languages are automatically detected based on the user's browser and used by the Admin Panel to display all text in that language. If no language was detected, or if the user's language is not yet supported, English will be chosen. Users can easily specify their language by selecting one from their account page. See [I18n](../configuration/i18n) for more information.
+
+## Light and Dark Modes
+
+Users in the Admin Panel have the ability to choose between light mode and dark mode for their editing experience. Users can select their preferred theme from their account page. Once selected, it is saved to their user's preferences and persisted across sessions and devices. If no theme was selected, the Admin Panel will automatically detect the operation system's theme and use that as the default.

docs/admin/preferences.mdx

@@ -0,0 +1,161 @@
+---
+title: Managing User Preferences
+label: Preferences
+order: 70
+desc: Store the preferences of your users as they interact with the Admin Panel.
+keywords: admin, preferences, custom, customize, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+As your users interact with the [Admin Panel](./overview), you might want to store their preferences in a persistent manner, so that when they revisit the Admin Panel in a different session or from a different device, they can pick right back up where they left off.
+
+Out of the box, Payload handles the persistence of your users' preferences in a handful of ways, including:
+
+1. Columns in the Collection List View: their active state and order
+1. The user's last active [Locale](../configuration/localization)
+1. The "collapsed" state of `blocks`, `array`, and `collapsible` fields
+1. The last-known state of the `Nav` component, etc.
+
+<Banner type="warning">
+  <strong>Important:</strong>
+  <br />
+  All preferences are stored on an individual user basis. Payload automatically recognizes the user
+  that is reading or setting a preference via all provided authentication methods.
+</Banner>
+
+## Use Cases
+
+This API is used significantly for internal operations of the Admin Panel, as mentioned above. But, if you're building your own React components for use in the Admin Panel, you can allow users to set their own preferences in correspondence to their usage of your components. For example:
+
+- If you have built a "color picker", you could "remember" the last used colors that the user has set for easy access next time
+- If you've built a custom `Nav` component, and you've built in an "accordion-style" UI, you might want to store the `collapsed` state of each Nav collapsible item. This way, if an editor returns to the panel, their `Nav` state is persisted automatically
+- You might want to store `recentlyAccessed` documents to give admin editors an easy shortcut back to their recently accessed documents on the `Dashboard` or similar
+- Many other use cases exist. Invent your own! Give your editors an intelligent and persistent editing experience.
+
+## Database
+
+Payload automatically creates an internally used `payload-preferences` Collection that stores user preferences. Each document in the `payload-preferences` Collection contains the following shape:
+
+| Key               | Value                                                             |
+| ----------------- | ----------------------------------------------------------------- |
+| `id`              | A unique ID for each preference stored.                           |
+| `key`             | A unique `key` that corresponds to the preference.                |
+| `user.value`      | The ID of the `user` that is storing its preference.              |
+| `user.relationTo` | The `slug` of the Collection that the `user` is logged in as.     |
+| `value`           | The value of the preference. Can be any data shape that you need. |
+| `createdAt`       | A timestamp of when the preference was created.                   |
+| `updatedAt`       | A timestamp set to the last time the preference was updated.      |
+
+## APIs
+
+Preferences are available to both [GraphQL](/docs/graphql/overview#preferences) and [REST](/docs/rest-api/overview#) APIs.
+
+## Adding or reading Preferences in your own components
+
+The Payload Admin Panel offers a `usePreferences` hook. The hook is only meant for use within the Admin Panel itself. It provides you with two methods:
+
+#### `getPreference`
+
+This async method provides an easy way to retrieve a user's preferences by `key`. It will return a promise containing the resulting preference value.
+
+**Arguments**
+
+- `key`: the `key` of your preference to retrieve.
+
+#### `setPreference`
+
+Also async, this method provides you with an easy way to set a user preference. It returns `void`.
+
+**Arguments:**
+
+- `key`: the `key` of your preference to set.
+- `value`: the `value` of your preference that you're looking to set.
+
+## Example
+
+Here is an example for how you can utilize `usePreferences` within your custom Admin Panel components. Note - this example is not fully useful and is more just a reference for how to utilize the Preferences API. In this case, we are demonstrating how to set and retrieve a user's last used colors history within a `ColorPicker` or similar type component.
+
+```tsx
+'use client'
+import React, { Fragment, useState, useEffect, useCallback } from 'react';
+import { usePreferences } from '@payloadcms/ui'
+
+const lastUsedColorsPreferenceKey = 'last-used-colors';
+
+const CustomComponent = (props) => {
+  const { getPreference, setPreference } = usePreferences();
+
+  // Store the last used colors in local state
+  const [lastUsedColors, setLastUsedColors] = useState([]);
+
+  // Callback to add a color to the last used colors
+  const updateLastUsedColors = useCallback((color) => {
+    // First, check if color already exists in last used colors.
+    // If it already exists, there is no need to update preferences
+    const colorAlreadyExists = lastUsedColors.indexOf(color) > -1;
+
+    if (!colorAlreadyExists) {
+      const newLastUsedColors = [
+        ...lastUsedColors,
+        color,
+      ];
+
+      setLastUsedColors(newLastUsedColors);
+      setPreference(lastUsedColorsPreferenceKey, newLastUsedColors);
+    }
+  }, [lastUsedColors, setPreference]);
+
+  // Retrieve preferences on component mount
+  // This will only be run one time, because the `getPreference` method never changes
+  useEffect(() => {
+    const asyncGetPreference = async () => {
+      const lastUsedColorsFromPreferences = await getPreference(lastUsedColorsPreferenceKey);
+      setLastUsedColors(lastUsedColorsFromPreferences);
+    };
+
+    asyncGetPreference();
+  }, [getPreference]);
+
+  return (
+    <div>
+      <button
+        type="button"
+        onClick={() => updateLastUsedColors('red')}
+      >
+        Use red
+      </button>
+      <button
+        type="button"
+        onClick={() => updateLastUsedColors('blue')}
+      >
+        Use blue
+      </button>
+      <button
+        type="button"
+        onClick={() => updateLastUsedColors('purple')}
+      >
+        Use purple
+      </button>
+      <button
+        type="button"
+        onClick={() => updateLastUsedColors('yellow')}
+      >
+        Use yellow
+      </button>
+      {lastUsedColors && (
+        <Fragment>
+          <h5>Last used colors:</h5>
+          <ul>
+            {lastUsedColors?.map((color) => (
+              <li key={color}>
+                {color}
+              </li>
+            ))}
+          </ul>
+        </Fragment>
+      )}
+    </div>
+  );
+};
+
+export default CustomComponent;
+```

docs/admin/views.mdx

@@ -0,0 +1,366 @@
+---
+title: Customizing Views
+label: Customizing Views
+order: 50
+desc:
+keywords:
+---
+
+Views are the individual pages that make up the [Admin Panel](./overview), such as the Dashboard, List, and Edit views. One of the most powerful ways to customize the Admin Panel is to create Custom Views. These are [Custom Components](./components) that can either replace built-in views or can be entirely new.
+
+There are four types of views within the Admin Panel:
+
+- [Root Views](#root-views)
+- [Collection Views](#collection-views)
+- [Global Views](#global-views)
+- [Document Views](#document-views)
+
+To swap in your own Custom Views, consult the list of available components. Determine the scope that corresponds to what you are trying to accomplish, then [author your React component(s)](#building-custom-views) accordingly.
+
+## Root Views
+
+Root Views are the main views of the [Admin Panel](./overview). These are views that are scoped directly under the `/admin` route, such as the Dashboard or Account views.
+
+To easily swap Root Views with your own, or to [create entirely new ones](#adding-new-root-views), use the `admin.components.views` property of your root [Payload Config](../configuration/overview):
+
+```ts
+import { buildConfig } from 'payload'
+
+const config = buildConfig({
+  // ...
+  admin: {
+    components: {
+      views: {
+        customView: {
+          Component: '/path/to/MyCustomView#MyCustomView', // highlight-line
+          path: '/my-custom-view',
+        }
+      },
+    },
+  },
+})
+```
+
+Your Custom Root Views can optionally use one of the templates that Payload provides. The most common of these is the Default Template which provides the basic layout and navigation. Here is an example of what that might look like:
+
+```tsx
+import type { AdminViewProps } from 'payload'
+
+import { DefaultTemplate } from '@payloadcms/next/templates'
+import { Gutter } from '@payloadcms/ui'
+import React from 'react'
+
+export const MyCustomView: React.FC<AdminViewProps> = ({
+  initPageResult,
+  params,
+  searchParams,
+}) => {
+  return (
+    <DefaultTemplate
+      i18n={initPageResult.req.i18n}
+      locale={initPageResult.locale}
+      params={params}
+      payload={initPageResult.req.payload}
+      permissions={initPageResult.permissions}
+      searchParams={searchParams}
+      user={initPageResult.req.user || undefined}
+      visibleEntities={initPageResult.visibleEntities}
+    >
+      <Gutter>
+        <h1>Custom Default Root View</h1>
+        <br />
+        <p>This view uses the Default Template.</p>
+      </Gutter>
+    </DefaultTemplate>
+  )
+}
+```
+
+_For details on how to build Custom Views, including all available props, see [Building Custom Views](#building-custom-views)._
+
+The following options are available:
+
+| Property        | Description                                                                   |
+| --------------- | ----------------------------------------------------------------------------- |
+| **`account`**   | The Account view is used to show the currently logged in user's Account page. |
+| **`dashboard`** | The main landing page of the [Admin Panel](./overview).                                     |
+
+For more granular control, pass a configuration object instead. Payload exposes the following properties for each view:
+
+| Property           | Description                                                                                                                                                                                |
+| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **`Component`** \* | Pass in the component path that should be rendered when a user navigates to this route.                                                                                                         |
+| **`path`** \*      | Any valid URL path or array of paths that [`path-to-regexp`](https://www.npmjs.com/package/path-to-regex) understands.                                                                     |
+| **`exact`**        | Boolean. When true, will only match if the path matches the `usePathname()` exactly.                                                                                                     |
+| **`strict`**       | When true, a path that has a trailing slash will only match a `location.pathname` with a trailing slash. This has no effect when there are additional URL segments in the pathname. |
+| **`sensitive`**    | When true, will match if the path is case sensitive.
+| **`meta`**         | Page metadata overrides to apply to this view within the Admin Panel. [More details](./metadata).                                                                           |
+
+_\* An asterisk denotes that a property is required._
+
+### Adding New Views
+
+To add a _new_ views to the [Admin Panel](./overview), simply add your own key to the `views` object with at least a `path` and `Component` property. For example:
+
+```ts
+import { buildConfig } from 'payload'
+
+const config = buildConfig({
+  // ...
+  admin: {
+    components: {
+      views: {
+        // highlight-start
+        myCustomView: {
+        // highlight-end
+          Component: '/path/to/MyCustomView#MyCustomViewComponent',
+          path: '/my-custom-view',
+        },
+      },
+    },
+  },
+})
+```
+
+The above example shows how to add a new [Root View](#root-views), but the pattern is the same for [Collection Views](#collection-views), [Global Views](#global-views), and [Document Views](#document-views). For help on how to build your own Custom Views, see [Building Custom Views](#building-custom-views).
+
+<Banner type="warning">
+  <strong>Note:</strong>
+  <br />
+  Routes are cascading, so unless explicitly given the `exact` property, they will
+  match on URLs that simply _start_ with the route's path. This is helpful when creating catch-all
+  routes in your application. Alternatively, define your nested route _before_ your parent
+  route.
+</Banner>
+
+## Collection Views
+
+Collection Views are views that are scoped under the `/collections` route, such as the Collection List and Document Edit views.
+
+To easily swap out Collection Views with your own, or to [create entirely new ones](#adding-new-views), use the `admin.components.views` property of your [Collection Config](../collections/overview):
+
+```ts
+import type { SanitizedCollectionConfig } from 'payload'
+
+export const MyCollectionConfig: SanitizedCollectionConfig = {
+  // ...
+  admin: {
+    components: {
+      views: {
+        edit: {
+          root: {
+            Component: '/path/to/MyCustomEditView', // highlight-line
+          }
+          // other options include:
+          // default
+          // versions
+          // version
+          // api
+          // livePreview
+          // [key: string]
+          // See "Document Views" for more details
+        },
+        list: {
+          Component: '/path/to/MyCustomListView',
+        }
+      },
+    },
+  },
+}
+```
+
+_For details on how to build Custom Views, including all available props, see [Building Custom Views](#building-custom-views)._
+
+<Banner type="warning">
+  <strong>Note:</strong>
+  The `root` property will replace the _entire_ Edit View, including the title, tabs, etc., _as well as all nested [Document Views](#document-views)_, such as the API, Live Preview, and Version views. To replace only the Edit View precisely, use the `edit.default` key instead.
+</Banner>
+
+The following options are available:
+
+| Property   | Description                                                                                                       |
+| ---------- | ----------------------------------------------------------------------------------------------------------------- |
+| **`edit`** | The Edit View is used to edit a single document for any given Collection. [More details](#document-views).     |
+| **`list`** | The List View is used to show a list of documents for any given Collection.                                         |
+
+<Banner type="success">
+  <strong>Note:</strong>
+  You can also add _new_ Collection Views to the config by adding a new key to the `views` object with at least a `path` and `Component` property. See [Adding New Views](#adding-new-views) for more information.
+</Banner>
+
+## Global Views
+
+Global Views are views that are scoped under the `/globals` route, such as the Document Edit View.
+
+To easily swap out Global Views with your own or [create entirely new ones](#adding-new-views), use the `admin.components.views` property in your [Global Config](../globals/overview):
+
+```ts
+import type { SanitizedGlobalConfig } from 'payload'
+
+export const MyGlobalConfig: SanitizedGlobalConfig = {
+  // ...
+  admin: {
+    components: {
+      views: {
+        edit: {
+          root: {
+            Component: '/path/to/MyCustomEditView', // highlight-line
+          }
+          // other options include:
+          // default
+          // versions
+          // version
+          // api
+          // livePreview
+          // [key: string]
+        },
+      },
+    },
+  },
+}
+```
+
+_For details on how to build Custom Views, including all available props, see [Building Custom Views](#building-custom-views)._
+
+<Banner type="warning">
+  <strong>Note:</strong>
+  The `root` property will replace the _entire_ Edit View, including the title, tabs, etc., _as well as all nested [Document Views](#document-views)_, such as the API, Live Preview, and Version views. To replace only the Edit View precisely, use the `edit.default` key instead.
+</Banner>
+
+The following options are available:
+
+| Property   | Description                                                         |
+| ---------- | ------------------------------------------------------------------- |
+| **`edit`** | The Edit View is used to edit a single document for any given Global. [More details](#document-views). |
+
+<Banner type="success">
+  <strong>Note:</strong>
+  You can also add _new_ Global Views to the config by adding a new key to the `views` object with at least a `path` and `Component` property. See [Adding New Views](#adding-new-views) for more information.
+</Banner>
+
+## Document Views
+
+Document Views are views that are scoped under the `/collections/:collectionSlug/:id` or the `/globals/:globalSlug` route, such as the Edit View or the API View. All Document Views keep their overall structure across navigation changes, such as their title and tabs, and replace only the content below.
+
+To easily swap out Document Views with your own, or to [create entirely new ones](#adding-new-document-views), use the `admin.components.views.Edit[key]` property in your [Collection Config](../collections/overview) or [Global Config](../globals/overview):
+
+```ts
+import type { SanitizedCollectionConfig } from 'payload'
+
+export const MyCollectionOrGlobalConfig: SanitizedCollectionConfig = {
+  // ...
+  admin: {
+    components: {
+      views: {
+        edit: {
+          api: {
+            Component: '/path/to/MyCustomAPIViewComponent', // highlight-line
+          },
+        },
+      },
+    },
+  },
+}
+```
+
+_For details on how to build Custom Views, including all available props, see [Building Custom Views](#building-custom-views)._
+
+<Banner type="warning">
+ <strong>Note:</strong>
+ If you need to replace the _entire_ Edit View, including _all_ nested Document Views, use the `root` key. See [Custom Collection Views](#collection-views) or [Custom Global Views](#global-views) for more information.
+</Banner>
+
+The following options are available:
+
+| Property          | Description                                                                                                                 |
+| ----------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| **`root`**        | The Root View overrides all other nested views and routes. No document controls or tabs are rendered when this key is set.  |
+| **`default`**     | The Default View is the primary view in which your document is edited. It is rendered within the "Edit" tab.     |
+| **`versions`**    | The Versions View is used to navigate the version history of a single document. It is rendered within the "Versions" tab. [More details](../versions).                    |
+| **`version`**     | The Version View is used to edit a single version of a document. It is rendered within the "Version" tab. [More details](../versions). |
+| **`api`**         | The API View is used to display the REST API JSON response for a given document. It is rendered within the "API" tab.                                            |
+| **`livePreview`** | The LivePreview view is used to display the Live Preview interface. It is rendered within the "Live Preview" tab. [More details](../live-preview).                        |
+
+### Document Tabs
+
+Each Document View can be given a new tab in the Edit View, if desired. Tabs are highly configurable, from as simple as changing the label to swapping out the entire component, they can be modified in any way. To add or customize tabs in the Edit View, use the `tab` key:
+
+```ts
+import type { SanitizedCollectionConfig } from 'payload'
+
+export const MyCollection: SanitizedCollectionConfig = {
+  slug: 'my-collection',
+  admin: {
+    components: {
+      views: {
+        edit: {
+          myCustomTab: {
+            Component: '/path/to/MyCustomTab',
+            path: '/my-custom-tab',
+            tab: {
+              Component: '/path/to/MyCustomTabComponent' // highlight-line
+            }
+          },
+          anotherCustomTab: {
+            Component: '/path/to/AnotherCustomView',
+            path: '/another-custom-view',
+            // highlight-start
+            tab: {
+              label: 'Another Custom View',
+              href: '/another-custom-view',
+            }
+            // highlight-end
+          },
+        },
+      },
+    },
+  },
+}
+```
+
+<Banner type="warning">
+ <strong>Note:</strong>
+ This applies to _both_ Collections _and_ Globals.
+</Banner>
+
+## Building Custom Views
+
+Custom Views are just [Custom Components](./components) rendered at the page-level. To understand how to build Custom Views, first review the [Building Custom Components](./components#building-custom-components) guide. Once you have a Custom Component ready, you can use it as a Custom View.
+
+```ts
+import type { SanitizedCollectionConfig } from 'payload'
+
+export const MyCollectionConfig: SanitizedCollectionConfig = {
+  // ...
+  admin: {
+    components: {
+      views: {
+        edit: {
+          Component: '/path/to/MyCustomView' // highlight-line
+        }
+      },
+    },
+  },
+}
+```
+
+Your Custom Views will be provided with the following props:
+
+| Prop                      | Description                                                                                                                            |
+| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
+| **`initPageResult`**      | An object containing `req`, `payload`, `permissions`, etc.                                                                  |
+| **`clientConfig`**        | The Client Config object. [More details](../components#accessing-the-payload-config).                                                             |
+| **`importMap`**           | The import map object.                                                        |
+| **`params`**              | An object containing the [Dynamic Route Parameters](https://nextjs.org/docs/app/building-your-application/routing/dynamic-routes).     |
+| **`searchParams`**        | An object containing the [Search Parameters](https://developer.mozilla.org/docs/Learn/Common_questions/What_is_a_URL#parameters).      |
+
+<Banner type="success">
+  <strong>Reminder:</strong>
+  All [Custom Server Components](./components) receive `payload` and `i18n` by default. See [Building Custom Components](./components#building-custom-components) for more details.
+</Banner>
+
+<Banner type="warning">
+  <strong>Important:</strong>
+  It's up to you to secure your custom views. If your view requires a user to be logged in or to
+  have certain access rights, you should handle that within your view component yourself.
+</Banner>

docs/authentication/api-keys.mdx

@@ -0,0 +1,81 @@
+---
+title: API Key Strategy
+label: API Key Strategy
+order: 50
+desc: Enable API key based authentication to interface with Payload.
+keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+To integrate with third-party APIs or services, you might need the ability to generate API keys that can be used to identify as a certain user within Payload. API keys are generated on a user-by-user basis, similar to email and passwords, and are meant to represent a single user.
+
+For example, if you have a third-party service or external app that needs to be able to perform protected actions against Payload, first you need to create a user within Payload, i.e. `dev@thirdparty.com`. From your external application you will need to authenticate with that user, you have two options:
+
+1. Log in each time with that user and receive an expiring token to request with.
+1. Generate a non-expiring API key for that user to request with.
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  <br/>
+  This is particularly useful as you can create a "user" that reflects an integration with a specific external service and assign a "role" or specific access only needed by that service/integration.
+</Banner>
+
+Technically, both of these options will work for third-party integrations but the second option with API key is simpler, because it reduces the amount of work that your integrations need to do to be authenticated properly.
+
+To enable API keys on a collection, set the `useAPIKey` auth option to `true`. From there, a new interface will appear in the [Admin Panel](../admin/overview) for each document within the collection that allows you to generate an API key for each user in the Collection.
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const ThirdPartyAccess: CollectionConfig = {
+  slug: 'third-party-access',
+  auth: {
+    useAPIKey: true, // highlight-line
+  },
+  fields: [],
+}
+```
+
+User API keys are encrypted within the database, meaning that if your database is compromised,
+your API keys will not be.
+
+<Banner type="warning">
+  <strong>Important:</strong>
+  If you change your `PAYLOAD_SECRET`, you will need to regenerate your API keys.
+  <br />
+  The secret key is used to encrypt the API keys, so if you change the secret, existing API keys will
+  no longer be valid.
+</Banner>
+
+### HTTP Authentication
+
+To authenticate REST or GraphQL API requests using an API key, set the `Authorization` header. The header is case-sensitive and needs the slug of the `auth.useAPIKey` enabled collection, then " API-Key ", followed by the `apiKey` that has been assigned. Payload's built-in middleware will then assign the user document to `req.user` and handle requests with the proper [Access Control](../access-control/overview). By doing this, Payload recognizes the request being made as a request by the user associated with that API key.
+
+**For example, using Fetch:**
+
+```ts
+import Users from '../collections/Users'
+
+const response = await fetch('http://localhost:3000/api/pages', {
+  headers: {
+    Authorization: `${Users.slug} API-Key ${YOUR_API_KEY}`,
+  },
+})
+```
+
+Payload ensures that the same, uniform [Access Control](../access-control/overview) is used across all authentication strategies. This enables you to utilize your existing Access Control configurations with both API keys and the standard email/password authentication. This consistency can aid in maintaining granular control over your API keys.
+
+### API Key Only Auth
+
+If you want to use API keys as the only authentication method for a collection, you can disable the default local strategy by setting `disableLocalStrategy` to `true` on the collection's `auth` property. This will disable the ability to authenticate with email and password, and will only allow for authentication via API key.
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const ThirdPartyAccess: CollectionConfig = {
+  slug: 'third-party-access',
+  auth: {
+    useAPIKey: true,
+    disableLocalStrategy: true, // highlight-line
+  },
+}
+```

docs/authentication/cookies.mdx

@@ -0,0 +1,87 @@
+---
+title: Cookie Strategy
+label: Cookie Strategy
+order: 40
+desc: Enable HTTP Cookie based authentication to interface with Payload.
+keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+Payload offers the ability to [Authenticate](./overview) via HTTP-only cookies. These can be read from the responses of `login`, `logout`, `refresh`, and `me` auth operations.
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  You can access the logged-in user from within [Access Control](../access-control/overview) and [Hooks](../hooks/overview) through the `req.user` argument. [More details](./token-data).
+</Banner>
+
+### Automatic browser inclusion
+
+Modern browsers automatically include `http-only` cookies when making requests directly to URLs—meaning that if you are running your API on `https://example.com`, and you have logged in and visit `https://example.com/test-page`, your browser will automatically include the Payload authentication cookie for you.
+
+### HTTP Authentication
+
+However, if you use `fetch` or similar APIs to retrieve Payload resources from its REST or GraphQL API, you must specify to include credentials (cookies).
+
+Fetch example, including credentials:
+
+```ts
+const response = await fetch('http://localhost:3000/api/pages', {
+  credentials: 'include',
+})
+
+const pages = await response.json()
+```
+
+For more about including cookies in requests from your app to your Payload API, [read the MDN docs](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#Sending_a_request_with_credentials_included).
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  To make sure you have a Payload cookie set properly in your browser after logging in, you can use
+  the browsers Developer Tools > Application > Cookies > [your-domain-here]. The Developer tools
+  will still show HTTP-only cookies.
+</Banner>
+
+### CSRF Attacks
+
+CSRF (cross-site request forgery) attacks are common and dangerous. By using an HTTP-only cookie, Payload removes many XSS vulnerabilities, however, CSRF attacks can still be possible.
+
+For example, let's say you have a popular app `https://payload-finances.com` that allows users to manage finances, send and receive money. As Payload is using HTTP-only cookies, that means that browsers automatically will include cookies when sending requests to your domain - <strong>no matter what page created the request</strong>.
+
+So, if a user of `https://payload-finances.com` is logged in and is browsing around on the internet, they might stumble onto a page with malicious intent. Let's look at an example:
+
+```ts
+// malicious-intent.com
+// makes an authenticated request as on your behalf
+
+const maliciousRequest = await fetch(`https://payload-finances.com/api/me`, {
+  credentials: 'include'
+}).then(res => await res.json())
+```
+
+In this scenario, if your cookie was still valid, malicious-intent.com would be able to make requests like the one above on your behalf. This is a CSRF attack.
+
+### CSRF Prevention
+
+Define domains that your trust and are willing to accept Payload HTTP-only cookie based requests from. Use the `csrf` option on the base Payload Config to do this:
+
+```ts
+// payload.config.ts
+
+import { buildConfig } from 'payload'
+
+const config = buildConfig({
+  serverURL: 'https://my-payload-instance.com',
+  // highlight-start
+  csrf: [
+    // whitelist of domains to allow cookie auth from
+    'https://your-frontend-app.com',
+    'https://your-other-frontend-app.com',
+    // `config.serverURL` is added by default if defined
+  ],
+  // highlight-end
+  collections: [
+    // collections here
+  ],
+})
+
+export default config
+```

docs/authentication/custom-strategies.mdx

@@ -0,0 +1,94 @@
+---
+title: Custom Strategies
+label: Custom Strategies
+order: 60
+desc: Create custom authentication strategies to handle everything auth in Payload.
+keywords: authentication, config, configuration, overview, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+<Banner type="warning">
+  This is an advanced feature, so only attempt this if you are an experienced developer. Otherwise,
+  just let Payload's built-in authentication handle user auth for you.
+</Banner>
+
+### Creating a strategy
+
+At the core, a strategy is a way to authenticate a user making a request. As of `3.0` we moved away from [Passport](https://www.passportjs.org) in favor of pulling back the curtain and putting you in full control.
+
+A strategy is made up of the following:
+
+| Parameter                   | Description                                                               |
+| --------------------------- | ------------------------------------------------------------------------- |
+| **`name`** \*               | The name of your strategy                                                 |
+| **`authenticate`**&nbsp;\*  | A function that takes in the parameters below and returns a user or null. |
+
+The `authenticate` function is passed the following arguments:
+
+| Argument            | Description                                                                                       |
+| ------------------- | ------------------------------------------------------------------------------------------------- |
+| **`headers`** \*    | The headers on the incoming request. Useful for retrieving identifiable information on a request. |
+| **`payload`** \*    | The Payload class. Useful for authenticating the identifiable information against Payload.        |
+| **`isGraphQL`**     | Whether or not the request was made from a GraphQL endpoint. Default is `false`.                  |
+
+
+### Example Strategy
+
+At its core a strategy simply takes information from the incoming request and returns a user. This is exactly how Payload's built-in strategies function.
+
+Your `authenticate` method should return an object containing a Payload user document and any optional headers that you'd like Payload to set for you when we return a response.
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const Users: CollectionConfig = {
+  slug: 'users',
+  auth: {
+    disableLocalStrategy: true,
+    // highlight-start
+    strategies: [
+      {
+        name: 'custom-strategy',
+        authenticate: ({ payload, headers }) => {
+          const usersQuery = await payload.find({
+            collection: 'users',
+            where: {
+              code: {
+                equals: headers.get('code'),
+              },
+              secret: {
+                equals: headers.get('secret'),
+              },
+            },
+          })
+
+          return {
+            // Send the user back to authenticate,
+            // or send null if no user should be authenticated
+            user: usersQuery.docs[0] || null,
+
+            // Optionally, you can return headers
+            // that you'd like Payload to set here when
+            // it returns the response
+            responseHeaders: new Headers({
+              'some-header': 'my header value'
+            })
+          }
+        }
+      }
+    ]
+    // highlight-end
+  },
+  fields: [
+    {
+      name: 'code',
+      type: 'text',
+      index: true,
+      unique: true,
+    },
+    {
+      name: 'secret',
+      type: 'text',
+    },
+  ]
+}
+```

docs/authentication/email.mdx

@@ -0,0 +1,203 @@
+---
+title: Authentication Emails
+label: Email Verification
+order: 30
+desc: Email Verification allows users to verify their email address before they're account is fully activated. Email Verification ties directly into the Email functionality that Payload provides.
+keywords: authentication, email, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+[Authentication](./overview) ties directly into the [Email](../email) functionality that Payload provides. This allows you to send emails to users for verification, password resets, and more. While Payload provides default email templates for these actions, you can customize them to fit your brand.
+
+## Email Verification
+
+Email Verification forces users to prove they have access to the email address they can authenticate. This will help to reduce spam accounts and ensure that users are who they say they are.
+
+To enable Email Verification, use the `auth.verify` property on your [Collection Config](../configuration/collections):
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const Customers: CollectionConfig = {
+  // ...
+  auth: {
+    verify: true // highlight-line
+  },
+}
+```
+
+<Banner type="info">
+  <strong>Tip:</strong>
+  Verification emails are fully customizable. [More details](#generateEmailHTML).
+</Banner>
+
+The following options are available:
+
+| Option               | Description                                                                                                                                                                                                                         |
+|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **`generateEmailHTML`** | Allows for overriding the HTML within emails that are sent to users indicating how to validate their account. [More details](#generateEmailHTML). |
+| **`generateEmailSubject`** | Allows for overriding the subject of the email that is sent to users indicating how to validate their account. [More details](#generateEmailSubject). |
+
+#### generateEmailHTML
+
+Function that accepts one argument, containing `{ req, token, user }`, that allows for overriding the HTML within emails that are sent to users indicating how to validate their account. The function should return a string that supports HTML, which can optionally be a full HTML email.
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const Customers: CollectionConfig = {
+  // ...
+  auth: {
+    verify: {
+      // highlight-start
+      generateEmailHTML: ({ req, token, user }) => {
+        // Use the token provided to allow your user to verify their account
+        const url = `https://yourfrontend.com/verify?token=${token}`
+
+        return `Hey ${user.email}, verify your email by clicking here: ${url}`
+      },
+      // highlight-end
+    },
+  },
+}
+```
+
+<Banner type="warning">
+  <strong>Important:</strong>
+  If you specify a different URL to send your users to for email verification, such as a page on the
+  frontend of your app or similar, you need to handle making the call to the Payload REST or GraphQL
+  verification operation yourself on your frontend, using the token that was provided for you.
+  Above, it was passed via query parameter.
+</Banner>
+
+#### generateEmailSubject
+
+Similarly to the above `generateEmailHTML`, you can also customize the subject of the email. The function argument are the same but you can only return a string - not HTML.
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const Customers: CollectionConfig = {
+  // ...
+  auth: {
+    verify: {
+      // highlight-start
+      generateEmailSubject: ({ req, user }) => {
+        return `Hey ${user.email}, reset your password!`;
+      }
+      // highlight-end
+    }
+  }
+}
+```
+
+## Forgot Password
+
+You can customize how the Forgot Password workflow operates with the following options on the `auth.forgotPassword` property:
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const Customers: CollectionConfig = {
+  // ...
+  auth: {
+    forgotPassword: { // highlight-line
+      // ...
+    },
+  },
+}
+```
+
+The following options are available:
+
+| Option               | Description                                                                                                                                                                                                                         |
+|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **`generateEmailHTML`** | Allows for overriding the HTML within emails that are sent to users attempting to reset their password. [More details](#generateEmailHTML). |
+| **`generateEmailSubject`** | Allows for overriding the subject of the email that is sent to users attempting to reset their password. [More details](#generateEmailSubject). |
+
+#### generateEmailHTML
+
+This function allows for overriding the HTML within emails that are sent to users attempting to reset their password. The function should return a string that supports HTML, which can be a full HTML email.
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const Customers: CollectionConfig = {
+  // ...
+  auth: {
+    forgotPassword: {
+      // highlight-start
+      generateEmailHTML: ({ req, token, user }) => {
+        // Use the token provided to allow your user to reset their password
+        const resetPasswordURL = `https://yourfrontend.com/reset-password?token=${token}`
+
+        return `
+          <!doctype html>
+          <html>
+            <body>
+              <h1>Here is my custom email template!</h1>
+              <p>Hello, ${user.email}!</p>
+              <p>Click below to reset your password.</p>
+              <p>
+                <a href="${resetPasswordURL}">${resetPasswordURL}</a>
+              </p>
+            </body>
+          </html>
+        `
+      },
+      // highlight-end
+    },
+  },
+}
+```
+
+<Banner type="warning">
+  <strong>Important:</strong>
+  If you specify a different URL to send your users to for resetting their password, such as a page
+  on the frontend of your app or similar, you need to handle making the call to the Payload REST or
+  GraphQL reset-password operation yourself on your frontend, using the token that was provided for
+  you. Above, it was passed via query parameter.
+</Banner>
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  HTML templating can be used to create custom email templates, inline CSS automatically, and more.
+  You can make a reusable function that standardizes all email sent from Payload, which makes
+  sending custom emails more DRY. Payload doesn't ship with an HTML templating engine, so you are
+  free to choose your own.
+</Banner>
+
+The following arguments are passed to the `generateEmailHTML` function:
+
+| Argument | Description                                                                                   |
+|----------|-----------------------------------------------------------------------------------------------|
+| `req`    | The request object.                                                                           |
+| `token`  | The token that is generated for the user to reset their password.                             |
+| `user`   | The user document that is attempting to reset their password.                                 |
+
+#### generateEmailSubject
+
+Similarly to the above `generateEmailHTML`, you can also customize the subject of the email. The function argument are the same but you can only return a string - not HTML.
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const Customers: CollectionConfig = {
+  // ...
+  auth: {
+    forgotPassword: {
+      // highlight-start
+      generateEmailSubject: ({ req, user }) => {
+        return `Hey ${user.email}, reset your password!`;
+      }
+      // highlight-end
+    }
+  }
+}
+```
+
+The following arguments are passed to the `generateEmailSubject` function:
+
+| Argument | Description                                                                                   |
+|----------|-----------------------------------------------------------------------------------------------|
+| `req`    | The request object.                                                                           |
+| `user`   | The user document that is attempting to reset their password.                                 |

docs/authentication/jwt.mdx

@@ -0,0 +1,51 @@
+---
+title: JWT Strategy
+label: JWT Strategy
+order: 40
+desc: Enable JSON Web Token based authentication to interface with Payload.
+keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+Payload offers the ability to [Authenticate](./overview) via JSON Web Tokens (JWT). These can be read from the responses of `login`, `logout`, `refresh`, and `me` auth operations.
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  You can access the logged-in user from within [Access Control](../access-control/overview) and [Hooks](../hooks/overview) through the `req.user` argument. [More details](./token-data).
+</Banner>
+
+### Identifying Users Via The Authorization Header
+
+In addition to authenticating via an HTTP-only cookie, you can also identify users via the `Authorization` header on an HTTP request.
+
+Example:
+
+```ts
+const user = await fetch('http://localhost:3000/api/users/login', {
+  method: 'POST',
+  body: JSON.stringify({
+    email: 'dev@payloadcms.com',
+    password: 'password',
+  })
+}).then(req => await req.json())
+
+const request = await fetch('http://localhost:3000', {
+  headers: {
+    Authorization: `JWT ${user.token}`,
+  },
+})
+```
+
+### Omitting The Token
+
+In some cases you may want to prevent the token from being returned from the auth operations. You can do that by setting `removeTokenFromResponse` to `true` like so:
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const UsersWithoutJWTs: CollectionConfig = {
+  slug: 'users-without-jwts',
+  auth: {
+    removeTokenFromRepsonse: true, // highlight-line
+  },
+}
+```

docs/authentication/operations.mdx

@@ -0,0 +1,398 @@
+---
+title: Authentication Operations
+label: Operations
+order: 20
+desc: Enabling Authentication automatically makes key operations available such as Login, Logout, Verify, Unlock, Reset Password and more.
+keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+Enabling [Authentication](./overview) on a [Collection](../configuration/collections) automatically exposes additional auth-based operations in the [Local API](../local-api/overview), [REST API](../rest-api/overview), and [GraphQL API](../graphql/overview).
+
+## Access
+
+The Access operation returns what a logged in user can and can't do with the collections and globals that are registered via your config. This data can be immensely helpful if your app needs to show and hide certain features based on [Access Control](../access-control/overview), just as the [Admin Panel](../admin/overview) does.
+
+**REST API endpoint**:
+
+`GET http://localhost:3000/api/access`
+
+Example response:
+
+```ts
+{
+  canAccessAdmin: true,
+  collections: {
+    pages: {
+      create: {
+        permission: true,
+      },
+      read: {
+        permission: true,
+      },
+      update: {
+        permission: true,
+      },
+      delete: {
+        permission: true,
+      },
+      fields: {
+        title: {
+          create: {
+            permission: true,
+          },
+          read: {
+            permission: true,
+          },
+          update: {
+            permission: true,
+          },
+        }
+      }
+    }
+  }
+}
+```
+
+**Example GraphQL Query**:
+
+```graphql
+query {
+  Access {
+    pages {
+      read {
+        permission
+      }
+    }
+  }
+}
+```
+
+Document access can also be queried on a collection/global basis. Access on a global can queried like `http://localhost:3000/api/global-slug/access`, Collection document access can be queried like `http://localhost:3000/api/collection-slug/access/:id`.
+
+## Me
+
+Returns either a logged in user with token or null when there is no logged in user.
+
+**REST API endpoint**:
+
+`GET http://localhost:3000/api/[collection-slug]/me`
+
+Example response:
+
+```ts
+{
+  user: { // The JWT "payload" ;) from the logged in user
+    email: 'dev@payloadcms.com',
+    createdAt: "2020-12-27T21:16:45.645Z",
+    updatedAt: "2021-01-02T18:37:41.588Z",
+    id: "5ae8f9bde69e394e717c8832"
+  },
+  token: '34o4345324...', // The token that can be used to authenticate the user
+  exp: 1609619861, // Unix timestamp representing when the user's token will expire
+}
+```
+
+**Example GraphQL Query**:
+
+```graphql
+query {
+  me[collection-singular-label] {
+    user {
+      email
+    }
+    exp
+  }
+}
+```
+
+## Login
+
+Accepts an `email` and `password`. On success, it will return the logged in user as well as a token that can be used to authenticate. In the GraphQL and REST APIs, this operation also automatically sets an HTTP-only cookie including the user's token. If you pass a `res` to the Local API operation, Payload will set a cookie there as well.
+
+**Example REST API login**:
+
+```ts
+const res = await fetch('http://localhost:3000/api/[collection-slug]/login', {
+  method: 'POST',
+  headers: {
+    'Content-Type': 'application/json',
+  },
+  body: JSON.stringify({
+    email: 'dev@payloadcms.com',
+    password: 'this-is-not-our-password...or-is-it?',
+  }),
+})
+
+const json = await res.json()
+
+// JSON will be equal to the following:
+/*
+{
+  user: {
+    email: 'dev@payloadcms.com',
+    createdAt: "2020-12-27T21:16:45.645Z",
+    updatedAt: "2021-01-02T18:37:41.588Z",
+    id: "5ae8f9bde69e394e717c8832"
+  },
+  token: '34o4345324...',
+  exp: 1609619861
+}
+*/
+```
+
+**Example GraphQL Mutation**:
+
+```graphql
+mutation {
+  login[collection-singular-label](email: "dev@payloadcms.com", password: "yikes") {
+    user {
+      email
+    }
+    exp
+    token
+  }
+}
+```
+
+**Example Local API login**:
+
+```ts
+const result = await payload.login({
+  collection: '[collection-slug]',
+  data: {
+    email: 'dev@payloadcms.com',
+    password: 'get-out',
+  },
+})
+```
+
+## Logout
+
+As Payload sets HTTP-only cookies, logging out cannot be done by just removing a cookie in JavaScript, as HTTP-only cookies are inaccessible by JS within the browser. So, Payload exposes a `logout` operation to delete the token in a safe way.
+
+**Example REST API logout**:
+
+```ts
+const res = await fetch('http://localhost:3000/api/[collection-slug]/logout', {
+  method: 'POST',
+  headers: {
+    'Content-Type': 'application/json',
+  },
+})
+```
+
+**Example GraphQL Mutation**:
+
+```
+mutation {
+  logout[collection-singular-label]
+}
+```
+
+## Refresh
+
+Allows for "refreshing" JWTs. If your user has a token that is about to expire, but the user is still active and using the app, you might want to use the `refresh` operation to receive a new token by executing this operation via the authenticated user.
+
+This operation requires a non-expired token to send back a new one. If the user's token has already expired, you will need to allow them to log in again to retrieve a new token.
+
+If successful, this operation will automatically renew the user's HTTP-only cookie and will send back the updated token in JSON.
+
+**Example REST API token refresh**:
+
+```ts
+const res = await fetch('http://localhost:3000/api/[collection-slug]/refresh-token', {
+  method: 'POST',
+  headers: {
+    'Content-Type': 'application/json',
+  },
+})
+
+const json = await res.json()
+
+// JSON will be equal to the following:
+/*
+{
+  user: {
+    email: 'dev@payloadcms.com',
+    createdAt: "2020-12-27T21:16:45.645Z",
+    updatedAt: "2021-01-02T18:37:41.588Z",
+    id: "5ae8f9bde69e394e717c8832"
+  },
+  refreshedToken: '34o4345324...',
+  exp: 1609619861
+}
+*/
+```
+
+**Example GraphQL Mutation**:
+
+```
+mutation {
+  refreshToken[collection-singular-label] {
+    user {
+      email
+    }
+    refreshedToken
+  }
+}
+```
+
+## Verify by Email
+
+If your collection supports email verification, the Verify operation will be exposed which accepts a verification token and sets the user's `_verified` property to `true`, thereby allowing the user to authenticate with the Payload API.
+
+**Example REST API user verification**:
+
+```ts
+const res = await fetch(`http://localhost:3000/api/[collection-slug]/verify/${TOKEN_HERE}`, {
+  method: 'POST',
+  headers: {
+    'Content-Type': 'application/json',
+  },
+})
+```
+
+**Example GraphQL Mutation**:
+
+```graphql
+mutation {
+  verifyEmail[collection-singular-label](token: "TOKEN_HERE")
+}
+```
+
+**Example Local API verification**:
+
+```ts
+const result = await payload.verifyEmail({
+  collection: '[collection-slug]',
+  token: 'TOKEN_HERE',
+})
+```
+
+## Unlock
+
+If a user locks themselves out and you wish to deliberately unlock them, you can utilize the Unlock operation. The [Admin Panel](../admin/overview) features an Unlock control automatically for all collections that feature max login attempts, but you can programmatically unlock users as well by using the Unlock operation.
+
+To restrict who is allowed to unlock users, you can utilize the [`unlock`](../access-control/overview#unlock) access control function.
+
+**Example REST API unlock**:
+
+```ts
+const res = await fetch(`http://localhost:3000/api/[collection-slug]/unlock`, {
+  method: 'POST',
+  headers: {
+    'Content-Type': 'application/json',
+  },
+})
+```
+
+**Example GraphQL Mutation**:
+
+```
+mutation {
+  unlock[collection-singular-label]
+}
+```
+
+**Example Local API unlock**:
+
+```ts
+const result = await payload.unlock({
+  collection: '[collection-slug]',
+})
+```
+
+## Forgot Password
+
+Payload comes with built-in forgot password functionality. Submitting an email address to the Forgot Password operation will generate an email and send it to the respective email address with a link to reset their password.
+
+The link to reset the user's password contains a token which is what allows the user to securely reset their password.
+
+By default, the Forgot Password operations send users to the [Admin Panel](../admin/overview) to reset their password, but you can customize the generated email to send users to the frontend of your app instead by [overriding the email HTML](/docs/authentication/overview#forgot-password).
+
+**Example REST API Forgot Password**:
+
+```ts
+const res = await fetch(`http://localhost:3000/api/[collection-slug]/forgot-password`, {
+  method: 'POST',
+  headers: {
+    'Content-Type': 'application/json',
+  },
+  body: JSON.stringify({
+    email: 'dev@payloadcms.com',
+  }),
+})
+```
+
+**Example GraphQL Mutation**:
+
+```
+mutation {
+  forgotPassword[collection-singular-label](email: "dev@payloadcms.com")
+}
+```
+
+**Example Local API forgot password**:
+
+```ts
+const token = await payload.forgotPassword({
+  collection: '[collection-slug]',
+  data: {
+    email: 'dev@payloadcms.com',
+  },
+  disableEmail: false, // you can disable the auto-generation of email via local API
+})
+```
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  <br />
+  You can stop the reset-password email from being sent via using the local API. This is helpful if
+  you need to create user accounts programmatically, but not set their password for them. This
+  effectively generates a reset password token which you can then use to send to a page you create,
+  allowing a user to "complete" their account by setting their password. In the background, you'd
+  use the token to "reset" their password.
+</Banner>
+
+## Reset Password
+
+After a user has "forgotten" their password and a token is generated, that token can be used to send to the reset password operation along with a new password which will allow the user to reset their password securely.
+
+**Example REST API Reset Password**:
+
+```ts
+const res = await fetch(`http://localhost:3000/api/[collection-slug]/reset-password`, {
+  method: 'POST',
+  headers: {
+    'Content-Type': 'application/json',
+  },
+  body: JSON.stringify({
+    token: 'TOKEN_GOES_HERE'
+    password: 'not-today',
+  }),
+});
+
+const json = await res.json();
+
+// JSON will be equal to the following:
+/*
+{
+  user: {
+    email: 'dev@payloadcms.com',
+    createdAt: "2020-12-27T21:16:45.645Z",
+    updatedAt: "2021-01-02T18:37:41.588Z",
+    id: "5ae8f9bde69e394e717c8832"
+  },
+  token: '34o4345324...',
+  exp: 1609619861
+}
+*/
+```
+
+**Example GraphQL Mutation**:
+
+```graphql
+mutation {
+  resetPassword[collection-singular-label](token: "TOKEN_GOES_HERE", password: "not-today")
+}
+```

docs/authentication/overview.mdx

@@ -0,0 +1,197 @@
+---
+title: Authentication Overview
+label: Overview
+order: 10
+desc: Payload provides highly secure user Authentication out of the box, and you can fully customize, override, or remove the default Authentication support.
+keywords: authentication, config, configuration, overview, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+<YouTube
+  id="CT4KafeJjTI"
+  title="Simplified Authentication for Headless CMS: Unlocking Reusability in One Line"
+/>
+
+Authentication is a critical part of any application. Payload provides a secure, portable way to manage user accounts out of the box. Payload Authentication is designed to be used in both the [Admin Panel](../admin/overview), all well as your own external applications, completely eliminating the need for paid, third-party platforms and services.
+
+Here are some common use cases of Authentication in your own applications:
+
+- Customer accounts for an e-commerce app
+- User accounts for a SaaS product
+- P2P apps or social sites where users need to log in and manage their profiles
+- Online games where players need to track their progress over time
+
+When Authentication is enabled on a [Collection](../configuration/collections), Payload injects all necessary functionality to support the entire user flow. This includes all [auth-related operations](./operations) like account creation, logging in and out, and resetting passwords, all [auth-related emails](./email) like email verification and password reset, as well as any necessary UI to manage users from the Admin Panel.
+
+To enable Authentication on a Collection, use the `auth` property in the [Collection Config](../configuration/collection#auth):
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const Users: CollectionConfig = {
+  // ...
+  auth: true, // highlight-line
+}
+```
+
+![Authentication Admin Panel functionality](https://payloadcms.com/images/docs/auth-admin.jpg)
+_Admin Panel screenshot depicting an Admins Collection with Auth enabled_
+
+## Config Options
+
+Any [Collection](../configuration/collections) can opt-in to supporting Authentication. Once enabled, each Document that is created within the Collection can be thought of as a "user". This enables a complete authentication workflow on your Collection, such as logging in and out, resetting their password, and more.
+
+<Banner type="warning">
+  <strong>Note:</strong>
+  By default, Payload provides an auth-enabled `User` Collection which is used to access the Admin Panel. [More details](../admin/overview#the-admin-user-collection).
+</Banner>
+
+To enable Authentication on a Collection, use the `auth` property in the [Collection Config](../configuration/collections):
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const Admins: CollectionConfig = {
+  // ...
+  // highlight-start
+  auth: {
+    tokenExpiration: 7200, // How many seconds to keep the user logged in
+    verify: true, // Require email verification before being allowed to authenticate
+    maxLoginAttempts: 5, // Automatically lock a user out after X amount of failed logins
+    lockTime: 600 * 1000, // Time period to allow the max login attempts
+    // More options are available
+  },
+  // highlight-end
+}
+```
+
+<Banner type="info">
+  <strong>Tip:</strong>
+  For default auth behavior, set `auth: true`. This is a good starting point for most applications.
+</Banner>
+
+<Banner type="warning">
+  <strong>Note:</strong>
+  Auth-enabled Collections with be automatically injected with the `hash`, `salt`, and `email` fields. [More details](../fields/overview#field-names).
+</Banner>
+
+The following options are available:
+
+| Option                     | Description                                                                                                                                                                                                                         |
+|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **`cookies`**              | Set cookie options, including `secure`, `sameSite`, and `domain`. For advanced users.                                                                                                                                               |
+| **`depth`**                | How many levels deep a `user` document should be populated when creating the JWT and binding the `user` to the `req`. Defaults to `0` and should only be modified if absolutely necessary, as this will affect performance. |
+| **`disableLocalStrategy`** | Advanced - disable Payload's built-in local auth strategy. Only use this property if you have replaced Payload's auth mechanisms with your own.                                                                                     |
+| **`forgotPassword`**       | Customize the way that the `forgotPassword` operation functions. [More details](./email#forgot-password).                                                                                                             |
+| **`lockTime`**             | Set the time (in milliseconds) that a user should be locked out if they fail authentication more times than `maxLoginAttempts` allows for.                                                                                          |
+| **`loginWithUsername`**    | Ability to allow users to login with username/password. [More](/docs/authentication/overview#login-with-username)                                                                                                                     |
+| **`maxLoginAttempts`**     | Only allow a user to attempt logging in X amount of times. Automatically locks out a user from authenticating if this limit is passed. Set to `0` to disable.                                                                       |
+| **`removeTokenFromResponses`** | Set to true if you want to remove the token from the returned authentication API responses such as login or refresh.                                                                                                                                                            |
+| **`strategies`**           | Advanced - an array of custom authentification strategies to extend this collection's authentication with. [More details](./custom-strategies).                                                                         |
+| **`tokenExpiration`**      | How long (in seconds) to keep the user logged in. JWTs and HTTP-only cookies will both expire at the same time.                                                                                                                     |
+| **`useAPIKey`**            | Payload Authentication provides for API keys to be set on each user within an Authentication-enabled Collection. [More details](./api-keys).                                                                       |
+| **`verify`**               | Set to `true` or pass an object with verification options to require users to verify by email before they are allowed to log into your app. [More details](./email#email-verification).                                  |
+
+### Login With Username
+
+You can allow users to login with their username instead of their email address by setting the `loginWithUsername` property to `true`.
+
+Example:
+
+```ts
+{
+  slug: 'customers',
+  auth: {
+    loginWithUsername: true,
+  },
+}
+```
+
+Or, you can pass an object with additional options:
+
+```ts
+{
+  slug: 'customers',
+  auth: {
+    loginWithUsername: {
+      allowEmailLogin: true, // default: false
+      requireEmail: false, // default: false
+    },
+  },
+}
+```
+
+**`allowEmailLogin`**
+
+If set to `true`, users can log in with either their username or email address. If set to `false`, users can only log in with their username.
+
+**`requireEmail`**
+
+If set to `true`, an email address is required when creating a new user. If set to `false`, email is not required upon creation.
+
+## Auto-Login
+
+For testing and demo purposes you may want to skip forcing the user to login in order to access your application. Typically, all users should be required to login, however, you can speed up local development time by enabling auto-login.
+
+To enable auto-login, set the `autoLogin` property in the [Admin Config](../configuration/admin):
+
+```ts
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  // ...
+  // highlight-start
+  autoLogin:
+    process.env.NEXT_PUBLIC_ENABLE_AUTOLOGIN === 'true'
+      ? {
+          email: 'test@example.com',
+          password: 'test',
+          prefillOnly: true,
+        }
+      : false,
+  // highlight-end
+})
+```
+
+<Banner type="warning">
+  <strong>Warning:</strong>
+  The recommended way to use this feature is behind an [Environment Variable](../configuration/environment-vars). This will ensure it is _disabled_ in production.
+</Banner>
+
+The following options are available:
+
+| Option            | Description                                                                                                     |
+|-------------------|-----------------------------------------------------------------------------------------------------------------|
+| **`username`**    | The username of the user to login as                                                                            |
+| **`email`**       | The email address of the user to login as                                                                       |
+| **`password`**    | The password of the user to login as. This is only needed if `prefillOnly` is set to true                       |
+| **`prefillOnly`** | If set to true, the login credentials will be prefilled but the user will still need to click the login button. |
+
+## Operations
+
+All auth-related operations are available via Payload's REST, Local, and GraphQL APIs. These operations are automatically added to your Collection when you enable Authentication. [More details](./operations).
+
+## Strategies
+
+Out of the box Payload ships with a three powerful Authentication strategies:
+
+- [HTTP-Only Cookies](./cookies)
+- [JSON Web Tokens (JWT)](./jwt)
+- [API-Keys](./api-keys)
+
+Each of these strategies can work together or independently. You can also create your own custom strategies to fit your specific needs. [More details](./custom-strategies).
+
+### HTTP-Only Cookies
+
+[HTTP-only cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies) are a highly secure method of storing identifiable data on a user's device so that Payload can automatically recognize a returning user until their cookie expires. They are totally protected from common XSS attacks and <strong>cannot be read by JavaScript in the browser</strong>, unlike JWT's. [More details](./cookies).
+
+### JSON Web Tokens
+
+JWT (JSON Web Tokens) can also be utilized to perform authentication. Tokens are generated on `login`, `refresh` and `me` operations and can be attached to future requests to authenticate users. [More details](./jwt).
+
+### API Keys
+
+API Keys can be enabled on auth collections. These are particularly useful when you want to authenticate against Payload from a third party service. [More details](./api-keys).
+
+### Custom Strategies
+
+There are cases where these may not be enough for your application. Payload is extendable by design so you can wire up your own strategy when you need to. [More details](./custom-strategies).

docs/authentication/token-data.mdx

@@ -0,0 +1,107 @@
+---
+title: Token Data
+label: Token Data
+order: 70
+desc: Storing data for read on the request object.
+keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+During the lifecycle of a request you will be able to access the data you have configured to be stored in the JWT by accessing `req.user`. The user object is automatically appeneded to the request for you.
+
+### Definining Token Data
+
+You can specify what data gets encoded to the Cookie/JWT-Token by setting `saveToJWT` property on fields within your auth collection.
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const Users: CollectionConfig = {
+  slug: 'users',
+  auth: true,
+  fields: [
+    {
+      // will be stored in the JWT
+      saveToJWT: true,
+      type: 'select',
+      name: 'role',
+      options: [
+        'super-admin',
+        'user',
+      ]
+    },
+    {
+      // the entire object will be stored in the JWT
+      // tab fields can do the same thing!
+      saveToJWT: true,
+      type: 'group',
+      name: 'group1',
+      fields: [
+        {
+          type: 'text',
+          name: 'includeField',
+        },
+        {
+          // will be omitted from the JWT
+          saveToJWT: false,
+          type: 'text',
+          name: 'omitField',
+        },
+      ]
+    },
+    {
+      type: 'group',
+      name: 'group2',
+      fields: [
+        {
+          // will be stored in the JWT
+          // but stored at the top level
+          saveToJWT: true,
+          type: 'text',
+          name: 'includeField',
+        },
+        {
+          type: 'text',
+          name: 'omitField',
+        },
+      ]
+    },
+  ]
+}
+```
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  <br/>
+  If you wish to use a different key other than the field `name`, you can define `saveToJWT` as a string.
+</Banner>
+
+
+### Using Token Data
+
+This is especially helpful when writing [Hooks](../hooks/overview) and [Access Control](../access-control/overview) that depend on user defined fields.
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const Invoices: CollectionConfig = {
+  slug: 'invoices',
+  access: {
+    read: ({ req, data }) => {
+      if (!req?.user) return false
+      // highlight-start
+      if ({ req.user?.role === 'super-admin'}) {
+        return true
+      }
+      // highlight-end
+      return data.owner === req.user.id
+    }
+  }
+  fields: [
+    {
+      name: 'owner',
+      relationTo: 'users'
+    },
+    // ... other fields
+  ],
+}
+```

docs/cloud/configuration.mdx

@@ -0,0 +1,61 @@
+---
+title: Project Configuration
+label: Configuration
+order: 20
+desc: Quickly configure and deploy your Payload Cloud project in a few simple steps.
+keywords: configuration, config, settings, project, cloud, payload cloud, deploy, deployment
+---
+
+## Select your plan
+
+Once you have created a project, you will need to select your plan. This will determine the resources that are allocated to your project and the features that are available to you.
+
+<Banner type="success">
+  Note: All Payload Cloud teams that deploy a project require a card on file. This helps us prevent
+  fraud and abuse on our platform. If you select a plan with a free trial, you will not be charged
+  until your trial period is over. We’ll remind you 7 days before your trial ends and you can cancel
+  anytime.
+</Banner>
+
+## Project Details
+
+| Option           | Description                                                                                                                                                                                                                                   |
+| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Region**       | Select the region closest to your audience. This will ensure the fastest communication between your data and your client.                                                                                                                     |
+| **Project Name** | A name for your project. You can change this at any time.                                                                                                                                                                                     |
+| **Project Slug** | Choose a unique slug to identify your project. This needs to be unique for your team and you can change it any time.                                                                                                                          |
+| **Team**         | Select the team you want to create the project under. If this is your first project, a personal team will be created for you automatically. You can modify your team settings and invite new members at any time from the Team Settings page. |
+
+## Build Settings
+
+If you are deploying a new project from a template, the following settings will be automatically configured for you. If you are using your own repository, you need to make sure your build settings are accurate for your project to deploy correctly.
+
+| Option               | Description                                                                                                                                                       |
+| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Root Directory**   | The folder where your `package.json` file lives.                                                                                                                  |
+| **Install Command**  | The command used to install your modules, for example: `yarn install` or `npm install`                                                                            |
+| **Build Command**    | The command used to build your application, for example: `yarn build` or `npm run build`                                                                          |
+| **Serve Command**    | The command used to serve your application, for example: `yarn serve` or `npm run serve`                                                                          |
+| **Branch to Deploy** | Select the branch of your repository that you want to deploy from. This is the branch that will be used to build your project when you commit new changes.        |
+| **Default Domain**   | Set a default domain for your project. This must be unique and you will not able to change it. You can always add a custom domain later in your project settings. |
+
+## Environment Variables
+
+Any of the features in Payload Cloud that require environment variables will automatically be provided to your application. If your app requires any custom environment variables, you can set them here.
+
+<Banner type="warning">
+  Note: For security reasons, any variables you wish to provide to the [Admin Panel](../admin/overview) must be prefixed
+  with `NEXT_PUBLIC_`.  Learn more
+  [here](../configuration/environment-vars).
+</Banner>
+
+## Payment
+
+Payment methods can be set per project and can be updated any time. You can use team’s default payment method, or add a new one. Modify your payment methods in your Project settings / Team settings.
+
+<Banner type="success">
+  <strong>Note:</strong> All Payload Cloud teams that deploy a project require a card on file. This
+  helps us prevent fraud and abuse on our platform. If you select a plan with a free trial, you will
+  not be charged until your trial period is over. We’ll remind you 7 days before your trial ends and
+  you can cancel anytime.
+</Banner>

docs/cloud/creating-a-project.mdx

@@ -0,0 +1,51 @@
+---
+title: Getting Started
+label: Getting Started
+order: 10
+desc: Get started with Payload Cloud, a deployment solution specifically designed for Node + MongoDB applications.
+keywords: cloud, hosted, database, storage, email, deployment, serverless, node, mongodb, s3, aws, cloudflare, atlas, resend, payload, cms
+---
+
+A deployment solution specifically designed for Node.js + MongoDB applications, offering seamless deployment of your entire stack in one place. You can get started in minutes with a one-click template or bring your own codebase with you.
+
+Payload Cloud offers various plans tailored to meet your specific needs, including a MongoDB Atlas database, S3 file storage, and email delivery powered by [Resend](https://resend.com). To see a full breakdown of features and plans, see our [Cloud Pricing page](https://payloadcms.com/cloud-pricing).
+
+To get started, you first need to create an account. Head over to [the login screen](https://payloadcms.com/login) and **Register for Free**.
+
+<Banner type="success">
+  To create your first project, you can either select [a template](#starting-from-a-template) or
+  [import an existing project](#importing-from-an-existing-codebase) from GitHub.
+</Banner>
+
+## Starting from a Template
+
+Templates come preconfigured and provide a one-click solution to quickly deploy a new application.
+
+![Screen for creating a new project from a template](https://payloadcms.com/images/docs/cloud/create-from-template.jpg)
+_Creating a new project from a template._
+
+After creating an account, select your desired template from the Projects page. At this point, you need to connect to authorize the Payload Cloud application with your GitHub account. Click Continue with GitHub and follow the prompts to authorize the app.
+
+Next, select your `GitHub Scope`. If you belong to multiple organizations, they will show up here. If you do not see the organization you are looking for, you may need to adjust your GitHub app permissions.
+
+After selecting your scope, create a unique `repository name` and select whether you want your repository to be public or private on GitHub.
+
+<Banner type="warning">
+  <strong>Note:</strong> Public repositories can be accessed by anyone online, while private
+  repositories grant access only to you and anyone you explicitly authorize.
+</Banner>
+
+Once you are ready, click **Create Project**. This will clone the selected template to a new repository in your GitHub account, and take you to the configuration page to set up your project for deployment.
+
+## Importing from an Existing Codebase
+
+Payload Cloud works for any Node.js + MongoDB app. From the New Project page, select **import an existing Git codebase**. Choose the organization and select the repository you want to import. From here, you will be taken to the configuration page to set up your project for deployment.
+
+![Screen for creating a new project from an existing repository](https://payloadcms.com/images/docs/cloud/create-from-existing.jpg)
+_Creating a new project from an existing repository._
+
+<Banner type="warning">
+  <strong>Note:</strong> In order to make use of the features of Payload Cloud in your own codebase,
+  you will need to add the [Cloud Plugin](https://github.com/payloadcms/plugin-cloud) to your
+  Payload app.
+</Banner>

docs/cloud/projects.mdx

@@ -0,0 +1,127 @@
+---
+title: Cloud Projects
+label: Projects
+order: 40
+desc: Manage your Payload Cloud projects.
+keywords: cloud, payload cloud, projects, project, overview, database, file storage, build settings, environment variables, custom domains, email, developing locally
+---
+
+## Overview
+
+<Banner>
+  The overview tab shows your most recent deployment, along with build and deployment logs. From
+  here, you can see your live URL, deployment details like timestamps and commit hash, as well as
+  the status of your deployment. You can also trigger a redeployment manually, which will rebuild
+  your project using the current configuration.
+</Banner>
+
+![Payload Cloud Overview Page](https://payloadcms.com/images/docs/cloud/overview-page.jpg)
+_A screenshot of the Overview page for a Cloud project._
+
+## Database
+
+Your Payload Cloud project comes with a MongoDB serverless Atlas DB instance or a Dedicated Atlas cluster, depending on your plan. To interact with your cloud database, you will be provided with a MongoDB connection string. This can be found under the **Database** tab of your project.
+
+`mongodb+srv://your_connection_string`
+
+## File Storage
+
+Payload Cloud gives you S3 file storage backed by Cloudflare as a CDN, and this plugin extends Payload so that all of your media will be stored in S3 rather than locally.
+
+AWS Cognito is used for authentication to your S3 bucket. The [Payload Cloud Plugin](https://github.com/payloadcms/plugin-cloud) will automatically pick up these values. These values are only if you'd like to access your files directly, outside of Payload Cloud.
+
+### Accessing Files Outside of Payload Cloud
+
+If you'd like to access your files outside of Payload Cloud, you'll need to retrieve some values from your project's settings and put them into your environment variables. In Payload Cloud, navigate to the File Storage tab and copy the values using the copy button. Put these values in your .env file. Also copy the Cognito Password value separately and put into your .env file as well.
+
+When you are done, you should have the following values in your .env file:
+
+```env
+PAYLOAD_CLOUD=true
+PAYLOAD_CLOUD_ENVIRONMENT=prod
+PAYLOAD_CLOUD_COGNITO_USER_POOL_CLIENT_ID=
+PAYLOAD_CLOUD_COGNITO_USER_POOL_ID=
+PAYLOAD_CLOUD_COGNITO_IDENTITY_POOL_ID=
+PAYLOAD_CLOUD_PROJECT_ID=
+PAYLOAD_CLOUD_BUCKET=
+PAYLOAD_CLOUD_BUCKET_REGION=
+PAYLOAD_CLOUD_COGNITO_PASSWORD=
+```
+
+The plugin will pick up these values and use them to access your files.
+
+## Build Settings
+
+You can update settings from your Project’s Settings tab. Changes to your build settings will trigger a redeployment of your project.
+
+## Environment Variables
+
+From the Environment Variables page of the Settings tab, you can add, update and delete variables for use in your project. Like build settings, these changes will trigger a redeployment of your project.
+
+<Banner>
+  Note: For security reasons, any variables you wish to provide to the [Admin Panel](../admin/overview) must be prefixed with `NEXT_PUBLIC_`. [More details](../configuration/environment-vars).
+</Banner>
+
+## Custom Domains
+
+With Payload Cloud, you can add custom domain names to your project. To do so, first go to the Domains page of the Settings tab of your project. Here you can see your default domain. To add a new domain, type in the domain name you wish to use.
+
+<Banner>
+  Note: do not include the protocol (http:// or https://) or any paths (/page). Only include the
+  domain name and extension, and optionally a subdomain. - your-domain.com - backend.your-domain.com
+</Banner>
+
+Once you click save, a DNS record will be generated for your domain name to point to your live project. Add this record into your DNS provider’s records, and once the records are resolving properly (this can take 1hr to 48hrs in some cases), your domain will now to point to your live project.
+
+You will also need to configure your Payload project to use your specified domain. In your `payload.config.ts` file, specify your `serverURL` with your domain:
+
+```ts
+export default buildConfig({
+  serverURL: 'https://example.com',
+  // the rest of your config,
+})
+```
+
+## Email
+
+Powered by [Resend](https://resend.com), Payload Cloud comes with integrated email support out of the box. No configuration is needed, and you can use `payload.sendEmail()` to send email right from your Payload app. To learn more about sending email with Payload, checkout the [Email Configuration](https://payloadcms.com/docs/email/overview) overview.
+
+If you are on the Pro or Enterprise plan, you can add your own custom Email domain name. From the Email page of your project’s Settings, add the domain you wish to use for email delivery. This will generate a set of DNS records. Add these records to your DNS provider and click verify to check that your records are resolving properly. Once verified, your emails will now be sent from your custom domain name.
+
+## Developing Locally
+
+To make changes to your project, you will need to clone the repository defined in your project settings to your local machine. In order to run your project locally, you will need configure your local environment first. Refer to your repository’s `README.md` file to see the steps needed for your specific template.
+
+From there, you are ready to make updates to your project. When you are ready to make your changes live, commit your changes to the branch you specified in your Project settings, and your application will automatically trigger a redeploy and build from your latest commit.
+
+## Cloud Plugin
+
+Projects generated from a template will come pre-configured with the official Cloud Plugin, but if you are using your own repository you will need to add this into your project. To do so, add the plugin to your Payload Config:
+
+`yarn add @payloadcms/plugin-cloud`
+
+```js
+import { payloadCloud } from '@payloadcms/plugin-cloud'
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  plugins: [payloadCloud()],
+  // rest of config
+})
+```
+
+<Banner type="warning">
+  **Note:** If your Payload Config already has an email with transport, this will take precedence
+  over Payload Cloud's email service.
+</Banner>
+
+#### **Optional configuration**
+
+If you wish to opt-out of any Payload cloud features, the plugin also accepts options to do so.
+
+```js
+payloadCloud({
+  storage: false, // Disable file storage
+  email: false, // Disable email delivery
+})
+```

docs/cloud/teams.mdx

@@ -0,0 +1,35 @@
+---
+title: Cloud Teams
+label: Teams
+order: 30
+desc: Manage your Payload Cloud team and billing settings.
+keywords: team, teams, billing, subscription, payment, plan, plans, cloud, payload cloud
+---
+
+<Banner>
+  Within Payload Cloud, the team management feature offers you the ability to manage your
+  organization, team members, billing, and subscription settings.
+</Banner>
+
+![Payload Cloud Team Settings](https://payloadcms.com/images/docs/cloud/team-settings.jpg)
+_A screenshot of the Team Settings page._
+
+## Members
+
+Each team has members that can interact with your projects. You can invite multiple people to your team and each individual can belong to more than one team. You can assign them either `owner` or `user` permissions. Owners are able to make admin-only changes, such as deleting projects, and editing billing information.
+
+## Adding Members
+
+To add a new member to your team, visit your Team’s Settings page, and click “Invite Teammate”. You can then add their email address, and assign their role. Press “Save” to send the invitations, which will send an email to the invited team member where they can create a new account.
+
+## Billing
+
+Users can update billing settings and subscriptions for any teams where they are designated as an `owner`. To make updates to the team’s payment methods, visit the Billing page under the Team Settings tab. You can add new cards, delete cards, and set a payment method as a default. The default payment method will be used in the event that another payment method fails.
+
+## Subscriptions
+
+From the Subscriptions page, a team owner can see all current plans for their team. From here, you can see the price of each plan, if there is an active trial, and when you will be billed next.
+
+## Invoices
+
+The Invoices page will you show you the invoices for your account, as well as the status on their payment.

docs/configuration/collections.mdx

@@ -0,0 +1,106 @@
+---
+title: Collection Configs
+label: Collections
+order: 20
+desc: Structure your Collections for your needs by defining fields, adding slugs and labels, establishing access control, tying in hooks, setting timestamps and more.
+keywords: collections, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+A Collection is a group of records, called Documents, that all share a common schema. You can define as many Collections as your application needs. Each Document in a Collection is stored in the [Database](../database/overview) based on the [Fields](../fields/overview) that you define, and automatically generates a [Local API](../local-api/overview), [REST API](../rest-api/overview), and [GraphQL API](../graphql/overview) used to manage your Documents.
+
+Collections are also used to achieve [Authentication](../authentication/overview) in Payload. By defining a Collection with `auth` options, that Collection receives additional operations to support user authentication.
+
+Collections are the primary way to structure recurring data in your application, such as users, products, pages, posts, and other types of content that you might want to manage. Each Collection can have its own unique [Access Control](../access-control/overview), [Hooks](../hooks/overview), [Admin Options](#admin-options), and more.
+
+To define a Collection Config, use the `collection` property in your [Payload Config](./overview):
+
+```ts
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  // ...
+  collections: [ // highlight-line
+    // Your Collections go here
+  ],
+})
+```
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  If your Collection is only ever meant to contain a single Document, consider using a [Global](./globals) instead.
+</Banner>
+
+## Config Options
+
+It's often best practice to write your Collections in separate files and then import them into the main [Payload Config](../overview).
+
+Here is what a simple Collection Config might look like:
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const Posts: CollectionConfig = {
+  slug: 'posts',
+  fields: [
+    {
+      name: 'title',
+      type: 'text',
+    }
+  ]
+}
+```
+
+<Banner type="success">
+  <strong>Reminder:</strong>
+  For a more complex example, see the [Public Demo](https://github.com/payloadcms/public-demo) source code on GitHub, or the [Templates](https://github.com/payloadcms/payload/tree/main/templates) and [Examples](https://github.com/payloadcms/payload/tree/main/examples) directories in the Payload repository.
+</Banner>
+
+The following options are available:
+
+| Option                 | Description                                                                                                                                                                                                              |
+|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **`admin`**            | The configuration options for the Admin Panel. [More details](../admin/collections).                                                                                                                                            |
+| **`access`**           | Provide Access Control functions to define exactly who should be able to do what with Documents in this Collection. [More details](../access-control/collections).                                                   |
+| **`auth`**             | Specify options if you would like this Collection to feature authentication. [More details](../authentication/overview).                                                          |
+| **`custom`**           | Extension point for adding custom data (e.g. for plugins)                                                                          |
+| **`disableDuplicate`** | When true, do not show the "Duplicate" button while editing documents within this Collection and prevent `duplicate` from all APIs.                                                                                      |
+| **`defaultSort`**      | Pass a top-level field to sort by default in the Collection List View. Prefix the name of the field with a minus symbol ("-") to sort in descending order.                                                               |
+| **`dbName`**      | Custom table or Collection name depending on the Database Adapter. Auto-generated from slug if not defined. |
+| **`endpoints`**        | Add custom routes to the REST API. Set to `false` to disable routes. [More details](../rest-api/overview#custom-endpoints).                                                                                                    |
+| **`fields`** \*        | Array of field types that will determine the structure and functionality of the data stored within this Collection. [More details](../fields/overview). |
+| **`graphQL`**          | An object with `singularName` and `pluralName` strings used in schema generation. Auto-generated from slug if not defined. Set to `false` to disable GraphQL.                                                            |
+| **`hooks`**            | Entry point for Hooks. [More details](../hooks/overview#collection-hooks).                                                                                                         |
+| **`labels`**           | Singular and plural labels for use in identifying this Collection throughout Payload. Auto-generated from slug if not defined.                                                                                           |
+| **`slug`** \*          | Unique, URL-friendly string that will act as an identifier for this Collection.                                                                                                                                          |
+| **`timestamps`**       | Set to false to disable documents' automatically generated `createdAt` and `updatedAt` timestamps.                                                                                                                       |
+| **`typescript`**       | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.                                                                                                                                                                                  |
+| **`upload`**           | Specify options if you would like this Collection to support file uploads. For more, consult the [Uploads](../upload/overview) documentation.                                                                         |
+| **`versions`**         | Set to true to enable default options, or configure with object properties. [More details](../versions/overview#collection-config).                                                                                            |
+
+_\* An asterisk denotes that a property is required._
+
+### Fields
+
+Fields define the schema of the Documents within a Collection. To learn more, go to the [Fields](../fields/overview) documentation.
+
+### Access Control
+
+[Collection Access Control](../access-control/overview) determines what a user can and cannot do with any given Document within a Collection. To learn more, go to the [Access Control](../access-control/overview) documentation.
+
+### Hooks
+
+[Collection Hooks](../hooks/collections) allow you to tie into the lifecycle of your Documents so you can execute your own logic during specific events. To learn more, go to the [Hooks](../hooks/overview) documentation.
+
+### Admin Options
+
+You can customize the way that the [Admin Panel](../admin/overview) behaves on a Collection-by-Collection basis. To learn more, go to the [Collection Admin Options](../admin/collections) documentation.
+
+## TypeScript
+
+You can import types from Payload to help make writing your Collection configs easier and type-safe. There are two main types that represent the Collection Config, `CollectionConfig` and `SanitizeCollectionConfig`.
+
+The `CollectionConfig` type represents a raw Collection Config in its full form, where only the bare minimum properties are marked as required. The `SanitizedCollectionConfig` type represents a Collection Config after it has been fully sanitized. Generally, this is only used internally by Payload.
+
+```ts
+import type { CollectionConfig, SanitizedCollectionConfig } from 'payload'
+```

docs/configuration/environment-vars.mdx

@@ -0,0 +1,101 @@
+---
+title: Environment Variables
+label: Environment Variables
+order: 100
+desc: Learn how to use Environment Variables in your Payload project
+---
+
+Environment Variables are a way to store sensitive information that your application needs to function. This could be anything from API keys to [Database](../database/overview) credentials. Payload allows you to easily use Environment Variables within your config and throughout your application.
+
+## Next.js Applications
+
+If you are using Next.js, no additional setup is required other than creating your `.env` file.
+
+To use Environment Variables, add a `.env` file to the root of your project:
+
+```plaintext
+project-name/
+├─ .env
+├─ package.json
+├─ payload.config.ts
+```
+
+Here is an example of what an `.env` file might look like:
+
+```plaintext
+SERVER_URL=localhost:3000
+DATABASE_URI=mongodb://localhost:27017/my-database
+```
+
+To use Environment Variables in your Payload Config, you can access them directly from `process.env`:
+
+```ts
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  serverURL: process.env.SERVER_URL, // highlight-line
+  // ...
+})
+```
+
+## Client-side Environments
+
+For security and safety reasons, the [Admin Panel](../admin/overview) does **not** include Environment Variables in its _client-side_ bundle by default. But, Next.js provides a mechanism to expose Environment Variables to the client-side bundle when needed.
+
+If you are building a [Custom Component](../admin/components) and need to access Environment Variables from the client-side, you can do so by prefixing them with `NEXT_PUBLIC_`.
+
+<Banner type="warning">
+  <strong>Important:</strong>
+  Be careful about what variables you provide to your client-side code. Analyze every single one to make sure that you're not accidentally leaking sensitive information. Only ever include keys that are safe for the public to read in plain text.
+</Banner>
+
+For example, if you've got the following Environment Variable:
+
+```bash
+NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=pk_test_XXXXXXXXXXXXXXXXXX
+```
+
+This key will automatically be made available to the client-side Payload bundle and can be referenced in your Custom Component as follows:
+
+```tsx
+'use client'
+import React from 'react'
+
+const stripeKey = process.env.NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY // highlight-line
+
+const MyClientComponent = () => {
+  // do something with the key
+
+  return (
+    <div>
+      My Client Component
+    </div>
+  )
+}
+```
+
+For more information, check out the [Next.js Documentation](https://nextjs.org/docs/app/building-your-application/configuring/environment-variables).
+
+## Outside of Next.js
+
+If you are using Payload outside of Next.js, we suggest using the [`dotenv`](https://www.npmjs.com/package/dotenv) package to handle Environment Variables from `.env` files. This will automatically load your Environment Variables into `process.env`.
+
+To do this, import the package as high up in your application as possible:
+
+```ts
+import dotenv from 'dotenv'
+dotenv.config() // highlight-line
+
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  serverURL: process.env.SERVER_URL,
+  // ...
+})
+```
+
+<Banner type="warning">
+  <strong>Tip:</strong>
+  Be sure that `dotenv` can find your `.env` file. By default, it will look for a file named `.env` in the root of your project. If you need to specify a different file, pass the path into the config options.
+</Banner>
+

docs/configuration/globals.mdx

@@ -0,0 +1,110 @@
+---
+title: Global Configs
+label: Globals
+order: 30
+desc: Set up your Global config for your needs by defining fields, adding slugs and labels, establishing access control, tying in hooks and more.
+keywords: globals, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+Globals are in many ways similar to [Collections](../configuration/collections), except they correspond to only a single Document. You can define as many Globals as your application needs. Each Global Document is stored in the [Database](../database/overview) based on the [Fields](../fields/overview) that you define, and automatically generates a [Local API](../local-api/overview), [REST API](../rest-api/overview), and [GraphQL API](../graphql/overview) used to manage your Documents.
+
+Globals are the primary way to structure singletons in Payload, such as a header navigation, site-wide banner alerts, or app-wide localized strings. Each Global can have its own unique [Access Control](../access-control/overview), [Hooks](../hooks/overview), [Admin Options](#admin-options), and more.
+
+To define a Global Config, use the `globals` property in your [Payload Config](./overview):
+
+```ts
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  // ...
+  globals: [ // highlight-line
+    // Your Globals go here
+  ],
+})
+```
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  If you have more than one Global that share the same structure, consider using a [Collection](../configuration/collections) instead.
+</Banner>
+
+## Config Options
+
+It's often best practice to write your Globals in separate files and then import them into the main [Payload Config](./overview).
+
+Here is what a simple Global Config might look like:
+
+```ts
+import { GlobalConfig } from 'payload'
+
+export const Nav: GlobalConfig = {
+  slug: 'nav',
+  fields: [
+    {
+      name: 'items',
+      type: 'array',
+      required: true,
+      maxRows: 8,
+      fields: [
+        {
+          name: 'page',
+          type: 'relationship',
+          relationTo: 'pages', // "pages" is the slug of an existing collection
+          required: true,
+        },
+      ],
+    },
+  ],
+}
+```
+
+<Banner type="success">
+  <strong>Reminder:</strong>
+  For a more complex example, see the [Public Demo](https://github.com/payloadcms/public-demo) source code on GitHub, or the [Templates](https://github.com/payloadcms/payload/tree/main/templates) and [Examples](https://github.com/payloadcms/payload/tree/main/examples) directories in the Payload repository.
+</Banner>
+
+The following options are available:
+
+| Option             | Description                                                                                                                                                                                                          |
+| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`access`**       | Provide Access Control functions to define exactly who should be able to do what with this Global. [More details](../access-control/globals).                                                                    |
+| **`admin`**        | The configuration options for the Admin Panel. [More details](../admin/globals).                                                                           |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                            |
+| **`dbName`**       | Custom table or collection name for this Global depending on the Database Adapter. Auto-generated from slug if not defined. |
+| **`description`**  | Text or React component to display below the Global header to give editors more information.                                                                                                                         |
+| **`endpoints`**    | Add custom routes to the REST API. [More details](../rest-api/overview#custom-endpoints).                                                                                                                                  |
+| **`fields`** \*    | Array of field types that will determine the structure and functionality of the data stored within this Global. [More details](../fields/overview). |
+| **`graphQL.name`** | Text used in schema generation. Auto-generated from slug if not defined.                                                                                                                          |
+| **`hooks`**        | Entry point for Hooks. [More details](../hooks/overview#global-hooks).  |
+| **`label`**        | Text for the name in the Admin Panel or an object with keys for each language. Auto-generated from slug if not defined.                                                                                                                                                                                      |
+| **`slug`** \*      | Unique, URL-friendly string that will act as an identifier for this Global.                                                                                                                                          |
+| **`typescript`**   | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.    |
+| **`versions`**     | Set to true to enable default options, or configure with object properties. [More details](../versions/overview#globals-config).                                                                                           |
+
+_\* An asterisk denotes that a property is required._
+
+### Fields
+
+Fields define the schema of the Global. To learn more, go to the [Fields](../fields/overview) documentation.
+
+### Access Control
+
+[Global Access Control](../access-control/globals) determines what a user can and cannot do with any given Global Document. To learn more, go to the [Access Control](../access-control/overview) documentation.
+
+### Hooks
+
+[Global Hooks](../hooks/globals) allow you to tie into the lifecycle of your Documents so you can execute your own logic during specific events. To learn more, go to the [Hooks](../hooks/overview) documentation.
+
+### Admin Options
+
+You can customize the way that the [Admin Panel](../admin/overview) behaves on a Global-by-Global basis. To learn more, go to the [Global Admin Options](../admin/globals) documentation.
+
+## TypeScript
+
+You can import types from Payload to help make writing your Global configs easier and type-safe. There are two main types that represent the Global Config, `GlobalConfig` and `SanitizeGlobalConfig`.
+
+The `GlobalConfig` type represents a raw Global Config in its full form, where only the bare minimum properties are marked as required. The `SanitizedGlobalConfig` type represents a Global Config after it has been fully sanitized. Generally, this is only used internally by Payload.
+
+```ts
+import type { GlobalConfig, SanitizedGlobalConfig } from 'payload'
+```

docs/configuration/i18n.mdx

@@ -0,0 +1,238 @@
+---
+title: I18n
+label: I18n
+order: 40
+desc: Manage and customize internationalization support in your CMS editor experience
+keywords: internationalization, i18n, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+The [Admin Panel](../admin/overview) is translated in over [30 languages and counting](https://github.com/payloadcms/payload/tree/beta/packages/translations). With I18n, editors can navigate the interface and read API error messages in their preferred language. This is similar to [Localization](./localization), but instead of managing translations for the data itself, you are managing translations for your application's interface.
+
+By default, Payload comes with preinstalled with English, but you can easily load other languages into your own application. Languages are automatically detected based on the request. If no language was detected, or if the user's language is not yet supported by your application, English will be chosen.
+
+To configure I18n, use the `i18n` key in your [Payload Config](./overview):
+
+```ts
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  // ...
+  i18n: { // highlight-line
+    // ...
+  },
+})
+```
+
+<Banner type="success">
+  <strong>Note:</strong>
+  If there is a language that Payload does not yet support, we accept [code contributions](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md).
+</Banner>
+
+## Config Options
+
+You can easily customize and override any of the i18n settings that Payload provides by default. Payload will use your custom options and merge them in with its own.
+
+```ts
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  // ...
+  // highlight-start
+  i18n: {
+    fallbackLanguage: 'en', // default
+    debug: false, // default
+  }
+  // highlight-end
+})
+```
+
+The following options are available:
+
+| Option                | Description                                                                                                                                                                                                                   |
+| --------------------- | --------------------------------|
+| **`fallbackLanguage`**     | The language to fall back to if the user's preferred language is not supported. Default is `'en'`.                                                                                                                           |
+| **`debug`**           | Whether to log debug information to the console. Default is `false`.                                                                                                                                                         |
+| **`translations`**    | An object containing the translations. The keys are the language codes and the values are the translations.                                                                                                                |
+| **`supportedLanguages`** | An object containing the supported languages. The keys are the language codes and the values are the translations.                                                                                                         |
+
+## Adding Languages
+
+You can easily add new languages to your Payload app by providing the translations for the new language. Payload maintains a number of built-in translations that can be imported from `@payloadcms/translations`, but you can also provide your own [Custom Translations](#custom-translations) to support any language.
+
+To add a new language, use the `i18n.supportedLanguages` key in your [Payload Config](./overview):
+
+```ts
+import { buildConfig } from 'payload'
+import { en } from '@payloadcms/translations/languages/en'
+import { de } from '@payloadcms/translations/languages/de'
+
+export default buildConfig({
+  // ...
+  // highlight-start
+  i18n: {
+    supportedLanguages: { en, de },
+  },
+  // highlight-end
+})
+```
+
+<Banner type="warning">
+ <strong>Tip:</strong>
+ It's best to only support the languages that you need so that the bundled JavaScript is kept to a minimum for your project.
+</Banner>
+
+### Custom Translations
+
+You can customize Payload's built-in translations either by extending existing languages or by adding new languages entirely. This can be done by injecting new translation strings into existing languages, or by providing an entirely new language keys altogether.
+
+To add Custom Translations, use the `i18n.translations` key in your [Payload Config](./overview):
+
+```ts
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  //...
+  i18n: {
+    // highlight-start
+    translations: {
+      en: {
+        custom: {
+          // namespace can be anything you want
+          key1: 'Translation with {{variable}}', // translation
+        },
+        // override existing translation keys
+        general: {
+          dashboard: 'Home',
+        },
+      },
+    },
+    // highlight-end
+  },
+  //...
+})
+```
+
+### Project Translations
+
+While Payload's built-in features come fully translated, you may also want to translate parts of your own project. This is possible in places like [Collections](./collections) and [Globals](./globals), such as on their labels and groups, field labels, descriptions or input placeholder text.
+
+To do this, provide the translations wherever applicable, keyed to the language code:
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const Articles: CollectionConfig = {
+  slug: 'articles',
+  labels: {
+    singular: {
+      // highlight-start
+      en: 'Article',
+      es: 'Artículo',
+      // highlight-end
+    },
+    plural: {
+      // highlight-start
+      en: 'Articles',
+      es: 'Artículos',
+      // highlight-end
+    },
+  },
+  admin: {
+    group: {
+      // highlight-start
+      en: 'Content',
+      es: 'Contenido',
+      // highlight-end
+    },
+  },
+  fields: [
+    {
+      name: 'title',
+      type: 'text',
+      label: {
+        // highlight-start
+        en: 'Title',
+        es: 'Título',
+        // highlight-end
+      },
+      admin: {
+        placeholder: {
+          // highlight-start
+          en: 'Enter title',
+          es: 'Introduce el título'
+          // highlight-end
+        },
+      },
+    },
+  ],
+}
+```
+
+## Node
+
+Payload's backend sets the language on incoming requests before they are handled. This allows backend validation to return error messages in the user's own language or system generated emails to be sent using the correct translation. You can make HTTP requests with the `accept-language` header and Payload will use that language.
+
+Anywhere in your Payload app that you have access to the `req` object, you can access Payload's extensive internationalization features assigned to `req.i18n`. To access text translations you can use `req.t('namespace:key')`.
+
+## TypeScript
+
+In order to use custom translations in your project, you need to provide the types for the translations.
+
+Here is an example of how you can define the types for the custom translations in a [Custom Component](../admin/components):
+
+```ts
+'use client'
+import type { NestedKeysStripped } from '@payloadcms/translations'
+import type React from 'react'
+
+import { useTranslation } from '@payloadcms/ui/providers/Translation'
+
+const customTranslations = {
+  en: {
+    general: {
+      test: 'Custom Translation',
+    },
+  },
+}
+
+type CustomTranslationObject = typeof customTranslations.en
+type CustomTranslationKeys = NestedKeysStripped<CustomTranslationObject>
+
+export const MyComponent: React.FC = () => {
+  const { i18n, t } = useTranslation<CustomTranslationObject, CustomTranslationKeys>() // These generics merge your custom translations with the default client translations
+
+  return t('general:test')
+}
+
+```
+
+Additionally, Payload exposes the `t` function in various places, for example in labels. Here is how you would type those:
+
+```ts
+import type {
+  DefaultTranslationKeys,
+  NestedKeysStripped,
+  TFunction,
+} from '@payloadcms/translations'
+import type { Field } from 'payload'
+
+const customTranslations = {
+  en: {
+    general: {
+      test: 'Custom Translation',
+    },
+  },
+}
+
+type CustomTranslationObject = typeof customTranslations.en
+type CustomTranslationKeys = NestedKeysStripped<CustomTranslationObject>
+
+const field: Field = {
+  name: 'myField',
+  type: 'text',
+  label: (
+    { t }: { t: TFunction<CustomTranslationKeys | DefaultTranslationKeys> }, // The generic passed to TFunction does not automatically merge the custom translations with the default translations. We need to merge them ourselves here
+  ) => t('fields:addLabel'),
+}
+```
+

docs/configuration/localization.mdx

@@ -0,0 +1,211 @@
+---
+title: Localization
+label: Localization
+order: 50
+desc: Add and maintain as many locales as you need by adding Localization to your Payload Config, set options for default locale, fallbacks, fields and more.
+keywords: localization, internationalization, i18n, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+Localization is one of the most important features of a modern CMS. It allows you to manage content in multiple languages, then serve it to your users based on their requested language. This is similar to [I18n](./i18n), but instead of managing translations for your application's interface, you are managing translations for the data itself.
+
+With Localization, you can begin to serve personalized content to your users based on their specific language preferences, such as a multilingual website or multi-site application. There are no limits to the number of locales you can add to your Payload project.
+
+To configure Localization, use the `localization` key in your [Payload Config](./overview):
+
+```ts
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  // ...
+  localization: { // highlight-line
+    // ...
+  },
+})
+```
+
+## Config Options
+
+Add the `localization` property to your Payload Config to enable Localization project-wide. You'll need to provide a list of all locales that you'd like to support as well as set a few other options.
+
+To configure locales, use the `localization.locales` property in your [Payload Config](./overview):
+
+```ts
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  // ...
+  localization: {
+    locales: ['en', 'es', 'de'] // highlight-line
+  },
+})
+```
+
+You can also define locales using [full configuration objects](#locale-object):
+
+```ts
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  collections: [
+    // collections go here
+  ],
+  localization: {
+    locales: [
+      {
+        label: 'English',
+        code: 'en',
+      },
+      {
+        label: 'Arabic',
+        code: 'ar',
+        // opt-in to setting default text-alignment on Input fields to rtl (right-to-left)
+        // when current locale is rtl
+        rtl: true,
+      },
+    ],
+    defaultLocale: 'en',
+    fallback: true,
+  },
+})
+```
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  Localization works very well alongside [I18n](/docs/configuration/i18n).
+</Banner>
+
+The following options are available:
+
+| Option         | Description                                                                                                                    |
+| -------------- | ------------------------------------------------------------------------------------------------------------------------------ |
+| **`locales`**  | Array of all the languages that you would like to support. [More details](#locales)                                            |
+| **`defaultLocale`** | Required string that matches one of the locale codes from the array provided. By default, if no locale is specified, documents will be returned in this locale. |
+| **`fallback`** | Boolean enabling "fallback" locale functionality. If a document is requested in a locale, but a field does not have a localized value corresponding to the requested locale, then if this property is enabled, the document will automatically fall back to the fallback locale value. If this property is not enabled, the value will not be populated. |
+
+### Locales
+
+The locales array is a list of all the languages that you would like to support. This can be strings for each language code, or [full configuration objects](#locale-object) for more advanced options.
+
+The locale codes do not need to be in any specific format. It's up to you to define how to represent your locales. Common patterns are to use two-letter ISO 639 language codes or four-letter language and country codes (ISO 3166‑1) such as `en-US`, `en-UK`, `es-MX`, etc.
+
+#### Locale Object
+
+| Option               | Description                                                                                                                    |
+| -------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
+| **`code`** \*        | Unique code to identify the language throughout the APIs for `locale` and `fallbackLocale`                                     |
+| **`label`**          | A string to use for the selector when choosing a language, or an object keyed on the i18n keys for different languages in use. |
+| **`rtl`**            | A boolean that when true will make the admin UI display in Right-To-Left.                                                      |
+| **`fallbackLocale`** | The code for this language to fallback to when properties of a document are not present.                                       |
+
+_\* An asterisk denotes that a property is required._
+
+## Field Localization
+
+Payload Localization works on a **field** level—not a document level. In addition to configuring the base Payload Config to support Localization, you need to specify each field that you would like to localize.
+
+**Here is an example of how to enable Localization for a field:**
+
+```js
+{
+  name: 'title',
+  type: 'text',
+  // highlight-start
+  localized: true,
+  // highlight-end
+}
+```
+
+With the above configuration, the `title` field will now be saved in the database as an object of all locales instead of a single string.
+
+All field types with a `name` property support the `localized` property—even the more complex field types like `array`s and `block`s.
+
+<Banner type="info">
+  <strong>Note:</strong>
+  Enabling Localization for field types that support nested fields will automatically create
+  localized "sets" of all fields contained within the field. For example, if you have a page layout
+  using a blocks field type, you have the choice of either localizing the full layout, by enabling
+  Localization on the top-level blocks field, or only certain fields within the layout.
+</Banner>
+
+<Banner type="warning">
+  <strong>Important:</strong>
+  When converting an existing field to or from `localized: true` the data structure in the document
+  will change for this field and so existing data for this field will be lost. Before changing the
+  Localization setting on fields with existing data, you may need to consider a field migration
+  strategy.
+</Banner>
+
+## Retrieving Localized Docs
+
+When retrieving documents, you can specify which locale you'd like to receive as well as which fallback locale should be
+used.
+
+#### REST API
+
+REST API locale functionality relies on URL query parameters.
+
+**`?locale=`**
+
+Specify your desired locale by providing the `locale` query parameter directly in the endpoint URL.
+
+**`?fallback-locale=`**
+
+Specify fallback locale to be used by providing the `fallback-locale` query parameter. This can be provided as either a
+valid locale as provided to your base Payload Config, or `'null'`, `'false'`, or `'none'` to disable falling back.
+
+**Example:**
+
+```
+fetch('https://localhost:3000/api/pages?locale=es&fallback-locale=none');
+```
+
+#### GraphQL API
+
+In the GraphQL API, you can specify `locale` and `fallbackLocale` args to all relevant queries and mutations.
+
+The `locale` arg will only accept valid locales, but locales will be formatted automatically as valid GraphQL enum
+values (dashes or special characters will be converted to underscores, spaces will be removed, etc.). If you are curious
+to see how locales are auto-formatted, you can use the [GraphQL playground](/docs/graphql/overview#graphql-playground).
+
+The `fallbackLocale` arg will accept valid locales as well as `none` to disable falling back.
+
+**Example:**
+
+```graphql
+query {
+  Posts(locale: de, fallbackLocale: none) {
+    docs {
+      title
+    }
+  }
+}
+```
+
+<Banner>
+  In GraphQL, specifying the locale at the top level of a query will automatically apply it
+  throughout all nested relationship fields. You can override this behavior by re-specifying locale
+  arguments in nested related document queries.
+</Banner>
+
+#### Local API
+
+You can specify `locale` as well as `fallbackLocale` within the Local API as well as properties on the `options`
+argument. The `locale` property will accept any valid locale, and the `fallbackLocale` property will accept any valid
+locale as well as `'null'`, `'false'`, `false`, and `'none'`.
+
+**Example:**
+
+```js
+const posts = await payload.find({
+  collection: 'posts',
+  locale: 'es',
+  fallbackLocale: false,
+})
+```
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  The REST and Local APIs can return all Localization data in one request by passing 'all' or '*' as
+  the <strong>locale</strong> parameter. The response will be structured so that field values come
+  back as the full objects keyed for each locale instead of the single, translated value.
+</Banner>

docs/configuration/overview.mdx

@@ -0,0 +1,267 @@
+---
+title: The Payload Config
+label: Overview
+order: 10
+desc: The Payload Config is central to everything that Payload does, from adding custom React components, to modifying collections, controlling localization and much more.
+keywords: overview, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+Payload is a _config-based_, code-first CMS and application framework. The Payload Config is central to everything that Payload does, allowing for deep configuration of your application through a simple and intuitive API. The Payload Config is a fully-typed JavaScript object that can be infinitely extended upon.
+
+Everything from your [Database](../database/overview) choice, to the appearance of the [Admin Panel](../admin/overview), is fully controlled through the Payload Config. From here you can define [Fields](../fields/overview), add [Localization](./localization), enable [Authentication](../authentication/overview), configure [Access Control](../access-control/overview), and so much more.
+
+The Payload Config is a `payload.config.ts` file typically located in the root of your project:
+
+```ts
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  // Your config goes here
+})
+```
+
+The Payload Config is strongly typed and ties directly into Payload's TypeScript codebase. This means your IDE (such as VSCode) will provide helpful information like type-ahead suggestions while you write your config.
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  The location of your Payload Config can be customized. [More details](#customizing--automating-config-location-detection).
+</Banner>
+
+## Config Options
+
+To author your Payload Config, first determine which [Database](../database/overview) you'd like to use, then use [Collections](./collections) or [Globals](./globals) to define the schema of your data.
+
+Here is one of the simplest possible Payload configs:
+
+```ts
+import { buildConfig } from 'payload'
+import { mongooseAdapter } from '@payloadcms/db-mongodb'
+
+export default buildConfig({
+  secret: process.env.PAYLOAD_SECRET,
+  db: mongooseAdapter({
+    url: process.env.DATABASE_URI,
+  }),
+  collections: [
+    {
+      slug: 'pages',
+      fields: [
+        {
+          name: 'title',
+          type: 'text'
+        }
+      ]
+    }
+  ],
+})
+```
+
+<Banner type="success">
+  <strong>Note:</strong>
+  For a more complex example, see the [Public Demo](https://github.com/payloadcms/public-demo) source code on GitHub, or the [Templates](https://github.com/payloadcms/payload/tree/main/templates) and [Examples](https://github.com/payloadcms/payload/tree/main/examples) directories in the Payload repository.
+</Banner>
+
+The following options are available:
+
+| Option                     | Description                                                                                                                                                                                    |
+|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **`admin`**                | The configuration options for the Admin Panel, including Custom Components, Live Preview, etc. [More details](../admin/overview#admin-options).                                                |
+| **`bin`**                  | Register custom bin scripts for Payload to execute.                                                                                                                                            |
+| **`editor`**               | The Rich Text Editor which will be used by `richText` fields. [More details](../rich-text/overview).                                                                                           |
+| **`db`** \*                | The Database Adapter which will be used by Payload. [More details](../database/overview).                                                                                                      |
+| **`serverURL`**            | A string used to define the absolute URL of your app. This includes the protocol, for example `https://example.com`. No paths allowed, only protocol, domain and (optionally) port.            |
+| **`collections`**          | An array of Collections for Payload to manage. [More details](./collections).                                                                                                                  |
+| **`compatibility`**        | Compatibility flags for earlier versions of Payload. [More details](#compatibility-flags).                                                                                                     |
+| **`globals`**              | An array of Globals for Payload to manage. [More details](./globals).                                                                                                                          |
+| **`cors`**                 | Cross-origin resource sharing (CORS) is a mechanism that accept incoming requests from given domains. You can also customize the `Access-Control-Allow-Headers` header. [More details](#cors). |
+| **`localization`**         | Opt-in to translate your content into multiple locales. [More details](./localization).                                                                                                        |
+| **`logger`**               | Logger options, logger options with a destination stream, or an instantiated logger instance. [More details](https://getpino.io/#/docs/api?id=options).                                        |
+| **`graphQL`**              | Manage GraphQL-specific functionality, including custom queries and mutations, query complexity limits, etc. [More details](../graphql/overview#graphql-options).                              |
+| **`cookiePrefix`**         | A string that will be prefixed to all cookies that Payload sets.                                                                                                                               |
+| **`csrf`**                 | A whitelist array of URLs to allow Payload to accept cookies from. [More details](../authentication/overview#csrf-protection).                                                                 |
+| **`defaultDepth`**         | If a user does not specify `depth` while requesting a resource, this depth will be used. [More details](../queries/depth).                                                                     |
+| **`defaultMaxTextLength`** | The maximum allowed string length to be permitted application-wide. Helps to prevent malicious public document creation.                                                                       |
+| **`maxDepth`**             | The maximum allowed depth to be permitted application-wide. This setting helps prevent against malicious queries. Defaults to `10`. [More details](../queries/depth).                          |
+| **`indexSortableFields`**  | Automatically index all sortable top-level fields in the database to improve sort performance and add database compatibility for Azure Cosmos and similar.                                     |
+| **`upload`**               | Base Payload upload configuration. [More details](../upload/overview#payload-wide-upload-options).                                                                                             |
+| **`routes`**               | Control the routing structure that Payload binds itself to. [More details](../admin/overview#root-level-routes).                                                                               |
+| **`email`**                | Configure the Email Adapter for Payload to use. [More details](../email/overview).                                                                                                             |
+| **`debug`**                | Enable to expose more detailed error information.                                                                                                                                              |
+| **`telemetry`**            | Disable Payload telemetry by passing `false`. [More details](#telemetry).                                                                                                                      |
+| **`rateLimit`**            | Control IP-based rate limiting for all Payload resources. Used to prevent DDoS attacks, etc. [More details](../production/preventing-abuse#rate-limiting-requests).                            |
+| **`hooks`**                | An array of Root Hooks. [More details](../hooks/overview).                                                                                                                                     |
+| **`plugins`**              | An array of Plugins. [More details](../plugins/overview).                                                                                                                                      |
+| **`endpoints`**            | An array of Custom Endpoints added to the Payload router. [More details](../rest-api/overview#custom-endpoints).                                                                               |
+| **`custom`**               | Extension point for adding custom data (e.g. for plugins).                                                                                                                                     |
+| **`i18n`**                 | Internationalization configuration. Pass all i18n languages you'd like the admin UI to support. Defaults to English-only. [More details](./i18n).                                              |
+| **`secret`** \*            | A secure, unguessable string that Payload will use for any encryption workflows - for example, password salt / hashing.                                                                        |
+| **`sharp`**                | If you would like Payload to offer cropping, focal point selection, and automatic media resizing, install and pass the Sharp module to the config here.                                        |
+| **`typescript`**           | Configure TypeScript settings here. [More details](#typescript).                                                                                                                               |
+
+_\* An asterisk denotes that a property is required._
+
+<Banner type="warning">
+  <strong>Note:</strong>
+  Some properties are removed from the client-side bundle. [More details](../admin/components#accessing-the-payload-config).
+</Banner>
+
+
+### Typescript Config
+
+Payload exposes a variety of TypeScript settings that you can leverage. These settings are used to auto-generate TypeScript interfaces for your [Collections](../configuration/collections) and [Globals](../configuration/globals), and to ensure that Payload uses your [Generated Types](../typescript/overview) for all [Local API](../local-api/overview) methods.
+
+To customize the TypeScript settings, use the `typescript` property in your Payload Config:
+
+```ts
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  // ...
+  typescript: { // highlight-line
+    // ...
+  }
+})
+```
+
+The following options are available:
+
+| Option          | Description                                                                                                                                                                                                 |
+| --------------- | --------------------- |
+| **`autoGenerate`** | By default, Payload will auto-generate TypeScript interfaces for all collections and globals that your config defines. Opt out by setting `typescript.autoGenerate: false`. [More details](../typescript/overview). |
+| **`declare`**     | By default, Payload adds a `declare` block to your generated types, which makes sure that Payload uses your generated types for all Local API methods. Opt out by setting `typescript.declare: false`. |
+| **`outputFile`**  | Control the output path and filename of Payload's auto-generated types by defining the `typescript.outputFile` property to a full, absolute path. |
+
+## Config Location
+
+For Payload command-line scripts, we need to be able to locate your Payload Config. We'll check a variety of locations for the presence of `payload.config.ts` by default, including:
+
+1. The root current working directory
+1. The `compilerOptions` in your `tsconfig`*
+1. The `dist` directory*
+
+_\* Config location detection is different between development and production environments. See below for more details._
+
+<Banner type="warning">
+  <strong>Important:</strong>
+  Ensure your `tsconfig.json` is properly configured for Payload to auto-detect your config location. If if does not exist, or does not specify the proper `compilerOptions`, Payload will default to the current working directory.
+</Banner>
+
+**Development Mode**
+
+In development mode, if the configuration file is not found at the root, Payload will attempt to read your `tsconfig.json`, and attempt to find the config file specified in the `rootDir`:
+
+```json
+{
+  // ...
+  // highlight-start
+  "compilerOptions": {
+    "rootDir": "src"
+  }
+  // highlight-end
+}
+```
+
+**Production Mode**
+
+In production mode, Payload will first attempt to find the config file in the `outDir` of your `tsconfig.json`, and if not found, will fallback to the `rootDor` directory:
+
+```json
+{
+  // ...
+  // highlight-start
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  }
+  // highlight-end
+}
+```
+
+If none was in either location, Payload will finally check the `dist` directory.
+
+### Customizing the Config Location
+
+In addition to the above automated detection, you can specify your own location for the Payload Config. This can be useful in situations where your config is not in a standard location, or you wish to switch between multiple configurations. To do this, Payload exposes an [Environment Variable](..environment-variables) to bypass all automatic config detection.
+
+To use a custom config location, set the `PAYLOAD_CONFIG_PATH` environment variable:
+
+```json
+{
+  "scripts": {
+    "payload": "PAYLOAD_CONFIG_PATH=/path/to/custom-config.ts payload"
+  }
+}
+```
+
+<Banner type="info">
+  <strong>Tip:</strong>
+  `PAYLOAD_CONFIG_PATH` can be either an absolute path, or path relative to your current working directory.
+</Banner>
+
+## Telemetry
+
+Payload collects **completely anonymous** telemetry data about general usage. This data is super important to us and helps us accurately understand how we're growing and what we can do to build the software into everything that it can possibly be. The telemetry that we collect also help us demonstrate our growth in an accurate manner, which helps us as we seek investment to build and scale our team. If we can accurately demonstrate our growth, we can more effectively continue to support Payload as free and open-source software. To opt out of telemetry, you can pass `telemetry: false` within your Payload Config.
+
+For more information about what we track, take a look at our [privacy policy](/privacy).
+
+## Cross-origin resource sharing (CORS)
+
+Cross-origin resource sharing (CORS) can be configured with either a whitelist array of URLS to allow CORS requests from, a wildcard string (`*`) to accept incoming requests from any domain, or a object with the following properties:
+
+| Option    | Description                                                                                                                                                                        |
+| --------- | --------------------------------------------------------------------------------------------------------------------------------------- |
+| **`origins`** | Either a whitelist array of URLS to allow CORS requests from, or a wildcard string (`'*'`) to accept incoming requests from any domain. |
+| **`headers`**  | A list of allowed headers that will be appended in `Access-Control-Allow-Headers`. |
+
+Here's an example showing how to allow incoming requests from any domain:
+
+```ts
+import { buildConfig } from 'payload/config'
+
+export default buildConfig({
+  // ...
+  cors: '*' // highlight-line
+})
+```
+
+Here's an example showing how to append a new header (`x-custom-header`) in `Access-Control-Allow-Headers`:
+
+```ts
+import { buildConfig } from 'payload/config'
+
+export default buildConfig({
+  // ...
+  // highlight-start
+  cors: {
+    origins: ['http://localhost:3000']
+    headers: ['x-custom-header']
+  }
+  // highlight-end
+})
+```
+
+## TypeScript
+
+You can import types from Payload to help make writing your config easier and type-safe. There are two main types that represent the Payload Config, `Config` and `SanitizedConfig`.
+
+The `Config` type represents a raw Payload Config in its full form. Only the bare minimum properties are marked as required. The `SanitizedConfig` type represents a Payload Config after it has been fully sanitized. Generally, this is only used internally by Payload.
+
+```ts
+import type { Config, SanitizedConfig } from 'payload'
+```
+
+## Server vs. Client
+
+The Payload Config only lives on the server and is not allowed to contain any client-side code. That way, you can load up the Payload Config in any server environment or standalone script, without having to use Bundlers or Node.js loaders to handle importing client-only modules (e.g. scss files or React Components) without any errors.
+
+Behind the curtains, the Next.js-based Admin Panel generates a ClientConfig, which strips away any server-only code and enriches the config with React Components.
+
+## Compatibility flags
+
+The Payload Config can accept compatibility flags for running the newest versions but with older databases. You should only use these flags if you need to, and should confirm that you need to prior to enabling these flags.
+
+`allowLocalizedWithinLocalized`
+
+Payload localization works on a field-by-field basis. As you can nest fields within other fields, you could potentially nest a localized field within a localized field—but this would be redundant and unnecessary. There would be no reason to define a localized field within a localized parent field, given that the entire data structure from the parent field onward would be localized.
+
+By default, Payload will remove the `localized: true` property from sub-fields if a parent field is localized. Set this compatibility flag to `true` only if you have an existing Payload MongoDB database from pre-3.0, and you have nested localized fields that you would like to maintain without migrating.

docs/database/migrations.mdx

@@ -0,0 +1,242 @@
+---
+title: Migrations
+label: Migrations
+order: 20
+keywords: database, migrations, ddl, sql, mongodb, postgres, documentation, Content Management System, cms, headless, typescript, node, react, nextjs
+desc: Payload features first-party database migrations all done in TypeScript.
+---
+
+Payload exposes a full suite of migration controls available for your use. Migration commands are accessible via
+the `npm run payload` command in your project directory.
+
+Ensure you have an npm script called "payload" in your `package.json` file.
+
+```json
+{
+  "scripts": {
+    "payload": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload"
+  }
+}
+```
+
+<Banner>
+  Note that you need to run Payload migrations through the package manager that you are using,
+  because Payload should not be globally installed on your system.
+</Banner>
+
+## Migration file contents
+
+Payload stores all created migrations in a folder that you can specify. By default, migrations are stored
+in `./src/migrations`.
+
+A migration file has two exports - an `up` function, which is called when a migration is executed, and a `down` function
+that will be called if for some reason the migration fails to complete successfully. The `up` function should contain
+all changes that you attempt to make within the migration, and the `down` should ideally revert any changes you make.
+
+For an added level of safety, migrations should leverage Payload [transactions](/docs/database/transactions). Migration
+functions should make use of the `req` by adding it to the arguments of your Payload Local API calls such
+as `payload.create` and Database Adapter methods like `payload.db.create`.
+
+Here is an example migration file:
+
+```ts
+import { MigrateUpArgs, MigrateDownArgs } from '@payloadcms/your-db-adapter'
+
+export async function up({ payload, req }: MigrateUpArgs): Promise<void> {
+  // Perform changes to your database here.
+  // You have access to `payload` as an argument, and
+  // everything is done in TypeScript.
+}
+
+export async function down({ payload, req }: MigrateDownArgs): Promise<void> {
+  // Do whatever you need to revert changes if the `up` function fails
+}
+```
+
+## Migrations Directory
+
+Each DB adapter has an optional property `migrationDir` where you can override where you want your migrations to be
+stored/read. If this is not specified, Payload will check the default and possibly make a best effort to find your
+migrations directory by searching in common locations ie. `./src/migrations`, `./dist/migrations`, `./migrations`, etc.
+
+All database adapters should implement similar migration patterns, but there will be small differences based on the
+adapter and its specific needs. Below is a list of all migration commands that should be supported by your database
+adapter.
+
+## Commands
+
+### Migrate
+
+The `migrate` command will run any migrations that have not yet been run.
+
+```text
+npm run payload migrate
+```
+
+### Create
+
+Create a new migration file in the migrations directory. You can optionally name the migration that will be created. By
+default, migrations will be named using a timestamp.
+
+```text
+npm run payload migrate:create optional-name-here
+```
+
+### Status
+
+The `migrate:status` command will check the status of migrations and output a table of which migrations have been run,
+and which migrations have not yet run.
+
+`payload migrate:status`
+
+```text
+npm run payload migrate:status
+```
+
+### Down
+
+Roll back the last batch of migrations.
+
+```text
+npm run payload migrate:down
+```
+
+### Refresh
+
+Roll back all migrations that have been run, and run them again.
+
+```text
+npm run payload migrate:refresh
+```
+
+### Reset
+
+Roll back all migrations.
+
+```text
+npm run payload migrate:reset
+```
+
+### Fresh
+
+Drops all entities from the database and re-runs all migrations from scratch.
+
+```text
+npm run payload migrate:fresh
+```
+
+## When to run migrations
+
+Depending on which Database Adapter you use, your migration workflow might differ subtly.
+
+In relational databases, migrations will be **required** for non-development database environments. But with MongoDB, you might only need to run migrations once in a while (or never even need them).
+
+#### MongoDB
+
+In MongoDB, you'll only ever really need to run migrations for times where you change your database shape, and you have lots of existing data that you'd like to transform from Shape A to Shape B.
+
+In this case, you can create a migration by running `pnpm payload migrate:create`, and then write the logic that you need to perform to migrate your documents to their new shape. You can then either run your migrations in CI before you build / deploy, or you can run them locally, against your production database, by using your production database connection string on your local computer and running the `pnpm payload migrate` command.
+
+#### Postgres
+
+In relational databases like Postgres, migrations are a bit more important, because each time you add a new field or a new collection, you'll need to update the shape of your database to match your Payload Config (otherwise you'll see errors upon trying to read / write your data).
+
+That means that Postgres users of Payload should become familiar with the entire migration workflow from top to bottom.
+
+Here is an overview of a common workflow for working locally against a development database, creating migrations, and then running migrations against your production database before deploying.
+
+**1 - work locally using push mode**
+
+Payload uses Drizzle ORM's powerful `push` mode to automatically sync data changes to your database for you while in development mode. By default, this is enabled and is the suggested workflow to using Postgres and Payload while doing local development.
+
+You can disable this setting and solely use migrations to manage your local development database (pass `push: false` to your Postgres adapter), but if you do disable it, you may see frequent errors while running development mode. This is because Payload will have updated to your new data shape, but your local database will not have updated.
+
+For this reason, we suggest that you leave `push` as its default setting and treat your local dev database as a sandbox.
+
+For more information about push mode and prototyping in development, [click here](/docs/beta/database/postgres#prototyping-in-dev-mode).
+
+The typical workflow in Payload is to build out your Payload configs, install plugins, and make progress in development mode - allowing Drizzle to push your changes to your local database for you. Once you're finished, you can create a migration.
+
+But importantly, you do not need to run migrations against your development database, because Drizzle will have already pushed your changes to your database for you.
+
+<Banner type="warning">
+  Warning: do not mix "push" and migrations with your local development database. If you use "push"
+  locally, and then try to migrate, Payload will throw a warning, telling you that these two methods
+  are not meant to be used interchangeably.
+</Banner>
+
+**2 - create a migration**
+
+Once you're done with working in your Payload Config, you can create a migration. It's best practice to try and complete a specific task or fully build out a feature before you create a migration.
+
+But once you're ready, you can run `pnpm payload migrate:create`, which will perform the following steps for you:
+
+- We will look for any existing migrations, and automatically generate SQL changes necessary to convert your schema from its prior state to the new state of your Payload Config
+- We will then create a new migration file in your `/migrations` folder that contains all the SQL necessary to be run
+
+We won't immediately run this migration for you, however.
+
+<Banner type="success">
+  Tip: migrations created by Payload are relatively programmatic in nature, so there should not be any surprises, but before you check in the created migration it's a good idea to always double-check the contents of the migration files.
+</Banner>
+
+**3 - set up your build process to run migrations**
+
+Generally, you want to run migrations before you build Payload for production. This typically happens in your CI pipeline and can usually be configured on platforms like Payload Cloud, Vercel, or Netlify by specifying your build script.
+
+A common set of scripts in a `package.json`, set up to run migrations in CI, might look like this:
+
+```js
+  "scripts": {
+    // For running in dev mode
+    "dev": "next dev --turbo",
+
+    // To build your Next + Payload app for production
+    "build": "next build",
+
+    // A "tie-in" to Payload's CLI for convenience
+    // this helps you run `pnpm payload migrate:create` and similar
+    "payload": "cross-env NODE_OPTIONS=--no-deprecation payload",
+
+    // This command is what you'd set your `build script` to.
+    // Notice how it runs `payload migrate` and then `pnpm build`?
+    // This will run all migrations for you before building, in your CI,
+    // against your production database
+    "ci": "payload migrate && pnpm build",
+  },
+```
+
+In the example above, we've specified a `ci` script which we can use as our "build script" in the platform that we are deploying to production with.
+
+This will require that your build pipeline can connect to your database, and it will simply run the `payload migrate` command prior to starting the build process. By calling `payload migrate`, Payload will automatically execute any migrations in your `/migrations` folder that have not yet been executed against your production database, in the order that they were created.
+
+If it fails, the deployment will be rejected. But now, with your build script set up to run your migrations, you will be all set! Next time you deploy, your CI will execute the required migrations for you, and your database will be caught up with the shape that your Payload Config requires.
+
+## Running migrations in production
+
+In certain cases, you might want to run migrations at runtime when the server starts. Running them during build time may be impossible due to not having access to your database connection while building or similar reasoning.
+
+If you're using a long-running server or container where your Node server starts up one time and then stays initialized, you might prefer to run migrations on server startup instead of within your CI.
+
+In order to run migrations at runtime, on initialization, you can pass your migrations to your database adapter under the `prodMigrations` key as follows:
+
+```ts
+// Import your migrations from the `index.ts` file
+// that Payload generates for you
+import { migrations } from './migrations'
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  // your config here
+  db: postgresAdapter({
+    //  your adapter config here
+    prodMigrations: migrations
+  })
+})
+```
+
+Passing your migrations as shown above will tell Payload, in production only, to execute any migrations that need to be run prior to completing the initialization of Payload. This is ideal for long-running services where Payload will only be initialized at startup.
+
+<Banner type="warning">
+  Warning - if Payload is instructed to run migrations in production, this may slow down serverless cold starts on platforms such as Vercel. Generally, this option should only be used for long-running servers / containers.
+</Banner>

docs/database/mongodb.mdx

@@ -0,0 +1,51 @@
+---
+title: MongoDB
+label: MongoDB
+order: 40
+desc: Payload has supported MongoDB natively since we started. The flexible nature of MongoDB lends itself well to Payload's powerful fields.
+keywords: MongoDB, documentation, typescript, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+To use Payload with MongoDB, install the package `@payloadcms/db-mongodb`. It will come with everything you need to
+store your Payload data in MongoDB.
+
+Then from there, pass it to your Payload Config as follows:
+
+```ts
+import { mongooseAdapter } from '@payloadcms/db-mongodb'
+
+export default buildConfig({
+  // Your config goes here
+  collections: [
+    // Collections go here
+  ],
+  // Configure the Mongoose adapter here
+  db: mongooseAdapter({
+    // Mongoose-specific arguments go here.
+    // URL is required.
+    url: process.env.DATABASE_URI,
+  }),
+})
+```
+
+## Options
+
+| Option               | Description |
+| -------------------- | ----------- |
+| `autoPluralization`  | Tell Mongoose to auto-pluralize any collection names if it encounters any singular words used as collection `slug`s. |
+| `connectOptions`     | Customize MongoDB connection options. Payload will connect to your MongoDB database using default options which you can override and extend to include all the [options](https://mongoosejs.com/docs/connections.html#options) available to mongoose. |
+| `disableIndexHints`  | Set to true to disable hinting to MongoDB to use 'id' as index. This is currently done when counting documents for pagination, as it increases the speed of the count function used in that query. Disabling this optimization might fix some problems with AWS DocumentDB. Defaults to false |
+| `migrationDir`       | Customize the directory that migrations are stored. |
+| `transactionOptions` | An object with configuration properties used in [transactions](https://www.mongodb.com/docs/manual/core/transactions/) or `false` which will disable the use of transactions. |
+| `collation`          | Enable language-specific string comparison with customizable options. Available on MongoDB 3.4+. Defaults locale to "en". Example: `{ strength: 3 }`. For a full list of collation options and their definitions, see the [MongoDB documentation](https://www.mongodb.com/docs/manual/reference/collation/). |
+
+## Access to Mongoose models
+
+After Payload is initialized, this adapter exposes all of your Mongoose models and they are available for you to work
+with directly.
+
+You can access Mongoose models as follows:
+
+- Collection models - `payload.db.collections[myCollectionSlug]`
+- Globals model - `payload.db.globals`
+- Versions model (both collections and globals) - `payload.db.versions[myEntitySlug]`

docs/database/overview.mdx

@@ -0,0 +1,72 @@
+---
+title: Database
+label: Overview
+order: 10
+keywords: database, mongodb, postgres, documentation, Content Management System, cms, headless, typescript, node, react, nextjs
+desc: With Payload, you bring your own database and own your data. You have full control.
+---
+
+Payload is database agnostic, meaning you can use any type of database behind Payload's familiar APIs. Payload is designed to interact with your database through a Database Adapter, which is a thin layer that translates Payload's internal data structures into your database's native data structures.
+
+Currently, Payload officially supports the following Database Adapters:
+
+- [MongoDB](/docs/database/mongodb) with [Mongoose](https://mongoosejs.com/)
+- [Postgres](/docs/database/postgres) with [Drizzle](https://drizzle.team/)
+- [SQLite](/docs/database/sqlite) with [Drizzle](https://drizzle.team/)
+
+To configure a Database Adapter, use the `db` property in your [Payload Config](../configuration/overview):
+
+```ts
+import { buildConfig } from 'payload'
+import { mongooseAdapter } from '@payloadcms/db-mongodb'
+
+export default buildConfig({
+  // ...
+  // highlight-start
+  db: mongooseAdapter({
+    url: process.env.DATABASE_URI,
+  }),
+  // highlight-end
+})
+```
+
+<Banner type="warning">
+  <strong>Reminder:</strong>
+  The Database Adapter is an external dependency and must be installed in your project separately from Payload. You can find the installation instructions for each Database Adapter in their respective documentation.
+</Banner>
+
+## Selecting a Database
+
+There are several factors to consider when choosing which database technology and hosting option is right for your project and workload. Payload can theoretically support any database, but it's up to you to decide which database to use.
+
+There are two main categories of databases to choose from:
+
+- [Non-Relational Databases](#non-relational-databases)
+- [Relational Databases](#relational-databases)
+
+### Non-Relational Databases
+
+If your project has a lot of dynamic fields, and you are comfortable with allowing Payload to enforce data integrity across your documents, MongoDB is a great choice. With it, your Payload documents are stored as _one_ document in your database—no matter if you have localization enabled, how many block or array fields you have, etc. This means that the shape of your data in your database will very closely reflect your field schema, and there is minimal complexity involved in storing or retrieving your data.
+
+You should prefer MongoDB if:
+
+- You prefer simplicity within your database
+- You don't want to deal with keeping production / staging databases in sync via [DDL changes](https://en.wikipedia.org/wiki/Data_definition_language)
+- Most (or everything) in your project is [Localized](../configuration/localization)
+- You leverage a lot of [Arrays](../fields/array), [Blocks](../fields/blocks), or `hasMany` [Select](../fields/select) fields
+
+### Relational Databases
+
+Many projects might call for more rigid database architecture where the shape of your data is strongly enforced at the database level. For example, if you know the shape of your data and it's relatively "flat", and you don't anticipate it to change often, your workload might suit relational databases like Postgres very well.
+
+You should prefer a relational DB like Postgres or SQLite if:
+
+- You are comfortable with [Migrations](./migrations)
+- You require enforced data consistency at the database level
+- You have a lot of relationships between collections and require relationships to be enforced
+
+## Payload Differences
+
+It's important to note that nearly every Payload feature is available in all of our officially supported Database Adapters, including [Localization](../configuration/localization), [Arrays](../fields/array), [Blocks](../fields/blocks), etc. The only thing that is not supported in Postgres yet is the [Point Field](/docs/fields/point), but that should be added soon.
+
+It's up to you to choose which database you would like to use based on the requirements of your project. Payload has no opinion on which database you should ultimately choose.

docs/database/postgres.mdx

@@ -0,0 +1,99 @@
+---
+title: Postgres
+label: Postgres
+order: 50
+desc: Payload supports Postgres through an officially supported Drizzle Database Adapter.
+keywords: Postgres, documentation, typescript, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+To use Payload with Postgres, install the package `@payloadcms/db-postgres`. It leverages Drizzle ORM and `node-postgres` to interact with a Postgres database that you provide.
+
+Alternatively, the `@payloadcms/db-vercel-postgres` package is also available and is optimized for use with Vercel.
+
+It automatically manages changes to your database for you in development mode, and exposes a full suite of migration controls for you to leverage in order to keep other database environments in sync with your schema. DDL transformations are automatically generated.
+
+To configure Payload to use Postgres, pass the `postgresAdapter` to your Payload Config as follows:
+
+### Usage
+
+`@payloadcms/db-postgres`:
+
+```ts
+import { postgresAdapter } from '@payloadcms/db-postgres'
+
+export default buildConfig({
+  // Configure the Postgres adapter here
+  db: postgresAdapter({
+    // Postgres-specific arguments go here.
+    // `pool` is required.
+    pool: {
+      connectionString: process.env.DATABASE_URI,
+    },
+  }),
+})
+```
+
+`@payloadcms/db-vercel-postgres`:
+
+```ts
+import { vercelPostgresAdapter } from '@payloadcms/db-vercel-postgres'
+
+export default buildConfig({
+  // Automatically uses proces.env.POSTGRES_URL if no options are provided.
+  db: vercelPostgresAdapter(),
+  // Optionally, can accept the same options as the @vercel/postgres package.
+  db: vercelPostgresAdapter({
+    pool: {
+      connectionString: process.env.DATABASE_URL
+    },
+  }),
+})
+```
+
+## Options
+
+| Option                      | Description                                                                                                                                                                      |
+| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `pool` \*                   | [Pool connection options](https://orm.drizzle.team/docs/quick-postgresql/node-postgres) that will be passed to Drizzle and `node-postgres` or to `@vercel/postgres`              |
+| `push`                      | Disable Drizzle's [`db push`](https://orm.drizzle.team/kit-docs/overview#prototyping-with-db-push) in development mode. By default, `push` is enabled for development mode only. |
+| `migrationDir`              | Customize the directory that migrations are stored.                                                                                                                              |
+| `schemaName` (experimental) | A string for the postgres schema to use, defaults to 'public'.                                                                                                                   |
+| `idType`                    | A string of 'serial', or 'uuid' that is used for the data type given to id columns.                                                                                              |
+| `transactionOptions`        | A PgTransactionConfig object for transactions, or set to `false` to disable using transactions. [More details](https://orm.drizzle.team/docs/transactions)                       |
+| `localesSuffix`             | A string appended to the end of table names for storing localized fields. Default is '_locales'.                                                                                 |
+| `relationshipsSuffix`       | A string appended to the end of table names for storing relationships. Default is '_rels'.                                                                                       |
+| `versionsSuffix`            | A string appended to the end of table names for storing versions. Defaults to '_v'.                                                                                              |
+
+## Access to Drizzle
+
+After Payload is initialized, this adapter will expose the full power of Drizzle to you for use if you need it.
+
+You can access Drizzle as follows:
+
+```text
+payload.db.drizzle
+```
+
+## Tables, relations, and enums
+
+In addition to exposing Drizzle directly, all of the tables, Drizzle relations, and enum configs are exposed for you via the `payload.db` property as well.
+
+- Tables - `payload.db.tables`
+- Enums - `payload.db.enums`
+- Relations - `payload.db.relations`
+
+## Prototyping in development mode
+
+Drizzle exposes two ways to work locally in development mode.
+
+The first is [`db push`](https://orm.drizzle.team/kit-docs/overview#prototyping-with-db-push), which automatically pushes changes you make to your Payload Config (and therefore, Drizzle schema) to your database so you don't have to manually migrate every time you change your Payload Config. This only works in development mode, and should not be mixed with manually running [`migrate`](/docs/database/migrations) commands.
+
+You will be warned if any changes that you make will entail data loss while in development mode. Push is enabled by default, but you can opt out if you'd like.
+
+Alternatively, you can disable `push` and rely solely on migrations to keep your local database in sync with your Payload Config.
+
+## Migration workflows
+
+In Postgres, migrations are a fundamental aspect of working with Payload and you should become familiar with how they work.
+
+For more information about migrations, [click here](/docs/beta/database/migrations#when-to-run-migrations).

docs/database/sqlite.mdx

@@ -0,0 +1,81 @@
+---
+title: SQLite
+label: SQLite
+order: 60
+desc: Payload supports SQLite through an officially supported Drizzle Database Adapter.
+keywords: SQLite, documentation, typescript, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+To use Payload with SQLite, install the package `@payloadcms/db-sqlite`. It leverages Drizzle ORM and `libSQL` to interact with a SQLite database that you provide.
+
+It automatically manages changes to your database for you in development mode, and exposes a full suite of migration controls for you to leverage in order to keep other database environments in sync with your schema. DDL transformations are automatically generated.
+
+To configure Payload to use SQLite, pass the `sqliteAdapter` to your Payload Config as follows:
+
+```ts
+import { sqliteAdapter } from '@payloadcms/db-sqlite'
+
+export default buildConfig({
+  // Your config goes here
+  collections: [
+    // Collections go here
+  ],
+  // Configure the SQLite adapter here
+  db: sqliteAdapter({
+    // SQLite-specific arguments go here.
+    // `client.url` is required.
+    client: {
+      url: process.env.DATABASE_URL,
+      authToken: process.env.DATABASE_AUTH_TOKEN,
+    }
+  }),
+})
+```
+
+## Options
+
+| Option                | Description                                                                                                                                                                      |
+|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `client` \*           | [Client connection options](https://orm.drizzle.team/docs/get-started-sqlite#turso) that will be passed to `createClient` from `@libsql/client`.                                 |
+| `push`                | Disable Drizzle's [`db push`](https://orm.drizzle.team/kit-docs/overview#prototyping-with-db-push) in development mode. By default, `push` is enabled for development mode only. |
+| `migrationDir`        | Customize the directory that migrations are stored.                                                                                                                              |
+| `logger`              | The instance of the logger to be passed to drizzle. By default Payload's will be used.                                                                                           |
+| `transactionOptions`  | A SQLiteTransactionConfig object for transactions, or set to `false` to disable using transactions. [More details](https://orm.drizzle.team/docs/transactions)                   |
+| `localesSuffix`       | A string appended to the end of table names for storing localized fields. Default is '_locales'.                                                                                 |
+| `relationshipsSuffix` | A string appended to the end of table names for storing relationships. Default is '_rels'.                                                                                       |
+| `versionsSuffix`      | A string appended to the end of table names for storing versions. Defaults to '_v'.                                                                                              |
+
+
+
+## Access to Drizzle
+
+After Payload is initialized, this adapter will expose the full power of Drizzle to you for use if you need it.
+
+You can access Drizzle as follows:
+
+```text
+payload.db.drizzle
+```
+
+## Tables and relations
+
+In addition to exposing Drizzle directly, all of the tables and Drizzle relations are exposed for you via the `payload.db` property as well.
+
+- Tables - `payload.db.tables`
+- Relations - `payload.db.relations`
+
+## Prototyping in development mode
+
+Drizzle exposes two ways to work locally in development mode.
+
+The first is [`db push`](https://orm.drizzle.team/kit-docs/overview#prototyping-with-db-push), which automatically pushes changes you make to your Payload Config (and therefore, Drizzle schema) to your database so you don't have to manually migrate every time you change your Payload Config. This only works in development mode, and should not be mixed with manually running [`migrate`](/docs/database/migrations) commands.
+
+You will be warned if any changes that you make will entail data loss while in development mode. Push is enabled by default, but you can opt out if you'd like.
+
+Alternatively, you can disable `push` and rely solely on migrations to keep your local database in sync with your Payload Config.
+
+## Migration workflows
+
+In SQLite, migrations are a fundamental aspect of working with Payload and you should become familiar with how they work.
+
+For more information about migrations, [click here](/docs/beta/database/migrations#when-to-run-migrations).

docs/database/transactions.mdx

@@ -0,0 +1,74 @@
+---
+title: Transactions
+label: Transactions
+order: 30
+keywords: database, transactions, sql, mongodb, postgres, documentation, Content Management System, cms, headless, typescript, node, react, nextjs
+desc: Database transactions are fully supported within Payload.
+---
+
+Database transactions allow your application to make a series of database changes in an all-or-nothing commit. Consider an HTTP request that creates a new **Order** and has an `afterChange` hook to update the stock count of related **Items**. If an error occurs when updating an **Item** and an HTTP error is returned to the user, you would not want the new **Order** to be persisted or any other items to be changed either. This kind of interaction with the database is handled seamlessly with transactions.
+
+By default, Payload will use transactions for all operations, as long as it is supported by the configured database. Database changes are contained within all Payload operations and any errors thrown will result in all changes being rolled back without being committed. When transactions are not supported by the database, Payload will continue to operate as expected without them.
+
+<Banner type="info">
+  <strong>Note:</strong>
+  <br />
+  MongoDB requires a connection to a replicaset in order to make use of transactions.
+</Banner>
+
+The initial request made to Payload will begin a new transaction and attach it to the `req.transactionID`. If you have a `hook` that interacts with the database, you can opt-in to using the same transaction by passing the `req` in the arguments. For example:
+
+```ts
+const afterChange: CollectionAfterChangeHook = async ({ req }) => {
+  // because req.transactionID is assigned from Payload and passed through,
+  // my-slug will only persist if the entire request is successful
+  await req.payload.create({
+    req,
+    collection: 'my-slug',
+    data: {
+      some: 'data',
+    },
+  })
+}
+```
+
+## Async Hooks with Transactions
+
+Since Payload hooks can be async and be written to not await the result, it is possible to have an incorrect success response returned on a request that is rolled back. If you have a hook where you do not `await` the result, then you should **not** pass the `req.transactionID`.
+
+```ts
+const afterChange: CollectionAfterChangeHook = async ({ req }) => {
+  // WARNING: an async call made with the same req, but NOT awaited,
+  // may fail resulting in an OK response being returned with response data that is not committed
+  const dangerouslyIgnoreAsync = req.payload.create({
+    req,
+    collection: 'my-slug',
+    data: {
+      some: 'other data',
+    },
+  })
+
+  // Should this call fail, it will not rollback other changes
+  // because the req (and its transactionID) is not passed through
+  const safelyIgnoredAsync = req.payload.create({
+    collection: 'my-slug',
+    data: {
+      some: 'other data',
+    },
+  })
+}
+```
+
+## Direct Transaction Access
+
+When writing your own scripts or custom endpoints, you may wish to have direct control over transactions. This is useful for interacting with your database outside of Payload's local API.
+
+The following functions can be used for managing transactions:
+
+`payload.db.beginTransaction` - Starts a new session and returns a transaction ID for use in other Payload Local API calls.
+`payload.db.commitTransaction` - Takes the identifier for the transaction, finalizes any changes.
+`payload.db.rollbackTransaction` - Takes the identifier for the transaction, discards any changes.
+
+## Disabling Transactions
+
+If you wish to disable transactions entirely, you can do so by passing `false` as the `transactionOptions` in your database adapter configuration. All the official Payload database adapters support this option.

docs/email/overview.mdx

@@ -0,0 +1,166 @@
+---
+title: Email Functionality
+label: Overview
+order: 10
+desc: Payload uses an adapter pattern to enable email functionality. Set up email functions such as password resets, order confirmations and more.
+keywords: email, overview, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+## Introduction
+
+Payload has a few email adapters that can be imported to enable email functionality. The [@payloadcms/email-nodemailer](https://www.npmjs.com/package/@payloadcms/email-nodemailer) package will be the package most will want to install. This package provides an easy way to use [Nodemailer](https://nodemailer.com) for email and won't get in your way for those already familiar.
+
+The email adapter should be passed into the `email` property of the Payload Config. This will allow Payload to send [auth-related emails](../authentication/email) for things like password resets, new user verification, and any other email sending needs you may have.
+
+## Configuration
+
+### Default Configuration
+
+When email is not needed or desired, Payload will log a warning on startup notifying that email is not configured. A  warning message will also be logged on any attempt to send an email.
+
+### Email Adapter
+
+An email adapter will require at least the following fields:
+
+| Option                      | Description                                                                      |
+| --------------------------- | -------------------------------------------------------------------------------- |
+| **`defaultFromName`** \*    | The name part of the From field that will be seen on the delivered email         |
+| **`defaultFromAddress`** \* | The email address part of the From field that will be used when delivering email |
+
+
+### Official Email Adapters
+
+| Name       | Package                                                                                    | Description                                                                                                                                                                                     |
+| ---------- | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Nodemailer | [@payloadcms/email-nodemailer](https://www.npmjs.com/package/@payloadcms/email-nodemailer) | Use any [Nodemailer transport](https://nodemailer.com/transports), including SMTP, Resend, SendGrid, and more. This was provided by default in Payload 2.x. This is the easiest migration path. |
+| Resend     | [@payloadcms/email-resend](https://www.npmjs.com/package/@payloadcms/email-resend)         | Resend email via their REST API. This is preferred for serverless platforms such as Vercel because it is much more lightweight than the nodemailer adapter.                                     |
+
+## Nodemailer Configuration
+
+| Option                 | Description                                                                                                                                                                            |
+| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`transport`**        | The Nodemailer transport object for when you want to do it yourself, not needed when transportOptions is set                                                                           |
+| **`transportOptions`** | An object that configures the transporter that Payload will create. For all the available options see the [Nodemailer documentation](https://nodemailer.com) or see the examples below |
+
+## Use SMTP
+
+Simple Mail Transfer Protocol (SMTP) options can be passed in using the `transportOptions` object on the `email` options. See the [Nodemailer SMTP documentation](https://nodemailer.com/smtp/) for more information, including details on when `secure` should and should not be set to `true`.
+
+**Example email options using SMTP:**
+
+```ts
+import { buildConfig } from 'payload'
+import { nodemailerAdapter } from '@payloadcms/email-nodemailer'
+
+export default buildConfig({
+  email: nodemailerAdapter({
+    defaultFromAddress: 'info@payloadcms.com',
+    defaultFromName: 'Payload',
+    // Nodemailer transportOptions
+    transportOptions: {
+      host: process.env.SMTP_HOST,
+      port: 587,
+      auth: {
+        user: process.env.SMTP_USER,
+        pass: process.env.SMTP_PASS,
+      },
+    },
+  }),
+})
+```
+
+**Example email options using nodemailer.createTransport:**
+
+```ts
+import { buildConfig } from 'payload'
+import { nodemailerAdapter } from '@payloadcms/email-nodemailer'
+import nodemailer from 'nodemailer'
+
+export default buildConfig({
+  email: nodemailerAdapter({
+    defaultFromAddress: 'info@payloadcms.com',
+    defaultFromName: 'Payload',
+    // Any Nodemailer transport can be used
+    transport: nodemailer.createTransport({
+      host: process.env.SMTP_HOST,
+      port: 587,
+      auth: {
+        user: process.env.SMTP_USER,
+        pass: process.env.SMTP_PASS,
+      },
+    }),
+  }),
+})
+```
+
+**Custom Transport:**
+
+You also have the ability to bring your own nodemailer transport. This is an example of using the SendGrid nodemailer transport.
+
+
+```ts
+import { buildConfig } from 'payload'
+import { nodemailerAdapter } from '@payloadcms/email-nodemailer'
+import nodemailerSendgrid from 'nodemailer-sendgrid'
+
+
+export default buildConfig({
+  email: nodemailerAdapter({
+    defaultFromAddress: 'info@payloadcms.com',
+    defaultFromName: 'Payload',
+    transportOptions: nodemailerSendgrid({
+      apiKey: process.env.SENDGRID_API_KEY,
+    }),
+  }),
+})
+```
+
+During development, if you pass nothing to `nodemailerAdapter`, it will use the [ethereal.email](https://ethereal.email) service.
+
+This will log the ethereal.email details to console on startup.
+
+```ts
+import { nodemailerAdapter } from '@payloadcms/email-nodemailer'
+
+export default buildConfig({
+  email: nodemailerAdapter(),
+})
+```
+
+## Resend Configuration
+
+The Resend adapter requires an API key to be passed in the options. This can be found in the Resend dashboard. This is the preferred package if you are deploying on Vercel because this is much more lightweight than the Nodemailer adapter.
+
+| Option | Description                         |
+| ------ | ----------------------------------- |
+| apiKey | The API key for the Resend service. |
+
+```ts
+import { buildConfig } from 'payload'
+import { resendAdapter } from '@payloadcms/email-resend'
+
+export default buildConfig({
+  email: resendAdapter({
+    defaultFromAddress: 'dev@payloadcms.com',
+    defaultFromName: 'Payload CMS',
+    apiKey: process.env.RESEND_API_KEY || '',
+  }),
+})
+```
+
+## Sending Mail
+
+With a working transport you can call it anywhere you have access to Payload by calling `payload.sendEmail(message)`. The `message` will contain the `to`, `subject` and `html` or `text` for the email being sent. Other options are also available and can be seen in the sendEmail args. Support for these will depend on the adapter being used.
+
+```ts
+// Example of sending an email
+const email = await payload.sendEmail({
+  to: 'test@example.com',
+  subject: 'This is a test email',
+  text: 'This is my message body',
+})
+```
+
+## Using multiple mail providers
+
+Payload supports the use of a single transporter of email, but there is nothing stopping you from having more. Consider a use case where sending bulk email is handled differently than transactional email and could be done using a [hook](/docs/hooks/overview).

docs/examples/overview.mdx

@@ -0,0 +1,41 @@
+---
+title: Examples
+label: Overview
+order: 10
+desc:
+keywords: example, examples, starter, boilerplate, template, templates
+---
+
+Payload provides a vast array of examples to help you get started with your project no matter what you are working on. These examples are designed to be easy to get up and running, and to be easy to understand. They showcase nothing more than the specific features being demonstrated so you can easily decipher what is going on.
+
+Examples are changing every day, so be sure to check back often to see what new examples have been added. If you have a specific example you would like to see, please feel free to start a new [Discussion](https://github.com/payloadcms/payload/discussions) or open a new [PR](https://github.com/payloadcms/payload/pulls) to add it yourself.
+
+- [Auth](https://github.com/payloadcms/payload/tree/main/examples/auth)
+- [Custom Components](https://github.com/payloadcms/payload/tree/main/examples/custom-components)
+- [Custom Server](https://github.com/payloadcms/payload/tree/main/examples/custom-server)
+- [Draft Preview](https://github.com/payloadcms/payload/tree/main/examples/draft-preview)
+- [Email](https://github.com/payloadcms/payload/tree/main/examples/email)
+- [Form Builder](https://github.com/payloadcms/payload/tree/main/examples/form-builder)
+- [Hierarchy](https://github.com/payloadcms/payload/tree/main/examples/hierarchy)
+- [Live Preview](https://github.com/payloadcms/payload/tree/main/examples/live-preview)
+- [Multi-tenant](https://github.com/payloadcms/payload/tree/main/examples/multi-tenant)
+- [Nested Docs](https://github.com/payloadcms/payload/tree/main/examples/nested-docs)
+- [Redirects](https://github.com/payloadcms/payload/tree/main/examples/redirects)
+- [Tailwind / Shadcn-ui](https://github.com/payloadcms/payload/tree/main/examples/tailwind-shadcn-ui)
+- [Tests](https://github.com/payloadcms/payload/tree/main/examples/testing)
+- [Virtual Fields](https://github.com/payloadcms/payload/tree/main/examples/virtual-fields)
+- [White-label Admin UI](https://github.com/payloadcms/payload/tree/main/examples/whitelabel)
+
+When necessary, some examples include a front-end. Examples that require a front-end share this folder structure:
+
+```plaintext
+example/
+├── payload/
+├── next-app/
+├── next-pages/
+├── react-router/
+├── vue/
+├── svelte/
+```
+
+Where `payload` is your Payload project, and the other directories are dedicated to their respective front-end framework. We are adding new examples every day, so if your framework of choice is not yet supported in any particular example, please feel free to start a new [Discussion](https://github.com/payloadcms/payload/discussions) or open a new [PR](https://github.com/payloadcms/payload/pulls) to add it yourself.

docs/fields/array.mdx

@@ -0,0 +1,137 @@
+---
+title: Array Field
+label: Array
+order: 20
+desc: Array Fields are intended for sets of repeating fields, that you define. Learn how to use Array Fields, see examples and options.
+keywords: array, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+The Array Field is used when you need to have a set of "repeating" [Fields](./overview). It stores an array of objects containing fields that you define. These fields can be of any type, including other arrays to achieve infinitely nested structures.
+
+Arrays are useful for many different types of content from simple to complex, such as:
+
+- A "slider" with an image ([upload field](/docs/fields/upload)) and a caption ([text field](/docs/fields/text))
+- Navigational structures where editors can specify nav items containing pages ([relationship field](/docs/fields/relationship)), an "open in new tab" [checkbox field](/docs/fields/checkbox)
+- Event agenda "timeslots" where you need to specify start & end time ([date field](/docs/fields/date)), label ([text field](/docs/fields/text)), and Learn More page [relationship](/docs/fields/relationship)
+
+<LightDarkImage
+  srcLight="https://payloadcms.com/images/docs/fields/array.png"
+  srcDark="https://payloadcms.com/images/docs/fields/array-dark.png"
+  alt="Array field with two Rows in Payload Admin Panel"
+  caption="Admin Panel screenshot of an Array field with two Rows"
+/>
+
+To create an Array Field, set the `type` to `array` in your [Field Config](./overview):
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyArrayField: Field = {
+  // ...
+  // highlight-start
+  type: 'array',
+  fields: [
+    // ...
+  ],
+  // highlight-end
+}
+```
+
+## Config Options
+
+| Option                 | Description                                                                                                                                                                                                                                                                        |
+| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*          | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                                                                                             |
+| **`label`**            | Text used as the heading in the [Admin Panel](../admin/overview) or an object with keys for each language. Auto-generated from name if not defined.                                                                                                                                                     |
+| **`fields`** \*        | Array of field types to correspond to each row of the Array.                                                                                                                                                                                                                       |
+| **`validate`**         | Provide a custom validation function that will be executed on both the [Admin Panel](../admin/overview) and the backend. [More](/docs/fields/overview#validation)                                                                                                                                       |
+| **`minRows`**          | A number for the fewest allowed items during validation when a value is present.                                                                                                                                                                                                   |
+| **`maxRows`**          | A number for the most allowed items during validation when a value is present.                                                                                                                                                                                                     |
+| **`saveToJWT`**        | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/overview), include its data in the user JWT.                                                                                                                                      |
+| **`hooks`**            | Provide Field Hooks to control logic for this field. [More details](../hooks/fields).                                                                                                                                                                         |
+| **`access`**           | Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields).                                                                                                                                                  |
+| **`hidden`**           | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin Panel.                                                                                                                                   |
+| **`defaultValue`**     | Provide an array of row data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                                                                               |
+| **`localized`**        | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this Array will be kept, so there is no need to specify each nested field as `localized`. |
+| **`required`**         | Require this field to have a value.                                                                                                                                                                                                                                                |
+| **`labels`**           | Customize the row labels appearing in the Admin dashboard.                                                                                                                                                                                                                         |
+| **`admin`**            | Admin-specific configuration. [More details](#admin-options).                                                                                                                                                                                                          |
+| **`custom`**           | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                                                                                          |
+| **`interfaceName`**    | Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas).                                                                                                |
+| **`dbName`**           | Custom table name for the field when using SQL Database Adapter ([Postgres](/docs/database/postgres)). Auto-generated from name if not defined.                                                                                                                                    |
+| **`typescriptSchema`** | Override field type generation with providing a JSON schema                                                                                                                                                                                                                        |
+
+_\* An asterisk denotes that a property is required._
+
+## Admin Options
+
+The customize the appearance and behavior of the Array Field in the [Admin Panel](../admin/overview), you can use the `admin` option:
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyArrayField: Field = {
+  // ...
+  admin: { // highlight-line
+    // ...
+  },
+}
+```
+
+The Array Field inherits all of the default options from the base [Field Admin Config](../admin/fields#admin-options), plus the following additional options:
+
+| Option                    | Description                                                                                                          |
+| ------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| **`initCollapsed`**       | Set the initial collapsed state                                                                                      |
+| **`components.RowLabel`** | Function or React component to be rendered as the label on the array row. Receives `({ data, index, path })` as args |
+| **`isSortable`**          | Disable order sorting by setting this value to `false`                                                               |
+
+## Example
+
+In this example, we have an Array Field called `slider` that contains a set of fields for a simple image slider. Each row in the array has a `title`, `image`, and `caption`. We also customize the row label to display the title if it exists, or a default label if it doesn't.
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const ExampleCollection: CollectionConfig = {
+  slug: 'example-collection',
+  fields: [
+    {
+      name: 'slider', // required
+      type: 'array', // required
+      label: 'Image Slider',
+      minRows: 2,
+      maxRows: 10,
+      interfaceName: 'CardSlider', // optional
+      labels: {
+        singular: 'Slide',
+        plural: 'Slides',
+      },
+      fields: [
+        // required
+        {
+          name: 'title',
+          type: 'text',
+        },
+        {
+          name: 'image',
+          type: 'upload',
+          relationTo: 'media',
+          required: true,
+        },
+        {
+          name: 'caption',
+          type: 'text',
+        },
+      ],
+      admin: {
+        components: {
+          RowLabel: ({ data, index }) => {
+            return data?.title || `Slide ${String(index).padStart(2, '0')}`
+          },
+        },
+      },
+    },
+  ],
+}
+```

docs/fields/blocks.mdx

@@ -0,0 +1,173 @@
+---
+title: Blocks Field
+label: Blocks
+order: 30
+desc: The Blocks Field is a great layout build and can be used to construct any flexible content model. Learn how to use Block Fields, see examples and options.
+keywords: blocks, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+The Blocks Field is <strong>incredibly powerful</strong>, storing an array of objects based on the fields that your define, where each item in the array is a "block" with its own unique schema.
+
+Blocks are a great way to create a flexible content model that can be used to build a wide variety of content types, including:
+
+- A layout builder tool that grants editors to design highly customizable page or post layouts. Blocks could include configs such as `Quote`, `CallToAction`, `Slider`, `Content`, `Gallery`, or others.
+- A form builder tool where available block configs might be `Text`, `Select`, or `Checkbox`.
+- Virtual event agenda "timeslots" where a timeslot could either be a `Break`, a `Presentation`, or a `BreakoutSession`.
+
+<LightDarkImage
+  srcLight="https://payloadcms.com/images/docs/fields/blocks.png"
+  srcDark="https://payloadcms.com/images/docs/fields/blocks-dark.png"
+  alt="Admin Panel screenshot of add Blocks drawer view"
+  caption="Admin Panel screenshot of add Blocks drawer view"
+/>
+
+To add a Blocks Field, set the `type` to `blocks` in your [Field Config](./overview):
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyBlocksField: Field = {
+  // ...
+  // highlight-start
+  type: 'blocks',
+  blocks: [
+    // ...
+  ],
+  // highlight-end
+}
+```
+
+## Config Options
+
+| Option                 | Description                                                                                                                                                                                                                                                                        |
+| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*          | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                                                                                             |
+| **`label`**            | Text used as the heading in the Admin Panel or an object with keys for each language. Auto-generated from name if not defined.                                                                                                                                                     |
+| **`blocks`** \*        | Array of [block configs](/docs/fields/blocks#block-configs) to be made available to this field.                                                                                                                                                                                    |
+| **`validate`**         | Provide a custom validation function that will be executed on both the Admin Panel and the backend. [More](/docs/fields/overview#validation)                                                                                                                                       |
+| **`minRows`**          | A number for the fewest allowed items during validation when a value is present.                                                                                                                                                                                                   |
+| **`maxRows`**          | A number for the most allowed items during validation when a value is present.                                                                                                                                                                                                     |
+| **`saveToJWT`**        | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/overview), include its data in the user JWT.                                                                                                                                      |
+| **`hooks`**            | Provide Field Hooks to control logic for this field. [More details](../hooks/fields).                                                                                                                                                                         |
+| **`access`**           | Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields).                                                                                                                                                  |
+| **`hidden`**           | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API response or the Admin Panel.                                                                                                                          |
+| **`defaultValue`**     | Provide an array of block data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                                                                             |
+| **`localized`**        | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this field will be kept, so there is no need to specify each nested field as `localized`. |
+| **`unique`**           | Enforce that each entry in the Collection has a unique value for this field.                                                                                                                                                                                                       |
+| **`labels`**           | Customize the block row labels appearing in the Admin dashboard.                                                                                                                                                                                                                   |
+| **`admin`**            | Admin-specific configuration. [More details](#admin-options).                                                                                                                                                                                                          |
+| **`custom`**           | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                                                                                          |
+| **`typescriptSchema`** | Override field type generation with providing a JSON schema                                                                                                                                                                                                                        |
+
+_\* An asterisk denotes that a property is required._
+
+## Admin Options
+
+The customize the appearance and behavior of the Blocks Field in the [Admin Panel](../admin/overview), you can use the `admin` option:
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyBlocksField: Field = {
+  // ...
+  admin: { // highlight-line
+    // ...
+  },
+}
+```
+
+The Blocks Field inherits all of the default options from the base [Field Admin Config](../admin/fields#admin-options), plus the following additional options:
+
+| Option              | Description                        |
+| ------------------- | ---------------------------------- |
+| **`initCollapsed`**    | Set the initial collapsed state |
+| **`isSortable`**       | Disable order sorting by setting this value to `false` |
+
+## Block Configs
+
+Blocks are defined as separate configs of their own.
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  <br />
+  Best practice is to define each block config in its own file, and then import them into your
+  Blocks field as necessary. This way each block config can be easily shared between fields. For
+  instance, using the "layout builder" example, you might want to feature a few of the same blocks
+  in a Post collection as well as a Page collection. Abstracting into their own files trivializes
+  their reusability.
+</Banner>
+
+| Option                     | Description                                                                                                                                                                         |
+| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`slug`** \*              | Identifier for this block type. Will be saved on each block as the `blockType` property.                                                                                            |
+| **`fields`** \*            | Array of fields to be stored in this block.                                                                                                                                         |
+| **`labels`**               | Customize the block labels that appear in the Admin dashboard. Auto-generated from slug if not defined.                                                                             |
+| **`imageURL`**             | Provide a custom image thumbnail to help editors identify this block in the Admin UI.                                                                                               |
+| **`imageAltText`**         | Customize this block's image thumbnail alt text.                                                                                                                                    |
+| **`interfaceName`**        | Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas). |
+| **`graphQL.singularName`** | Text to use for the GraphQL schema name. Auto-generated from slug if not defined. NOTE: this is set for deprecation, prefer `interfaceName`.                                        |
+| **`dbName`**               | Custom table name for this block type when using SQL Database Adapter ([Postgres](/docs/database/postgres)). Auto-generated from slug if not defined.
+| **`custom`**               | Extension point for adding custom data (e.g. for plugins)                                                                                                                           |
+
+### Auto-generated data per block
+
+In addition to the field data that you define on each block, Payload will store two additional properties on each block:
+
+**`blockType`**
+
+The `blockType` is saved as the slug of the block that has been selected.
+
+**`blockName`**
+
+The Admin Panel provides each block with a `blockName` field which optionally allows editors to label their blocks for better editability and readability.
+
+## Example
+
+`collections/ExampleCollection.js`
+
+```ts
+import { Block, CollectionConfig } from 'payload'
+
+const QuoteBlock: Block = {
+  slug: 'Quote', // required
+  imageURL: 'https://google.com/path/to/image.jpg',
+  imageAltText: 'A nice thumbnail image to show what this block looks like',
+  interfaceName: 'QuoteBlock', // optional
+  fields: [
+    // required
+    {
+      name: 'quoteHeader',
+      type: 'text',
+      required: true,
+    },
+    {
+      name: 'quoteText',
+      type: 'text',
+    },
+  ],
+}
+
+export const ExampleCollection: CollectionConfig = {
+  slug: 'example-collection',
+  fields: [
+    {
+      name: 'layout', // required
+      type: 'blocks', // required
+      minRows: 1,
+      maxRows: 20,
+      blocks: [
+        // required
+        QuoteBlock,
+      ],
+    },
+  ],
+}
+```
+
+## TypeScript
+
+As you build your own Block configs, you might want to store them in separate files but retain typing accordingly. To do so, you can import and use Payload's `Block` type:
+
+```ts
+import type { Block } from 'payload'
+```

docs/fields/checkbox.mdx

@@ -0,0 +1,68 @@
+---
+title: Checkbox Field
+label: Checkbox
+order: 40
+desc: Checkbox field types allow the developer to save a boolean value in the database. Learn how to use Checkbox fields, see examples and options.
+keywords: checkbox, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+The Checkbox Field saves a boolean in the database.
+
+<LightDarkImage
+  srcLight="https://payloadcms.com/images/docs/fields/checkbox.png"
+  srcDark="https://payloadcms.com/images/docs/fields/checkbox-dark.png"
+  alt="Checkbox field with text field in Payload Admin Panel"
+  caption="Admin Panel screenshot of Checkbox field with Text field below"
+/>
+
+To add a Checkbox Field, set the `type` to `checkbox` in your [Field Config](./overview):
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyCheckboxField: Field = {
+  // ...
+  type: 'checkbox', // highlight-line
+}
+```
+
+## Config Options
+
+| Option                 | Description                                                                                                                                                                 |
+| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*          | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
+| **`label`**            | Text used as a field label in the Admin Panel or an object with keys for each language.                                                                                     |
+| **`validate`**         | Provide a custom validation function that will be executed on both the Admin Panel and the backend. [More](/docs/fields/overview#validation)                                |
+| **`index`**            | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
+| **`saveToJWT`**        | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/overview), include its data in the user JWT.                               |
+| **`hooks`**            | Provide Field Hooks to control logic for this field. [More details](../hooks/fields).                                                                                                                                                                         |
+| **`access`**           | Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields).                                                                                                                                                  |
+| **`hidden`**           | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin Panel.                            |
+| **`defaultValue`**     | Provide data to be used for this field's default value, will default to false if field is also `required`. [More](/docs/fields/overview#default-values)                     |
+| **`localized`**        | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
+| **`required`**         | Require this field to have a value.                                                                                                                                         |
+| **`admin`**            | Admin-specific configuration. [More details](../admin/fields#admin-options).                                                    |
+| **`custom`**           | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
+| **`typescriptSchema`** | Override field type generation with providing a JSON schema                                                                                                                 |
+
+_\* An asterisk denotes that a property is required._
+
+## Example
+
+Here is an example of a Checkbox Field in a Collection:
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const ExampleCollection: CollectionConfig = {
+  slug: 'example-collection',
+  fields: [
+    {
+      name: 'enableCoolStuff', // required
+      type: 'checkbox', // required
+      label: 'Click me to see fanciness',
+      defaultValue: false,
+    },
+  ],
+}
+```

docs/fields/code.mdx

@@ -0,0 +1,96 @@
+---
+title: Code Field
+label: Code
+order: 50
+desc: The Code field type will store any string in the Database. Learn how to use Code fields, see examples and options.
+
+keywords: code, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+The Code Field saves a string in the database, but provides the [Admin Panel](../admin/overview) with a code editor styled interface.
+
+<LightDarkImage
+  srcLight="https://payloadcms.com/images/docs/fields/code.png"
+  srcDark="https://payloadcms.com/images/docs/fields/code-dark.png"
+  alt="Shows a Code field in the Payload Admin Panel"
+  caption="This field is using the `monaco-react` editor syntax highlighting."
+/>
+
+To add a Code Field, set the `type` to `code` in your [Field Config](./overview):
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyBlocksField: Field = {
+  // ...
+  type: 'code', // highlight-line
+}
+```
+
+## Config Options
+
+| Option                 | Description                                                                                                                                                                 |
+| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*          | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
+| **`label`**            | Text used as a field label in the Admin Panel or an object with keys for each language.                                                                                     |
+| **`unique`**           | Enforce that each entry in the Collection has a unique value for this field.                                                                                                |
+| **`index`**            | Build an [index](/docs/database#overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
+| **`minLength`**        | Used by the default validation function to ensure values are of a minimum character length.                                                                                 |
+| **`maxLength`**        | Used by the default validation function to ensure values are of a maximum character length.                                                                                 |
+| **`validate`**         | Provide a custom validation function that will be executed on both the Admin Panel and the backend. [More](/docs/fields/overview#validation)                                |
+| **`saveToJWT`**        | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/overview), include its data in the user JWT.                               |
+| **`hooks`**            | Provide Field Hooks to control logic for this field. [More details](../hooks/fields).                                                                                                                                                                         |
+| **`access`**           | Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields).                                                                                                                                                  |
+| **`hidden`**           | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin Panel.                            |
+| **`defaultValue`**     | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                        |
+| **`localized`**        | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
+| **`required`**         | Require this field to have a value.                                                                                                                                         |
+| **`admin`**            | Admin-specific configuration. See below for [more detail](#admin-options).                                                                                                   |
+| **`custom`**           | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
+| **`typescriptSchema`** | Override field type generation with providing a JSON schema                                                                                                                 |
+
+_\* An asterisk denotes that a property is required._
+
+## Admin Options
+
+The customize the appearance and behavior of the Code Field in the [Admin Panel](../admin/overview), you can use the `admin` option:
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyCodeField: Field = {
+  // ...
+  admin: { // highlight-line
+    // ...
+  },
+}
+```
+
+The Code Field inherits all of the default options from the base [Field Admin Config](../admin/fields#admin-options), plus the following additional options:
+
+| Option              | Description                                                                                                                                                                     |
+| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`language`**      | This property can be set to any language listed [here](https://github.com/microsoft/monaco-editor/tree/main/src/basic-languages).                                               |
+| **`editorOptions`** | Options that can be passed to the monaco editor, [view the full list](https://microsoft.github.io/monaco-editor/typedoc/interfaces/editor.IDiffEditorConstructionOptions.html). |
+
+## Example
+
+`collections/ExampleCollection.ts
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const ExampleCollection: CollectionConfig = {
+  slug: 'example-collection',
+  fields: [
+    {
+      name: 'trackingCode', // required
+      type: 'code', // required
+      required: true,
+      admin: {
+        language: 'javascript',
+      },
+    },
+  ],
+}
+```

docs/fields/collapsible.mdx

@@ -0,0 +1,95 @@
+---
+title: Collapsible Field
+label: Collapsible
+order: 60
+desc: With the Collapsible field, you can place fields within a collapsible layout component that can be collapsed / expanded.
+keywords: row, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+The Collapsible Field is presentational-only and only affects the Admin Panel. By using it, you can place fields within a nice layout component that can be collapsed / expanded.
+
+<LightDarkImage
+  srcLight="https://payloadcms.com/images/docs/fields/collapsible.png"
+  srcDark="https://payloadcms.com/images/docs/fields/collapsible-dark.png"
+  alt="Shows a Collapsible field in the Payload Admin Panel"
+  caption="Admin Panel screenshot of a Collapsible field"
+/>
+
+To add a Collapsible Field, set the `type` to `collapsible` in your [Field Config](./overview):
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyCollapsibleField: Field = {
+  // ...
+  // highlight-start
+  type: 'collapsible',
+  fields: [
+    // ...
+  ],
+  // highlight-end
+}
+```
+
+## Config Options
+
+| Option          | Description                                                                                                                                                                  |
+| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`label`** \*  | A label to render within the header of the collapsible component. This can be a string, function or react component. Function/components receive `({ data, path })` as args. |
+| **`fields`** \* | Array of field types to nest within this Collapsible.                                                                                                                        |
+| **`admin`**     | Admin-specific configuration. [More details](#admin-options).                                                                                                    |
+| **`custom`**    | Extension point for adding custom data (e.g. for plugins)                                                                                                                    |
+
+_\* An asterisk denotes that a property is required._
+
+## Admin Options
+
+The customize the appearance and behavior of the Collapsible Field in the [Admin Panel](../admin/overview), you can use the `admin` option:
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyCollapsibleField: Field = {
+  // ...
+  admin: { // highlight-line
+    // ...
+  },
+}
+```
+
+The Collapsible Field inherits all of the default options from the base [Field Admin Config](../admin/fields#admin-options), plus the following additional options:
+
+| Option              | Description                     |
+| ------------------- | ------------------------------- |
+| **`initCollapsed`** | Set the initial collapsed state |
+
+## Example
+
+`collections/ExampleCollection.ts`
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const ExampleCollection: CollectionConfig = {
+  slug: 'example-collection',
+  fields: [
+    {
+      label: ({ data }) => data?.title || 'Untitled',
+      type: 'collapsible', // required
+      fields: [
+        // required
+        {
+          name: 'title',
+          type: 'text',
+          required: true,
+        },
+        {
+          name: 'someTextField',
+          type: 'text',
+          required: true,
+        },
+      ],
+    },
+  ],
+}
+```

docs/fields/date.mdx

@@ -0,0 +1,136 @@
+---
+title: Date Field
+label: Date
+order: 70
+desc: The Date field type stores a Date in the database. Learn how to use and customize the Date field, see examples and options.
+keywords: date, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+The Date Field saves a Date in the database and provides the [Admin Panel](../admin/overview) with a customizable time picker interface.
+
+<LightDarkImage
+  srcLight="https://payloadcms.com/images/docs/fields/date.png"
+  srcDark="https://payloadcms.com/images/docs/fields/date-dark.png"
+  alt="Shows a Date field in the Payload Admin Panel"
+  caption="This field is using the `react-datepicker` component for UI."
+/>
+
+To add a Date Field, set the `type` to `date` in your [Field Config](./overview):
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyDateField: Field = {
+  // ...
+  type: 'date', // highlight-line
+}
+```
+
+## Config Options
+
+| Option                 | Description                                                                                                                                                                 |
+| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*          | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
+| **`label`**            | Text used as a field label in the Admin Panel or an object with keys for each language.                                                                                     |
+| **`index`**            | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
+| **`validate`**         | Provide a custom validation function that will be executed on both the Admin Panel and the backend. [More](/docs/fields/overview#validation)                                |
+| **`saveToJWT`**        | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/overview), include its data in the user JWT.                               |
+| **`hooks`**            | Provide Field Hooks to control logic for this field. [More details](../hooks/fields).                                                                                                                                                                         |
+| **`access`**           | Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields).                                                                                                                                                  |
+| **`hidden`**           | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin Panel.                            |
+| **`defaultValue`**     | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                        |
+| **`localized`**        | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
+| **`required`**         | Require this field to have a value.                                                                                                                                         |
+| **`admin`**            | Admin-specific configuration. [More details](#admin-options).                                                                                                   |
+| **`custom`**           | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
+| **`typescriptSchema`** | Override field type generation with providing a JSON schema                                                                                                                 |
+
+_\* An asterisk denotes that a property is required._
+
+## Admin Options
+
+The customize the appearance and behavior of the Date Field in the [Admin Panel](../admin/overview), you can use the `admin` option:
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyDateField: Field = {
+  // ...
+  admin: { // highlight-line
+    // ...
+  },
+}
+```
+
+The Date Field inherits all of the default options from the base [Field Admin Config](../admin/fields#admin-options), plus the following additional options:
+
+| Property                       | Description                                                                                                                            |
+| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
+| **`placeholder`**              | Placeholder text for the field.                                                                                                        |
+| **`date`**                     | Pass options to customize date field appearance.                                                                                       |
+| **`date.displayFormat`**       | Format date to be shown in field **cell**.                                                                                             |
+| **`date.pickerAppearance`** \* | Determines the appearance of the datepicker: `dayAndTime` `timeOnly` `dayOnly` `monthOnly`.                                            |
+| **`date.monthsToShow`** \*     | Number of months to display max is 2. Defaults to 1.                                                                                   |
+| **`date.minDate`** \*          | Min date value to allow.                                                                                                               |
+| **`date.maxDate`** \*          | Max date value to allow.                                                                                                               |
+| **`date.minTime`** \*          | Min time value to allow.                                                                                                               |
+| **`date.maxTime`** \*          | Max date value to allow.                                                                                                               |
+| **`date.overrides`** \*        | Pass any valid props directly to the [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md) |
+| **`date.timeIntervals`** \*    | Time intervals to display. Defaults to 30 minutes.                                                                                     |
+| **`date.timeFormat`** \*       | Determines time format. Defaults to `'h:mm aa'`.                                                                                       |
+
+_\* This property is passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md). ._
+
+### Display Format and Picker Appearance
+
+These properties only affect how the date is displayed in the UI. The full date is always stored in the format `YYYY-MM-DDTHH:mm:ss.SSSZ` (e.g. `1999-01-01T8:00:00.000+05:00`).
+
+`displayFormat` determines how the date is presented in the field **cell**, you can pass any valid (unicode date format)[https://date-fns.org/v2.29.3/docs/format].
+
+`pickerAppearance` sets the appearance of the **react datepicker**, the options available are `dayAndTime`, `dayOnly`, `timeOnly`, and `monthOnly`. By default, the datepicker will display `dayOnly`.
+
+When only `pickerAppearance` is set, an equivalent format will be rendered in the date field cell. To overwrite this format, set `displayFormat`.
+
+## Example
+
+`collections/ExampleCollection.ts`
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const ExampleCollection: CollectionConfig = {
+  slug: 'example-collection',
+  fields: [
+    {
+      name: 'dateOnly',
+      type: 'date',
+      admin: {
+        date: {
+          pickerAppearance: 'dayOnly',
+          displayFormat: 'd MMM yyy',
+        },
+      },
+    },
+    {
+      name: 'timeOnly',
+      type: 'date',
+      admin: {
+        date: {
+          pickerAppearance: 'timeOnly',
+          displayFormat: 'h:mm:ss a',
+        },
+      },
+    },
+    {
+      name: 'monthOnly',
+      type: 'date',
+      admin: {
+        date: {
+          pickerAppearance: 'monthOnly',
+          displayFormat: 'MMMM yyyy',
+        },
+      },
+    },
+  ],
+}
+```

docs/fields/email.mdx

@@ -0,0 +1,91 @@
+---
+title: Email Field
+label: Email
+order: 80
+desc: The Email field enforces that the value provided is a valid email address. Learn how to use Email fields, see examples and options.
+keywords: email, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+The Email Field enforces that the value provided is a valid email address.
+
+<LightDarkImage
+  srcLight="https://payloadcms.com/images/docs/fields/email.png"
+  srcDark="https://payloadcms.com/images/docs/fields/email-dark.png"
+  alt="Shows an Email field in the Payload Admin Panel"
+  caption="Admin Panel screenshot of an Email field"
+/>
+
+To create an Email Field, set the `type` to `email` in your [Field Config](./overview):
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyEmailField: Field = {
+  // ...
+  type: 'email', // highlight-line
+}
+```
+
+## Config Options
+
+| Option                 | Description                                                                                                                                                                 |
+| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*          | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
+| **`label`**            | Text used as a field label in the Admin Panel or an object with keys for each language.                                                                                     |
+| **`unique`**           | Enforce that each entry in the Collection has a unique value for this field.                                                                                                |
+| **`index`**            | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
+| **`validate`**         | Provide a custom validation function that will be executed on both the Admin Panel and the backend. [More](/docs/fields/overview#validation)                                |
+| **`saveToJWT`**        | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/overview), include its data in the user JWT.                               |
+| **`hooks`**            | Provide Field Hooks to control logic for this field. [More details](../hooks/fields).                                                                                                                                                                         |
+| **`access`**           | Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields).                                                                                                                                                  |
+| **`hidden`**           | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin Panel.                            |
+| **`defaultValue`**     | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                        |
+| **`localized`**        | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
+| **`required`**         | Require this field to have a value.                                                                                                                                         |
+| **`admin`**            | Admin-specific configuration. [More details](#admin-options).                                                                                                   |
+| **`custom`**           | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
+| **`typescriptSchema`** | Override field type generation with providing a JSON schema                                                                                                                 |
+
+_\* An asterisk denotes that a property is required._
+
+## Admin Options
+
+The customize the appearance and behavior of the Email Field in the [Admin Panel](../admin/overview), you can use the `admin` option:
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyEmailField: Field = {
+  // ...
+  admin: { // highlight-line
+    // ...
+  },
+}
+```
+
+The Email Field inherits all of the default options from the base [Field Admin Config](../admin/fields#admin-options), plus the following additional options:
+
+| Property                       | Description                                                                                                                            |
+| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
+| **`placeholder`**              | Set this property to define a placeholder string for the field.                                                                         |
+| **`autoComplete`**             | Set this property to a string that will be used for browser autocomplete.                                                               |
+
+## Example
+
+`collections/ExampleCollection.ts`
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const ExampleCollection: CollectionConfig = {
+  slug: 'example-collection',
+  fields: [
+    {
+      name: 'contact', // required
+      type: 'email', // required
+      label: 'Contact Email Address',
+      required: true,
+    },
+  ],
+}
+```

docs/fields/group.mdx

@@ -0,0 +1,110 @@
+---
+title: Group Field
+label: Group
+order: 90
+desc: The Group field allows other fields to be nested under a common property. Learn how to use Group fields, see examples and options.
+keywords: group, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+The Group Field allows [Fields](./overview) to be nested under a common property name. It also groups fields together visually in the [Admin Panel](../admin/overview).
+
+<LightDarkImage
+  srcLight="https://payloadcms.com/images/docs/fields/group.png"
+  srcDark="https://payloadcms.com/images/docs/fields/group-dark.png"
+  alt="Shows a Group field in the Payload Admin Panel"
+  caption="Admin Panel screenshot of a Group field"
+/>
+
+To add a Group Field, set the `type` to `group` in your [Field Config](./overview):
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyGroupField: Field = {
+  // ...
+  // highlight-start
+  type: 'group',
+  fields: [
+    // ...
+  ],
+  // highlight-end
+}
+```
+
+## Config Options
+
+| Option                 | Description                                                                                                                                                                                                                                                                        |
+| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*          | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                                                                                             |
+| **`fields`** \*        | Array of field types to nest within this Group.                                                                                                                                                                                                                                    |
+| **`label`**            | Used as a heading in the Admin Panel and to name the generated GraphQL type.                                                                                                                                                                                                       |
+| **`validate`**         | Provide a custom validation function that will be executed on both the Admin Panel and the backend. [More](/docs/fields/overview#validation)                                                                                                                                       |
+| **`saveToJWT`**        | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/overview), include its data in the user JWT.                                                                                                                                      |
+| **`hooks`**            | Provide Field Hooks to control logic for this field. [More details](../hooks/fields).                                                                                                                                                                         |
+| **`access`**           | Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields).                                                                                                                                                  |
+| **`hidden`**           | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin Panel.                                                                                                                                   |
+| **`defaultValue`**     | Provide an object of data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                                                                                  |
+| **`localized`**        | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this Group will be kept, so there is no need to specify each nested field as `localized`. |
+| **`admin`**            | Admin-specific configuration. [More details](#admin-options).                                                                                                                                                                                                          |
+| **`custom`**           | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                                                                                          |
+| **`interfaceName`**    | Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas).                                                                                                |
+| **`typescriptSchema`** | Override field type generation with providing a JSON schema                                                                                                                                                                                                                        |
+
+_\* An asterisk denotes that a property is required._
+
+## Admin Options
+
+The customize the appearance and behavior of the Group Field in the [Admin Panel](../admin/overview), you can use the `admin` option:
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyGroupField: Field = {
+  // ...
+  admin: { // highlight-line
+    // ...
+  },
+}
+```
+
+The Group Field inherits all of the default options from the base [Field Admin Config](../admin/fields#admin-options), plus the following additional options:
+
+| Option              | Description                                                                                                                                                                                                                   |
+| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`hideGutter`**    | Set this property to `true` to hide this field's gutter within the Admin Panel. The field gutter is rendered as a vertical line and padding, but often if this field is nested within a Group, Block, or Array, you may want to hide the gutter. |
+
+## Example
+
+`collections/ExampleCollection.ts`
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const ExampleCollection: CollectionConfig = {
+  slug: 'example-collection',
+  fields: [
+    {
+      name: 'pageMeta', // required
+      type: 'group', // required
+      interfaceName: 'Meta', // optional
+      fields: [
+        // required
+        {
+          name: 'title',
+          type: 'text',
+          required: true,
+          minLength: 20,
+          maxLength: 100,
+        },
+        {
+          name: 'description',
+          type: 'textarea',
+          required: true,
+          minLength: 40,
+          maxLength: 160,
+        },
+      ],
+    },
+  ],
+}
+```

docs/fields/json.mdx

@@ -0,0 +1,155 @@
+---
+title: JSON Field
+label: JSON
+order: 50
+desc: The JSON field type will store any string in the Database. Learn how to use JSON fields, see examples and options.
+
+keywords: json, jsonSchema, schema, validation, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+The JSON Field saves actual JSON in the database, which differs from the Code field that saves the value as a string in the database.
+
+<LightDarkImage
+  srcLight="https://payloadcms.com/images/docs/fields/json.png"
+  srcDark="https://payloadcms.com/images/docs/fields/json-dark.png"
+  alt="Shows a JSON field in the Payload Admin Panel"
+  caption="This field is using the `monaco-react` editor syntax highlighting."
+/>
+
+To add a JSON Field, set the `type` to `json` in your [Field Config](./overview):
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyJSONField: Field = {
+  // ...
+  type: 'json', // highlight-line
+}
+```
+
+## Config Options
+
+| Option                 | Description                                                                                                                                                                 |
+| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*          | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
+| **`label`**            | Text used as a field label in the Admin Panel or an object with keys for each language.                                                                                     |
+| **`unique`**           | Enforce that each entry in the Collection has a unique value for this field.                                                                                                |
+| **`index`**            | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
+| **`validate`**         | Provide a custom validation function that will be executed on both the Admin Panel and the backend. [More](/docs/fields/overview#validation)                                |
+| **`jsonSchema`**       | Provide a JSON schema that will be used for validation. [JSON schemas](https://json-schema.org/learn/getting-started-step-by-step)                                          |
+| **`saveToJWT`**        | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/overview), include its data in the user JWT.                               |
+| **`hooks`**            | Provide Field Hooks to control logic for this field. [More details](../hooks/fields).                                                                                                                                                                         |
+| **`access`**           | Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields).                                                                                                                                                  |
+| **`hidden`**           | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin Panel.                            |
+| **`defaultValue`**     | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                        |
+| **`localized`**        | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
+| **`required`**         | Require this field to have a value.                                                                                                                                         |
+| **`admin`**            | Admin-specific configuration. [More details](#admin-options).                                                                                                   |
+| **`custom`**           | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
+| **`typescriptSchema`** | Override field type generation with providing a JSON schema                                                                                                                 |
+
+_\* An asterisk denotes that a property is required._
+
+## Admin Options
+
+The customize the appearance and behavior of the JSON Field in the [Admin Panel](../admin/overview), you can use the `admin` option:
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyJSONField: Field = {
+  // ...
+  admin: { // highlight-line
+    // ...
+  },
+}
+```
+
+The JSON Field inherits all of the default options from the base [Field Admin Config](../admin/fields#admin-options), plus the following additional options:
+
+| Option              | Description                                                                                                                                                   |
+| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`editorOptions`** | Options that can be passed to the monaco editor, [view the full list](https://microsoft.github.io/monaco-editor/typedoc/variables/editor.EditorOptions.html). |
+
+## Example
+
+`collections/ExampleCollection.ts`
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const ExampleCollection: CollectionConfig = {
+  slug: 'example-collection',
+  fields: [
+    {
+      name: 'customerJSON', // required
+      type: 'json', // required
+      required: true,
+    },
+  ],
+}
+```
+## JSON Schema Validation
+
+Payload JSON fields fully support the [JSON schema](https://json-schema.org/) standard. By providing a schema in your field config, the editor will be guided in the admin UI, getting typeahead for properties and their formats automatically. When the document is saved, the default validation will prevent saving any invalid data in the field according to the schema in your config.
+
+If you only provide a URL to a schema, Payload will fetch the desired schema if it is publicly available. If not, it is recommended to add the schema directly to your config or import it from another file so that it can be implemented consistently in your project.
+
+
+### Local JSON Schema
+
+`collections/ExampleCollection.ts`
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const ExampleCollection: CollectionConfig = {
+  slug: 'example-collection',
+  fields: [
+    {
+      name: 'customerJSON', // required
+      type: 'json', // required
+      jsonSchema: {
+        uri: 'a://b/foo.json', // required
+        fileMatch: ['a://b/foo.json'], // required
+        schema: {
+          type: 'object',
+          properties: {
+            foo: {
+              enum: ['bar', 'foobar'],
+            }
+          },
+        },
+      },
+
+    },
+  ],
+}
+// {"foo": "bar"} or {"foo": "foobar"} - ok
+// Attempting to create {"foo": "not-bar"} will throw an error
+```
+
+### Remote JSON Schema
+
+`collections/ExampleCollection.ts`
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const ExampleCollection: CollectionConfig = {
+  slug: 'example-collection',
+  fields: [
+    {
+      name: 'customerJSON', // required
+      type: 'json', // required
+      jsonSchema: {
+        uri: 'https://example.com/customer.schema.json', // required
+        fileMatch: ['https://example.com/customer.schema.json'], // required
+      },
+    },
+  ],
+}
+// If 'https://example.com/customer.schema.json' has a JSON schema
+// {"foo": "bar"} or {"foo": "foobar"} - ok
+// Attempting to create {"foo": "not-bar"} will throw an error
+```

docs/fields/number.mdx

@@ -0,0 +1,99 @@
+---
+title: Number Field
+label: Number
+order: 100
+desc: Number fields store and validate numeric data. Learn how to use and format Number fields, see examples and Number field options.
+keywords: number, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+The Number Field stores and validates numeric entry and supports additional numerical validation and formatting features.
+
+<LightDarkImage
+  srcLight="https://payloadcms.com/images/docs/fields/number.png"
+  srcDark="https://payloadcms.com/images/docs/fields/number-dark.png"
+  alt="Shows a Number field in the Payload Admin Panel"
+  caption="Admin Panel screenshot of a Number field"
+/>
+
+To add a Number Field, set the `type` to `number` in your [Field Config](./overview):
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyNumberField: Field = {
+  // ...
+  type: 'number', // highlight-line
+}
+```
+
+## Config Options
+
+| Option                 | Description                                                                                                                                                                 |
+| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*          | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
+| **`label`**            | Text used as a field label in the Admin Panel or an object with keys for each language.                                                                                     |
+| **`min`**              | Minimum value accepted. Used in the default `validation` function.                                                                                                          |
+| **`max`**              | Maximum value accepted. Used in the default `validation` function.                                                                                                          |
+| **`hasMany`**          | Makes this field an ordered array of numbers instead of just a single number.                                                                                               |
+| **`minRows`**          | Minimum number of numbers in the numbers array, if `hasMany` is set to true.                                                                                                |
+| **`maxRows`**          | Maximum number of numbers in the numbers array, if `hasMany` is set to true.                                                                                                |
+| **`unique`**           | Enforce that each entry in the Collection has a unique value for this field.                                                                                                |
+| **`index`**            | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
+| **`validate`**         | Provide a custom validation function that will be executed on both the Admin Panel and the backend. [More](/docs/fields/overview#validation)                                |
+| **`saveToJWT`**        | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/overview), include its data in the user JWT.                               |
+| **`hooks`**            | Provide Field Hooks to control logic for this field. [More details](../hooks/fields).                                                                                                                                                                         |
+| **`access`**           | Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields).                                                                                                                                                  |
+| **`hidden`**           | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin Panel.                            |
+| **`defaultValue`**     | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                        |
+| **`localized`**        | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
+| **`required`**         | Require this field to have a value.                                                                                                                                         |
+| **`admin`**            | Admin-specific configuration. [More details](#admin-options).                                                                                                   |
+| **`custom`**           | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
+| **`typescriptSchema`** | Override field type generation with providing a JSON schema                                                                                                                 |
+
+_\* An asterisk denotes that a property is required._
+
+## Admin Options
+
+The customize the appearance and behavior of the Number Field in the [Admin Panel](../admin/overview), you can use the `admin` option:
+
+```ts
+import type { Field } from 'payload/types'
+
+export const MyNumberField: Field = {
+  // ...
+  admin: { // highlight-line
+    // ...
+  },
+}
+```
+
+The Number Field inherits all of the default options from the base [Field Admin Config](../admin/fields#admin-options), plus the following additional options:
+
+| Property                       | Description                                                                                                                            |
+| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
+| **`step`**                     | Set a value for the number field to increment / decrement using browser controls.                                                      |
+| **`placeholder`**              | Set this property to define a placeholder string for the field.                                                                       |
+| **`autoComplete`**             | Set this property to a string that will be used for browser autocomplete.                                                             |
+
+## Example
+
+`collections/ExampleCollection.ts`
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const ExampleCollection: CollectionConfig = {
+  slug: 'example-collection',
+  fields: [
+    {
+      name: 'age', // required
+      type: 'number', // required
+      required: true,
+      admin: {
+        step: 1,
+      },
+    },
+  ],
+}
+```

docs/fields/overview.mdx

@@ -0,0 +1,390 @@
+---
+title: Fields Overview
+label: Overview
+order: 10
+desc: Fields are the building blocks of Payload, find out how to add or remove a field, change field type, add hooks, define Access Control and Validation.
+keywords: overview, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+Fields are the building blocks of Payload. They define the schema of the Documents that will be stored in the [Database](../database/overview), as well as automatically generate the corresponding UI within the [Admin Panel](../admin/overview).
+
+There are many [Field Types](#field-types) to choose from, ranging anywhere from simple text strings to nested arrays and blocks. Most fields save data to the database, while others are strictly presentational. Fields can have [Custom Validations](#validation), [Conditional Logic](../admin/fields#conditional-logic), [Access Control](#field-level-access-control), [Hooks](#field-level-hooks), and so much more.
+
+To configure fields, use the `fields` property in your [Collection](../configuration/collections) or [Global](../configuration/globals) config:
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const Page: CollectionConfig = {
+  // ...
+  fields: [ // highlight-line
+    // ...
+  ]
+}
+```
+
+<Banner type="success">
+  You can fully customize the appearance and behavior of all fields within the Admin Panel. [More details](../admin/fields).
+</Banner>
+
+## Field Types
+
+Payload provides a wide variety of built-in Field Types, each with its own unique properties and behaviors that determine which values it can accept, how it is presented in the API, and how it will be rendered in the [Admin Panel](../admin/overview).
+
+To configure fields, use the `fields` property in your [Collection](../configuration/collections) or [Global](../configuration/globals) config:
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const Page: CollectionConfig = {
+  slug: 'pages',
+  // highlight-start
+  fields: [
+    {
+      name: 'field',
+      type: 'text',
+    }
+  ]
+  // highlight-end
+}
+```
+
+<Banner type="warning">
+  <strong>Reminder:</strong>
+  Each field is an object with at least the `type` property. This matches the field to its corresponding Field Type. [More details](#field-options).
+</Banner>
+
+There are two main categories of fields in Payload:
+
+- [Data Fields](#data-fields)
+- [Presentational Fields](#presentational-fields)
+
+To begin writing fields, first determine which [Field Type](#field-types) best supports your application. Then to author your field accordingly using the [Field Options](#field-options) for your chosen field type.
+
+### Data Fields
+
+Data Fields are used to store data in the [Database](../database/overview). All Data Fields have a `name` property. This is the key that will be used to store the field's value.
+
+Here are the available Data Fields:
+
+- [Array](./array) - for repeating content, supports nested fields
+- [Blocks](./blocks) - for block-based content, supports nested fields
+- [Checkbox](./checkbox) - saves boolean true / false values
+- [Code](./code) - renders a code editor interface that saves a string
+- [Date](./date) - renders a date picker and saves a timestamp
+- [Email](./email) - ensures the value is a properly formatted email address
+- [Group](./group) - nests fields within a keyed object
+- [JSON](./json) - renders a JSON editor interface that saves a JSON object
+- [Number](./number) - saves numeric values
+- [Point](./point) - for location data, saves geometric coordinates
+- [Radio](./radio) - renders a radio button group that allows only one value to be selected
+- [Relationship](./relationship) - assign relationships to other collections
+- [Rich Text](./rich-text) - renders a fully extensible rich text editor
+- [Select](./select) - renders a dropdown / picklist style value selector
+- [Tabs (Named)](./tabs) - similar to group, but renders nested fields within a tabbed layout
+- [Text](./text) - simple text input that saves a string
+- [Textarea](./textarea) - similar to text, but allows for multi-line input
+- [Upload](./upload) - allows local file and image upload
+
+### Presentational Fields
+
+Presentational Fields do not store data in the database. Instead, they are used to organize and present other fields in the [Admin Panel](../admin/overview), or to add custom UI components.
+
+Here are the available Presentational Fields:
+
+- [Collapsible](/docs/fields/collapsible) - nests fields within a collapsible component
+- [Row](/docs/fields/row) - aligns fields horizontally
+- [Tabs (Unnamed)](/docs/fields/tabs) - nests fields within a tabbed layout
+- [UI](/docs/fields/ui) - blank field for custom UI components
+
+<Banner type="warning">
+  <strong>Tip:</strong>
+  Don't see a Field Type that fits your needs? You can build your own using a [Custom Field Component](../admin/fields#the-field-component).
+</Banner>
+
+## Field Options
+
+All fields require at least the `type` property. This matches the field to its corresponding [Field Type](#field-types) to determine its appearance and behavior within the [Admin Panel](../admin/overview). Each Field Type has its own unique set of options based on its own type.
+
+To set a field's type, use the `type` property in your Field Config:
+
+```ts
+import type { Field } from 'payload'
+
+export const MyField: Field = {
+  type: 'text', // highlight-line
+  name: 'myField',
+}
+```
+
+<Banner type="warning">
+  For a full list of configuration options, see the documentation for each [Field Type](#field-types).
+</Banner>
+
+### Field Names
+
+All [Data Fields](#data-fields) require a `name` property. This is the key that will be used to store and retrieve the field's value in the database. This property must be unique within the Collection, Global, or nested group that it is defined in.
+
+To set a field's name, use the `name` property in your Field Config:
+
+```ts
+import type { Field } from 'payload'
+
+export const MyField: Field = {
+  type: 'text',
+  name: 'myField', // highlight-line
+}
+```
+
+Payload reserves various field names for internal use. Using reserved field names will result in your field being sanitized from the config.
+
+The following field names are forbidden and cannot be used:
+
+  - `__v`
+  - `salt`
+  - `hash`
+  - `file`
+
+### Field-level Hooks
+
+In addition to being able to define [Hooks](../hooks/overview) on a document-level, you can define extremely granular logic field-by-field.
+
+To define Field-level Hooks, use the `hooks` property in your Field Config:
+
+```ts
+import type { Field } from 'payload'
+
+export const MyField: Field = {
+  type: 'text',
+  name: 'myField',
+  // highlight-start
+  hooks: {
+    // ...
+  }
+  // highlight-end
+}
+```
+
+For full details on Field-level Hooks, see the [Field Hooks](../hooks/fields) documentation.
+
+### Field-level Access Control
+
+In addition to being able to define [Access Control](../access-control/overview) on a document-level, you can define extremely granular permissions field-by-field.
+
+To define Field-level Access Control, use the `access` property in your Field Config:
+
+```ts
+import type { Field } from 'payload'
+
+export const MyField: Field = {
+  type: 'text',
+  name: 'myField',
+  // highlight-start
+  access: {
+    // ...
+  }
+  // highlight-end
+}
+```
+
+For full details on Field-level Access Control, see the [Field Access Control](../access-control/fields) documentation.
+
+### Default Values
+
+Fields can be optionally prefilled with initial values. This is used in both the [Admin Panel](../admin/overview) as well as API requests to populate missing or undefined field values during the `create` or `update` operations.
+
+To set a field's default value, use the `defaultValue` property in your Field Config:
+
+```ts
+import type { Field } from 'payload'
+
+export const MyField: Field = {
+  type: 'text',
+  name: 'myField',
+  defaultValue: 'Hello, World!', // highlight-line
+}
+```
+
+Default values can be defined as a static value or a function that returns a value. When a `defaultValue` is defined statically, Payload's DB adapters will apply it to the database schema or models.
+
+Functions can be written to make use of the following argument properties:
+
+- `user` - the authenticated user object
+- `locale` - the currently selected locale string
+
+Here is an example of a `defaultValue` function:
+
+```ts
+import type { Field } from 'payload'
+
+const translation: {
+  en: 'Written by'
+  es: 'Escrito por'
+}
+
+export const myField: Field = {
+  name: 'attribution',
+  type: 'text',
+  // highlight-start
+  defaultValue: ({ user, locale }) =>
+    `${translation[locale]} ${user.name}`,
+  // highlight-end
+}
+```
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  You can use async `defaultValue` functions to fill fields with data from API requests.
+</Banner>
+
+### Validation
+
+Fields are automatically validated based on their [Field Type](#field-types) and other [Field Options](#field-options) such as `required` or `min` and `max` value constraints. If needed, however, field validations can be customized or entirely replaced by providing your own custom validation functions.
+
+To set a custom field validation function, use the `validate` property in your Field Config:
+
+```ts
+import type { Field } from 'payload'
+
+export const MyField: Field = {
+  type: 'text',
+  name: 'myField',
+  validate: value => Boolean(value) || 'This field is required' // highlight-line
+}
+```
+
+Custom validation functions should return either `true` or a `string` representing the error message to display in API responses.
+
+The following arguments are provided to the `validate` function:
+
+| Argument | Description                                                                                   |
+| -------- | --------------------------------------------------------------------------------------------- |
+| `value`  | The value of the field being validated.                                                        |
+| `ctx`   | An object with additional data and context. [More details](#validation-context) |
+
+#### Validation Context
+
+The `ctx` argument contains full document data, sibling field data, the current operation, and other useful information such as currently authenticated in user:
+
+```ts
+import type { Field } from 'payload'
+
+export const MyField: Field = {
+  type: 'text',
+  name: 'myField',
+  // highlight-start
+  validate: (val, { user }) =>
+    Boolean(user) || 'You must be logged in to save this field',
+  // highlight-end
+}
+```
+
+The following additional properties are provided in the `ctx` object:
+
+| Property      | Description                                                                                                              |
+| ------------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `data`        | An object containing the full collection or global document currently being edited.                                       |
+| `siblingData` | An object containing document data that is scoped to only fields within the same parent of this field.                    |
+| `operation`   | Will be `create` or `update` depending on the UI action or API call.                                                      |
+| `id`          | The `id` of the current document being edited. `id` is `undefined` during the `create` operation.                         |
+| `req`        | The current HTTP request object. Contains `payload`, `user`, etc. |
+
+#### Reusing Default Field Validations
+
+When using custom validation functions, Payload will use yours in place of the default. However, you might want to simply augment the default validation with your own custom logic.
+
+To reuse default field validations, call them from within your custom validation function:
+
+```ts
+import { text } from 'payload/shared'
+
+const field: Field = {
+  name: 'notBad',
+  type: 'text',
+  validate: (val, args) => {
+    if (val === 'bad') return 'This cannot be "bad"'
+    return text(val, args) // highlight-line
+  },
+}
+```
+
+#### Async Field Validations
+
+Custom validation functions can also be asynchronous depending on your needs. This makes it possible to make requests to external services or perform other miscellaneous asynchronous logic.
+
+To write asynchronous validation functions, use the `async` keyword to define your function:
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const Orders: CollectionConfig = {
+  slug: 'orders',
+  fields: [
+    {
+      name: 'customerNumber',
+      type: 'text',
+      // highlight-start
+      validate: async (val, { operation }) => {
+        if (operation !== 'create') return true
+        const response = await fetch(`https://your-api.com/customers/${val}`)
+        if (response.ok) return true
+        return 'The customer number provided does not match any customers within our records.'
+      },
+      // highlight-end
+    },
+  ],
+}
+```
+
+### Admin Options
+
+In addition to each field's base configuration, you can use the `admin` key to specify traits and properties for fields that will only effect how they are _rendered_ within the [Admin Panel](../admin/overview), such as their appearance or behavior.
+
+```ts
+import type { Field } from 'payload'
+
+export const MyField: Field = {
+  type: 'text',
+  name: 'myField',
+  admin: { // highlight-line
+    // ...
+  }
+}
+```
+
+For full details on Admin Options, see the [Field Admin Options](../admin/fields) documentation.
+
+## Custom ID Fields
+
+All [Collections](../configuration/collections) automatically generate their own ID field. If needed, you can override this behavior by providing an explicit ID field to your config. This will force users to provide a their own ID value when creating a record.
+
+To define a custom ID field, add a new field with the `name` property set to `id`:
+
+```ts
+import type { CollectionConfig } from 'payload'
+
+export const MyCollection: CollectionConfig = {
+  // ...
+  fields: [
+    {
+      name: 'id', // highlight-line
+      type: 'number',
+    },
+  ],
+}
+```
+
+<Banner type="warning">
+  <strong>Reminder:</strong>
+  The Custom ID Fields can only be of type [`Number`](./number) or [`Text`](./text).
+
+  Custom ID fields with type `text` must not contain `/` or `.` characters.
+</Banner>
+
+## TypeScript
+
+You can import the Payload `Field` type as well as other common types from the `payload` package. [More details](../typescript/overview).
+
+```ts
+import type { Field } from 'payload'
+```