Skip to content
CFast
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting Started
Guides
@cfast/actions
@cfast/admin
@cfast/auth
@cfast/core
@cfast/db
@cfast/email
@cfast/env
@cfast/forms
@cfast/pagination
@cfast/permissions
@cfast/storage
@cfast/ui
Tutorial: Build a Team Blog
1. Project Setup
2. Database Setup
3. Authentication
4. Permissions
5. CRUD with Actions
6. Admin Panel
7. File Storage
8. Email Notifications
API Reference
actions
Type Aliases
ActionContext
ActionDefinition
ActionPermissionsMap
ActionPermissionStatus
ActionsConfig
ClientDescriptor
ComposedActions
OperationsFn
RequestArgs
Serializable
Functions
checkPermissionStatus
createActions
admin
Type Aliases
AdminActionResult
AdminAuthConfig
AdminColumnConfig
AdminConfig
AdminLoaderData
AdminTableMeta
AdminUser
CreateDbFn
DashboardConfig
DashboardStat
DashboardWidget
RecentItem
RowAction
TableAction
TableOverrides
UserManagementConfig
Functions
createAdmin
createAdminAction
createAdminComponent
createAdminLoader
introspectSchema
auth
Type Aliases
AuthConfig
AuthContext
AuthenticatedContext
AuthEnvConfig
AuthInstance
AuthUser
Functions
createAdminAuth
createAuth
createAuthRouteHandlers
createImpersonationManager
createRoleManager
core
Classes
CfastConfigError
CfastPluginError
Type Aliases
App
AppContext
CfastPlugin
CreateAppConfig
PluginProvides
PluginSetupContext
RouteArgs
Functions
createApp
definePlugin
db
Type Aliases
CacheBackend
CacheConfig
CursorPage
CursorParams
Db
DbConfig
DeleteBuilder
DeleteReturningBuilder
FindFirstOptions
FindManyOptions
InsertBuilder
InsertReturningBuilder
OffsetPage
OffsetParams
Operation
PaginateOptions
PaginateParams
QueryBuilder
QueryCacheOptions
UpdateBuilder
UpdateReturningBuilder
UpdateWhereBuilder
Functions
compose
composeSequential
createDb
parseCursorParams
parseOffsetParams
email
Classes
EmailDeliveryError
Type Aliases
EmailClient
EmailClientConfig
EmailMessage
EmailProvider
SendOptions
Functions
createEmailClient
env
Classes
EnvError
Type Aliases
BindingDef
BindingType
BindingTypeMap
EnvironmentDefaults
EnvironmentName
EnvValidationError
ObjectBindingDef
ParsedEnv
Schema
SecretBindingDef
VarBindingDef
Functions
defineEnv
forms
Type Aliases
FieldComponentProps
FieldConfig
FieldDefinition
FormPlugin
FormPluginComponents
FormWrapperProps
InputType
SubmitButtonProps
ValidationRules
Functions
createAutoForm
createFormPlugin
createResolver
introspectTable
v
pagination
Type Aliases
UseInfiniteScrollOptions
UseInfiniteScrollResult
UseOffsetPaginationResult
UsePaginationOptions
UsePaginationResult
Functions
useInfiniteScroll
useOffsetPagination
usePagination
permissions
Classes
ForbiddenError
Type Aliases
CrudAction
DrizzleTable
Grant
GrantFn
PermissionAction
PermissionCheckResult
PermissionDescriptor
Permissions
PermissionsConfig
WhereClause
Variables
CRUD_ACTIONS
Functions
can
checkPermissions
definePermissions
getTableName
grant
resolveGrants
storage
Classes
StorageError
Type Aliases
ClientFiletypeConfig
ClientStorageConfig
FileInfo
FiletypeConfig
FiletypeHooks
HandleContext
KeyContext
ServeOptions
SignedUrlOptions
StorageErrorCode
StorageErrorOptions
StorageInstance
StorageSchema
UploadResult
Functions
defineStorage
filetype
parseSize
ui
Type Aliases
ActionButtonProps
AlertSlotProps
AppShellProps
AppShellSlotProps
AvatarWithInitialsProps
BaseFieldProps
BooleanFieldProps
BreadcrumbItem
BreadcrumbSlotProps
BulkAction
ButtonSlotProps
ChipSlotProps
ColumnDef
ColumnShorthand
ConfirmDialogSlotProps
ConfirmOptions
DataTableProps
DateFieldProps
DetailViewProps
DropZoneProps
DropZoneSlotProps
EmailFieldProps
EmptyStateProps
FileFieldProps
FileListFile
FileListProps
FilterBarProps
FilterDef
FilterOption
FilterType
FormStatusData
FormStatusProps
ImageFieldProps
ImagePreviewProps
ImpersonationBannerProps
JsonFieldProps
ListViewProps
NavigationItem
NavigationProgressProps
NumberFieldProps
PageContainerSlotProps
PermissionGateProps
RelationFieldProps
RoleBadgeProps
SidebarSlotProps
TabItem
TableCellSlotProps
TableRowSlotProps
TableSectionSlotProps
TableSlotProps
TextFieldProps
ToastApi
ToastOptions
ToastSlotProps
ToastType
TooltipSlotProps
UIPlugin
UIPluginComponents
UrlFieldProps
UserMenuLink
UserMenuProps
WhenForbidden
Variables
ToastContext
Functions
ActionButton
AppShell
AppShellHeader
AppShellSidebar
AvatarWithInitials
BooleanField
BulkActionBar
ConfirmProvider
createUIPlugin
DataTable
DateField
DetailView
DropZone
EmailField
EmptyState
fieldForColumn
fieldsForTable
FileField
FileList
FilterBar
FormStatus
getInitials
ImageField
ImagePreview
ImpersonationBanner
JsonField
ListView
NavigationProgress
NumberField
PageContainer
PermissionGate
RelationField
RoleBadge
TextField
UIPluginProvider
UrlField
useActionStatus
useActionToast
useColumnInference
useComponent
useConfirm
UserMenu
useToast
useUIPlugin
GitHub
Select theme
Dark
Light
Auto
cfast
Modules
Section titled “Modules”
actions
admin
auth
core
db
email
env
forms
pagination
permissions
storage
ui