Collection Configs

A Collection is a group of records, called Documents, that all share a common schema. Each Document in a Collection is stored in the Database based on the fields that you define, and automatically generates a Local API, REST API, and GraphQL API used to manage your Documents. Collections can also enable Authentication, Uploads, and more. To define a Collection Config, use the collections property in your FrogBot Config:

import { buildConfig } from 'frogbot'
import { Users } from './collections/Users'
import { Projects } from './collections/Projects'
import { Files } from './collections/Files'
import { Chats } from './collections/Chats'
import { Messages } from './collections/Messages'

export default buildConfig({
  collections: [Users, Projects, Files, Chats, Messages],
})

FrogBot does not support Globals. Model singleton content as a Collection and enforce the single-document constraint in your application.

Organize collection files

Give each collection its own TitleCase file with a named export, such as export const Posts in src/collections/Posts.ts, and import it into your config by its own path. Adding a collection means creating its file and adding it to collections; there is no index.ts to update. When a collection gains hooks, access rules, or endpoints, turn its file into a folder with the same name:

src/
├── collections/
│   ├── Posts.ts
│   └── Users/
│       ├── access/
│       │   └── isAdminOrSelf.ts
│       ├── endpoints/
│       │   └── exportUsers.ts
│       ├── hooks/
│       │   └── setLastLogin.ts
│       └── index.ts
└── frogbot.config.ts

Move Users.ts to Users/index.ts, then put its helpers in subfolders beside it. import { Users } from './collections/Users' resolves to either form, so the config doesn’t change. Move the file rather than copying it. If Users.ts and Users/index.ts both exist, ./collections/Users resolves to Users.ts and the folder is ignored. Match the casing of each import to its file name. ./collections/users finds Users.ts on macOS but fails with “Cannot find module” on Linux, for example in Docker or a deployment.

FrogBot collection model

Collections you configure remain ordinary FrogBot collections. Agents need chat and message stores, and pieces that create files need a files collection. You can adopt those roles into collections you own; FrogBot adds a files collection only when you mark one with file: true.

Role markers

FrogBot identifies managed collections by role, not by a required slug. Mark a collection with chat: true, message: true, or file: true; FrogBot keeps its slug and merges in the required configuration.

import type { CollectionConfig } from 'frogbot'

export const Conversations: CollectionConfig = {
  slug: 'conversations',
  chat: true,
  fields: [{ name: 'channel', type: 'text' }]
}

export const Turns: CollectionConfig = {
  slug: 'turns',
  message: true,
  fields: []
}

Mark at most one collection per role. With no marker, agents cause FrogBot to inject defaults at chats and messages. An unmarked collection already using either default slug causes a configuration error rather than implicit adoption.

Field contribution per role

Your compatible field, access, admin, and option values win during the merge. Missing base fields are appended and hooks are combined.

Role marker	FrogBot contributes
`chat: true`	`title`, owner `user` relationship, agent slug, and `lastMessageAt`
`message: true`	Text `id`, chat relationship, role, `UIMessage.parts`, metadata, and usage
`file: true`	Uploads, folders, soft deletion, admin defaults, and authenticated access

FrogBot rejects incompatible base field types. chats.user and messages.id, messages.chat, and messages.parts are reserved and cannot be redefined.

Default collections

The default collections use soft deletion, appear under Collections in the admin panel, and scope access to the authenticated chat owner. The message ID is the AI SDK UI message ID, allowing an interrupted assistant message to be continued in place across database adapters. The chat’s user relationship resolves as follows:

No auth collection: FrogBot’s default users collection.
One auth collection: that collection, regardless of slug.
Multiple auth collections: the collection selected by admin.user.

See Chat persistence for request behavior and durability guarantees.

Collection config options

The following options are available on any CollectionConfig. FrogBot adds chat, message, and file to the built-in set; every other option below is part of the FrogBot configuration API. Configure connections in the root config. It’s best practice to write Collections in separate files and import them into the root config. Here is a minimal example:

import type { CollectionConfig } from 'frogbot'

export const Posts: CollectionConfig = {
  slug: 'posts',
  fields: [
    {
      name: 'title',
      type: 'text',
    },
  ],
}

Reminder: For more complex examples, see the Templates and Examples directories in the FrogBot repository.

The following options are available:

Option	Type	Default	Description
`slug`	`string`	Required	Unique, URL-friendly identifier for the collection. `agents` is reserved.
`fields`	`Field[]`	Required	Fields that make up each document. More details.
`chat`	`boolean`	`false`	FrogBot — adopts this collection as the chat store. At most one collection may be marked. More details.
`message`	`boolean`	`false`	FrogBot — adopts this collection as the message store. At most one collection may be marked. More details.
`file`	`boolean`	`false`	FrogBot — adopts this collection as the files store. At most one collection may be marked. More details.
`usageLog`	`boolean`	`false`	FrogBot — adopts this collection as the AI usage log when `ai` is configured. At most one collection may be marked. Without a marker, FrogBot adds a `usage-logs` collection.
`admin`	`CollectionAdminConfig`	—	Admin panel options. More details.
`access`	`CollectionAccess`	Signed-in users only	Access control functions for each operation. More details.
`authorship`	`boolean \| { createdBy?: boolean; updatedBy?: boolean }`	`true`	Records the user who created and last updated each document in `createdBy` and `updatedBy`. `false` turns both off; an object turns each off. More details.
`auth`	`boolean \| AuthConfig`	`false`	Set to `true` for default authentication or pass an auth config object. Use `signIn` to add OAuth login methods. More details.
`custom`	`Record<string, any>`	`{}`	Extension point for your own data, such as plugin settings. Server only.
`dbName`	`string \| (({ tableName }) => string)`	Derived from `slug`	Table or collection name in the database. Changing it on existing data needs a migration.
`defaultPopulate`	`SelectType`	—	Fields selected when this collection is populated from another document. More details.
`defaultSort`	`Sort`	—	Sort used by `find` and bulk `update` when the request doesn’t set `sort`. Prefix a field with `-` for descending order.
`disableBulkDelete`	`boolean`	`false`	Disables bulk delete in the admin panel and the REST API.
`disableBulkEdit`	`boolean`	`false`	Disables bulk edit in the admin panel and the REST API.
`disableDuplicate`	`boolean`	`false`	Hides the Duplicate button and makes `duplicate` fail in every API.
`enableQueryPresets`	`boolean`	`false`	Lets users save and share list filters, columns, and sorts for this collection. Configure access with the root `queryPresets`.
`endpoints`	`Endpoint[]`	—	Custom REST routes under this collection’s path. More details.
`hierarchy`	`boolean \| HierarchyConfig`	`false`	Makes records nest under each other, with parent fields and generated paths. `folders` and `tags` are presets of it.
`tags`	`boolean \| TagsConfig`	`false`	Makes this collection a tag tree that other collections link to with `createTagField({ relationTo })`. Can’t be combined with `folders` or `hierarchy`.
`folders`	`boolean \| FoldersConfig`	`false`	Makes this collection a folder tree: each record can sit inside another. Other collections file records into it with `createFolderField({ relationTo })`. See Folders.
`select`	`({ operation, req, select }) => SelectType \| undefined`	—	Returns the `select` every read uses, replacing the caller’s. Use it for fields that hooks or access control read. More details.
`graphQL`	`false \| CollectionGraphQL`	—	GraphQL names, or `false` to leave this collection out of the schema. More details.
`hooks`	`CollectionHooks`	—	Lifecycle hooks. More details.
`indexes`	`CompoundIndex[]`	`[]`	Compound indexes on two or more fields, to speed up queries or enforce uniqueness. More details.
`labels`	`{ singular?: string \| LabelFunction; plural?: string \| LabelFunction }`	Derived from `slug`	Labels used for this collection throughout FrogBot. Each can be a string, a localized object, or a function.
`lockDocuments`	`false \| { duration: number }`	Enabled, `300` seconds	Locks a document while someone edits it. `duration` sets how long, in seconds, a lock lasts without activity. `false` turns locking off.
`orderable`	`boolean`	`false`	Lets documents be reordered by drag and drop. More details.
`search`	`Record<string, SearchIndexConfig>`	—	Named search indexes over this collection. More details.
`timestamps`	`boolean`	`true`	Adds `createdAt` and `updatedAt`. Set `false` to leave them out.
`trash`	`boolean`	`false`	Turns on soft deletes. More details.
`typescript`	`{ interface?: string }`	Derived from `slug`	Name of the generated TypeScript interface.
`upload`	`boolean \| UploadConfig`	`false`	Turns on file uploads. More details.
`llmInstructions`	`string`	—	Read-only Markdown instructions for agents. MCP clients get them in this collection’s `getCollectionSchema` result through `@frogbotai/plugin-mcp`; FrogBot agents don’t, so pass them on in your own tool’s description if an agent needs them. Editors can add their own in the admin’s Edit agent instructions.
`versions`	`boolean \| VersionsConfig`	`true`, or `false` with `auth`	Keeps a version history of each document; pass an object with `drafts` to add drafts. Collections with `auth` default to `false`, since a version would copy password hashes and sessions. More details.
`_sanitized`	`boolean`	—	Internal. Set during sanitization; don’t set it yourself.

Fields

Fields define the schema of the Documents within a Collection.

Access Control

Collection Access Control determines what a user can and cannot do with any given Document within a Collection. To learn more, go to the Access Control documentation.

Hooks

Collection Hooks 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 documentation.

Orderable

When orderable is enabled, FrogBot uses fractional indexing to efficiently manage document order. When enabled on collections, this allows you to manually drag and drop documents in the Admin Panel to reorder them, as well as programmatically set the order of documents via the Local API, REST API, or GraphQL API. Orderable can also be added to join fields.

Admin Options

The behavior of Collections within the Admin Panel can be customized to fit the needs of your application. This includes grouping or hiding their navigation links, adding custom 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:

import type { CollectionConfig } from 'frogbot'

export const MyCollection: CollectionConfig = {
  // ...
  admin: {
    // ...
  },
}

The following options are available:

Option	Type	Default	Description
`components`	`CollectionAdminComponents`	—	Swap in your own React components for this collection. More details.
`custom`	`Record<string, any>`	`{}`	Your own data, sent to the admin panel’s client config.
`description`	`string \| Record<string, string> \| (({ t }) => string)`	—	Text shown below the collection label in the List View and on the document edit page. It’s also used as the JSDoc comment on the generated type. Use `components.Description` to render a component instead.
`disableCopyToLocale`	`boolean`	`false`	Hides the Copy to Locale button in the Edit View. Only applies when localization is on.
`enableRichTextLink`	`boolean`	`true`	Lets Rich Text links point to documents in this collection.
`enableRichTextRelationship`	`boolean`	`true`	Lets Rich Text relationship blocks reference documents in this collection.
`formatDocURL`	`(args) => string \| null`	Default edit URL	Customizes document links in the List View. More details.
`group`	`string \| Record<string, string> \| false \| null`	Collections group	Text or localized object used to group the navigation link. `null` makes it a top-level link; `false` hides the link but keeps its routes.
`hidden`	`boolean \| (({ user }) => boolean)`	`false`	Leaves this collection out of navigation and admin routes. A function receives the current user.
`icon`	`AdminIcon`	`'people'` for auth collections	Built-in kebab-case icon name or component path for the navigation link. See Collection icons.
`livePreview`	`LivePreviewConfig`	—	Live Preview for this collection. See Live Preview.
`meta`	`MetaConfig`	—	Page metadata for this collection’s admin pages.
`preview`	`(doc, { locale, req, token }) => string \| null \| Promise<string \| null>`	—	Builds a preview URL that points to your app. `req` is a `FrogBotRequest` with `req.frogbot`.
`useAsThumbnail`	`string`	The first upload field	Top-level upload field used as the document thumbnail in grid views and the Recents and Pinned dashboard widgets. A document icon shows when there’s none.
`useAsTitle`	`string`	`'id'`	Top-level field used as the document title throughout the admin panel.
`views`	`CollectionView[]`	One list view	Collection views, such as list, board, calendar, and custom layouts. More details.

Note: If you set useAsTitle to a relationship or join field, it will use only the ID of the related document(s) as the title. To display a specific field (i.e. title) from the related document instead, create a virtual field that extracts the desired data, and set useAsTitle to that virtual field.

Collection Views

admin.views accepts CollectionView[]. CollectionView is the exported union ListView | BoardView | CalendarView | CustomView. The array order controls the switcher and first-view fallback. A collection can have at most one list view, and it must be first. Omit views to use one default list view without a switcher.

import type { CollectionConfig } from 'frogbot'

export const Projects: CollectionConfig = {
  slug: 'projects',
  admin: {
    views: [
      {
        type: 'list',
        slug: 'active',
        label: 'Active',
        defaultFields: ['title', 'status'],
        filter: { archived: { equals: false } },
        components: {
          beforeTable: ['/components/ProjectSummary#ProjectSummary'],
        },
      },
      {
        type: 'custom',
        slug: 'report',
        label: 'Report',
        component: '/components/ProjectReport#ProjectReport',
      },
    ],
  },
  fields: [],
}

Shared view properties

Property	Type	Required / default	Behavior
`slug`	`string`	No; defaults to `type`	Unique route and saved-preference key after normalization to lowercase kebab case. Duplicate or empty normalized slugs produce a configuration error. The first view uses the collection’s root route.
`label`	`string`	No; defaults to the capitalized `type`	Label displayed in the view switcher.
`defaultFields`	`string[]`	No	Ordered field dot paths initially displayed as list columns or board card fields. Users can change list columns through normal list controls.
`filter`	`Where \| ({ req }) => Where \| Promise<Where>`	No	Invisible base filter applied to the view. The function receives the current `FrogBotRequest`.
`defaultSort`	`Sort` (`string \| string[]`)	No	Initial field sort or ordered list of sorts. Prefix a field with `-` for descending order.
`searchableFields`	`string[]`	No	Adds field dot paths to the normal search behavior. The collection’s `useAsTitle` field remains included; this option does not replace it.
`pagination`	`ViewPagination`	No	Configures query limits. Defaults depend on the view type.
`access`	`({ req }) => boolean \| Promise<boolean>`	No; defaults to collection access	Controls whether the current user can open the view. It does not replace collection operation access.
`components`	View-specific components	No	Supplies shared shell slots and slots for the selected view type.

ViewPagination

Property	Type	Required / default	Behavior
`defaultLimit`	`number`	No; list uses FrogBot list defaults, board defaults to `50`	List documents per page or board documents fetched per column. Board columns lazy-load additional pages and virtualize rendered cards.
`limits`	`number[]`	No; list uses FrogBot list defaults	Page-size choices shown by list controls. This property does not change board loading or display controls.

ViewComponents

These shell slots are shared by list, board, calendar, and custom views. Each value uses a FrogBotComponent import path; array slots render in declaration order.

Property	Type	Required / default	Behavior
`actions`	`FrogBotComponent[]`	No; `[]`	Renders in the page header, top right, on every view type.
`toolbar`	`FrogBotComponent[]`	No; `[]`	Renders in the list controls toolbar, before Filters, on every view type. Below the small breakpoint it moves beside the row-selection controls (list) or into a row under the toolbar (board, calendar). On a list that has no rows, small screens don’t show it. Not shown in relationship drawers.
`menuItems`	`FrogBotComponent[]`	No; `[]`	Adds entries to the view menu.
`beforeView`	`FrogBotComponent[]`	No; `[]`	Renders inside the collection shell before the view body.
`afterView`	`FrogBotComponent[]`	No; `[]`	Renders inside the collection shell after the view body.

ListView

Property	Type	Required / default	Behavior
`type`	`'list'`	Yes	Selects the table-based list view.
`components`	`ViewComponents & ListViewComponents`	No	Adds shared shell slots and list table slots.

ListView components

Property	Type	Required / default	Behavior
`beforeTable`	`FrogBotComponent[]`	No; `[]`	Renders after list controls and immediately before the table.
`afterTable`	`FrogBotComponent[]`	No; `[]`	Renders immediately after the table.
`NoResults`	`FrogBotComponent`	No; built-in empty state	Replaces the empty state. Not shown in relationship drawers.

BoardView

Property	Type	Required / default	Behavior
`type`	`'board'`	Yes	Selects the column-based board view.
`groupBy`	`string`	No	Dot path to the select or single relationship field used for columns. Documents without a value appear in Uncategorized.
`cover`	`string`	No	Dot path to an upload field rendered as each card’s cover image.
`components`	`ViewComponents & BoardComponents`	No	Adds shared shell slots and board-specific components.

Board components

Property	Type	Required / default	Behavior
`beforeColumns`	`FrogBotComponent[]`	No; `[]`	Renders before the board columns.
`afterColumns`	`FrogBotComponent[]`	No; `[]`	Renders after the board columns.
`ColumnHeader`	`FrogBotComponent`	No; built-in header	Replaces each column header. See Column headers for its props.
`Card`	`FrogBotComponent`	No; built-in card	Replaces each board card and receives the document as its `row` prop.

See Collection board for grouping, loading, and drag behavior.

CalendarView

Property	Type	Required / default	Behavior
`type`	`'calendar'`	Yes	Selects the date-based calendar view.
`start`	`string`	Yes	Dot path to the date field used as each event’s start.
`end`	`string`	No	Dot path to the date field used as each event’s end. Without it, events use the start as their end.
`color`	`string`	No	Dot path to a select or radio field whose value colors each event.
`modes`	`CalendarMode[]`	No; `['month', 'week', 'day']`	Available modes in display order. The first mode is the default.
`snap`	`number`	No	Minute interval used when creating, moving, or resizing events.
`components`	`ViewComponents & CalendarComponents`	No	Adds shared shell slots and calendar-specific components.

Calendar components

Property	Type	Required / default	Behavior
`beforeCalendar`	`FrogBotComponent[]`	No; `[]`	Renders before the calendar.
`afterCalendar`	`FrogBotComponent[]`	No; `[]`	Renders after the calendar.
`Event`	`FrogBotComponent`	No; built-in event	Replaces each event body and receives the document as its `row` prop.

See Collection calendar for modes, date fields, loading, and editing behavior.

CustomView

Property	Type	Required / default	Behavior
`type`	`'custom'`	Yes	Selects a developer-provided view.
`component`	`FrogBotComponent`	Yes	Component that renders the custom view body.
`shell`	`boolean`	No; `true`	When `true`, renders within the collection shell and supports `ViewComponents`. When `false`, replaces the complete collection page and must be the collection’s only view. A full-page custom view renders only its `component` and header `actions`; `beforeView`, `afterView`, `menuItems` and `toolbar` are rejected.
`components`	`ViewComponents`	No	Configures shared shell slots when the shell is enabled. With `shell: false`, only `actions`.

Custom Components

Collections can set Custom Components for their List and Edit Views. To override Collection Components, use the admin.components property in your Collection Config:

import type { CollectionConfig } from 'frogbot'

export const MyCollection: CollectionConfig = {
  // ...
  admin: {
    components: {
      // ...
    },
  },
}

The following options are available:

Option	Type	Default	Description
`CreateButton`	`FrogBotComponent`	Built-in Create New	Replaces the Create New button in the toolbar and the list view’s empty state, on every view type. It renders whatever `create` access says and receives `hasCreatePermission`; `create` access still governs REST and GraphQL create, the document view and relationship drawers. Below the small breakpoint it follows `toolbar`. More details.
`Description`	`FrogBotComponent`	Built-in description	Replaces the collection description. More details.
`edit`	`object`	—	Edit View component slots. More details.

List slots belong to a type: 'list' entry in admin.views: use components.beforeView, toolbar, beforeTable, afterTable, afterView, and NoResults. To replace the collection list, use a type: 'custom' entry with component. See List View.

Edit View Options

Configure these slots under admin.components.edit. See Edit View for working component examples.

Option	Type	Default	Description
`BeforeDocumentMeta`	`FrogBotComponent[]`	`[]`	Inject custom components before the document’s meta row, where FrogBot’s folder button sits.
`beforeDocumentControls`	`FrogBotComponent[]`	`[]`	Inject custom components before the Save / Publish buttons.
`editMenuItems`	`FrogBotComponent[]`	`[]`	Inject custom components within the 3-dot menu dropdown located in the document controls bar.
`SaveButton`	`FrogBotComponent`	Built-in button	Replace the default Save Button within the Edit View. Drafts must be disabled.
`SaveDraftButton`	`FrogBotComponent`	Built-in button	Replace the default Save Draft Button within the Edit View. Drafts must be enabled and autosave disabled.
`Status`	`FrogBotComponent`	Built-in status	Replace the default Status component within the Edit View. Drafts must be enabled.
`PublishButton`	`FrogBotComponent`	Built-in button	Replace the default Publish Button within the Edit View. Drafts must be enabled.
`UnpublishButton`	`FrogBotComponent`	Built-in button	Replace the default Unpublish Button within the Edit View. Drafts must be enabled.
`PreviewButton`	`FrogBotComponent`	Built-in button	Replace the default Preview Button within the Edit View. Preview must be enabled.
`Upload`	`FrogBotComponent`	Built-in upload	Replace the default Upload component within the Edit View. Upload must be enabled.
`views`	`object`	—	Override built-in document views, add custom routes or tabs, or replace the complete document area. More details.

Document Views

Use admin.components.edit.views to replace a built-in document view or add a custom route or tab. See Document Views for configuration and examples.

Key	Route	Behavior
`default`	Document root	Main document editor.
`api`	`/api`	API view.
`livePreview`	None (rendered inside the edit view’s preview window)	Live Preview view.
`versions`	`/versions`	Version history.
`version`	`/versions/:version`	A specific version.
Any custom key	The configured `path`	Adds a custom route, tab, or both.
`root`	All document routes	Replaces the entire document area, including its header, controls, tabs, and nested views.

root is mutually exclusive with every built-in and custom nested document view. When root is configured, it must be the only key in views. Built-in and root view config

Property	Type	Default	Behavior
`Component`	`FrogBotComponent`	Built-in view	Replaces the view component. Optional, allowing other properties to modify the built-in view.
`actions`	`FrogBotComponent[]`	—	Adds components to the view’s actions.
`meta`	`MetaConfig`	—	Overrides metadata for the view.
`tab`	`DocumentTabConfig`	Built-in tab	Modifies the view’s document tab.

Custom view config

Property	Type	Default	Behavior
`Component`	`FrogBotComponent`	Required with `path`	Renders the custom view. Required when `path` is set; otherwise optional.
`path`	`/${string}`	Required with `Component`	Adds a route below the document URL. Requires `Component`. Omit both `path` and `Component` to add only a tab.
`actions`	`FrogBotComponent[]`	—	Adds components to the view’s actions.
`meta`	`MetaConfig`	—	Overrides metadata for the view.
`tab`	`DocumentTabConfig`	—	Configures the custom document tab.

Document view configs do not support exact; custom path values use document-view routing. Document tab config

Property	Type	Default	Behavior
`Component`	`FrogBotComponent`	Built-in tab	Replaces the complete tab component. It receives the resolved `path`.
`Pill`	`FrogBotComponent`	—	Adds a component beside the tab label.
`label`	`string \| ({ t }) => string`	—	Sets the tab label.
`href`	`string \| function`	—	Sets or computes the tab destination.
`condition`	`function`	—	Returns whether the tab should be shown for the current request and permissions. Receives `req` with `req.frogbot`.
`isActive`	`boolean \| ({ href }) => boolean`	—	Controls whether the tab is active.
`newTab`	`boolean`	`false`	Opens the destination in a new browser tab.
`order`	`number`	—	Sets the tab’s render order. Increments of `100` are recommended.

Important: All edit view components must be configured under admin.components.edit, not directly under admin.components.For example, use admin.components.edit.Status, not admin.components.Status.

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 API that FrogBot provides. To configure pagination options, use pagination on a list entry in admin.views:

import type { CollectionConfig } from 'frogbot'

export const Posts: CollectionConfig = {
  // ...
  admin: {
    views: [
      {
        type: 'list',
        pagination: {
          defaultLimit: 10,
          limits: [10, 20, 50],
        },
      },
    ],
  },
}

The following options are available:

Option	Description
`defaultLimit`	Integer that specifies the initial per-page limit. When omitted, the List View uses FrogBot’s list default.
`limits`	Integers offered as List View page-size choices. This does not configure Board View loading.

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. Normal search behavior includes the ID and, when defined, admin.useAsTitle. searchableFields adds fields to that behavior rather than replacing the title field. To define which fields should be searched, use searchableFields on a list entry in admin.views:

import type { CollectionConfig } from 'frogbot'

export const Posts: CollectionConfig = {
  // ...
  admin: {
    views: [
      {
        type: 'list',
        defaultFields: ['title', 'slug'],
        searchableFields: ['title', 'slug'],
      },
    ],
  },
}

Tip: If you are adding searchable fields, make sure you index each of these fields so your admin queries can remain performant.

List View Select API

The List View uses the Select API to query only the active columns, not whole documents. This keeps large collections fast, but a hook that relies on another field only gets it while that field’s column is shown:

import type { CollectionConfig } from 'frogbot'

export const Posts: CollectionConfig = {
  // ...
  fields: [
    // ...
    {
      name: 'myField',
      type: 'text',
      hooks: {
        afterRead: [
          ({ doc }) => doc.title, // `title` is only populated while its column is active
        ],
      },
    },
  ],
}

To keep title present, return it from a select function on your Collection Config:

export const Posts: CollectionConfig = {
  // ...
  select: ({ select }) => (select ? { ...select, title: true } : undefined),
}

Format Document URLs

The formatDocURL function allows you to customize how document links are generated in the List View. This is useful for disabling links for certain documents, redirecting to custom destinations, or modifying URLs based on user context or document state. To define a custom document URL formatter, use the admin.formatDocURL property in your Collection Config:

import type { CollectionConfig } from 'frogbot'

export const Posts: CollectionConfig = {
  // ...
  admin: {
    formatDocURL: ({ doc, defaultURL, req, collectionSlug, viewType }) => {
      // Disable linking for documents with specific status
      if (doc.status === 'private') {
        return null
      }

      // Custom destination for featured posts
      if (doc.featured) {
        return '/admin/featured-posts'
      }

      // Add query parameters based on user role
      if (req.user?.role === 'admin') {
        return defaultURL + '?admin=true'
      }

      // Use default URL for all other cases
      return defaultURL
    },
  },
}

The formatDocURL function receives the following arguments:

Argument	Type	Default	Description
`doc`	`Record<string, unknown>`	Always set	The document data for the current row.
`defaultURL`	`string`	Always set	The URL FrogBot would normally use for this document. Return it as-is, change it, or replace it.
`req`	`FrogBotRequest`	Always set	The current request, with the signed-in user, request data, and `req.frogbot`.
`collectionSlug`	`string`	Always set	The slug of the current collection.
`viewType`	`ViewTypes`	—	The view the link is rendered in, such as `'list'` or `'trash'`.

The function should return:

null to disable the link entirely (no link will be rendered)
A string containing the custom URL to use for the link
The defaultURL parameter to use FrogBot’s default linking behavior

Tip: The defaultURL parameter saves you from having to reconstruct URLs manually. You can modify it by appending query parameters or use it as a fallback for your custom logic.

Examples

Disable linking for certain users:

formatDocURL: ({ defaultURL, req }) => {
  if (req.user?.role === 'editor') {
    return null // No link rendered
  }
  return defaultURL
}

GraphQL

You can completely disable GraphQL for this collection by passing graphQL: false to your collection config. This will completely disable all queries, mutations, and types from appearing in your GraphQL schema. You can also pass an object to the collection’s graphQL property, which allows you to define the following properties:

Option	Type	Default	Description
`singularName`	`string`	Derived from `slug`	Singular name used for this collection’s GraphQL types and queries.
`pluralName`	`string`	Derived from `slug`	Plural name used for this collection’s GraphQL types and queries.
`disableQueries`	`true`	—	Leaves this collection’s queries out of the schema.
`disableMutations`	`true`	—	Leaves this collection’s mutations out of the schema.

TypeScript

You can import types from FrogBot to help make writing your Collection configs easier and type-safe. There are two main types that represent the Collection Config, CollectionConfig and SanitizedCollectionConfig. 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 FrogBot.

import type { CollectionConfig, SanitizedCollectionConfig } from 'frogbot'

Start here

Basics

Managing Data

Features

Ecosystem

Deployment

Organize collection files

FrogBot collection model

Role markers

Field contribution per role

Default collections

Collection config options

Fields

Access Control

Hooks

Orderable

Admin Options

Collection Views

Shared view properties

ViewPagination

ViewComponents

ListView

BoardView

CalendarView

CustomView

Custom Components

Edit View Options

Document Views

List Searchable Fields

List View Select API

Format Document URLs

Examples

GraphQL

TypeScript

​Organize collection files

​FrogBot collection model

​Role markers

​Field contribution per role

​Default collections

​Collection config options

​Fields

​Access Control

​Hooks

​Orderable

​Admin Options

​Collection Views

​Shared view properties

​ViewPagination

​ViewComponents

​ListView

​BoardView

​CalendarView

​CustomView

​Custom Components

​Edit View Options

Document Views

​Pagination

​List Searchable Fields

​List View Select API

​Format Document URLs

​Examples

​GraphQL

​TypeScript

Organize collection files

FrogBot collection model

Role markers

Field contribution per role

Default collections

Collection config options

Fields

Access Control

Hooks

Orderable

Admin Options

Collection Views

Shared view properties

ViewPagination

ViewComponents

ListView

BoardView

CalendarView

CustomView

Custom Components

Edit View Options

Pagination

List Searchable Fields

List View Select API

Format Document URLs

Examples

GraphQL

TypeScript