Composables Reference

Complete reference for all Nuxt Crouton composables

Nuxt Crouton provides a comprehensive set of composables for data fetching, mutations, forms, tables, and utilities. These composables follow Nuxt's composables conventions and integrate seamlessly with Vue's Composition API.

Quick Reference

Data Composables

Fetch and manage collection data with automatic caching and reactivity.

Composable	Purpose	Category
`useCollection`	Simplified collection fetching (legacy pattern)	Data
`useCollectionItem`	Fetch and manage a single collection item	Data
`useCollections`	Access all registered collections metadata	Data
`useCollectionProxy`	Create reactive proxy for collection operations	Data
`useExternalCollection`	Fetch data from external APIs	Data

Query Composables

Fetch collection data with advanced query capabilities.

Composable	Purpose	Category
`useCollectionQuery`	Fetch with automatic caching and reactivity	Query

Mutation Composables

Create, update, and delete collection data with automatic cache invalidation.

Composable	Purpose	Category
`useCollectionMutation`	CRUD operations for a specific collection	Mutation
`useCroutonMutate`	One-off mutations (any collection)	Mutation

Form Composables

Manage form state and CRUD operations with modal/slideover support.

Composable	Purpose	Category
`useCrouton`	Global modal and form state management	Form

Table Composables

Build interactive data tables with sorting, filtering, and pagination.

Composable	Purpose	Category
`useTableColumns`	Define and configure table columns	Table
`useTableData`	Manage table data with sorting and pagination	Table
`useTableSearch`	Add search functionality to tables	Table

Utility Composables

Specialized helpers for translations, assets, formatting, and more.

Composable	Purpose	Category
`useFormatCollections`	Format collection metadata for UI display	Utility
`useEntityTranslations`	Handle entity-specific translations	Utility
`useAssetUpload`	Manage file uploads with progress tracking	Utility
`useTeamContext`	Multi-tenancy team context management	Utility
`useUsers`	User management operations	Utility
`useCroutonError`	Centralized error handling	Utility
`useT`	Translation helper with collection context	Utility
`useDependentFieldResolver`	Resolve dependent field values	Utility
`useExpandableSlideover`	Manage expandable slideover state	Utility

Detailed Documentation

Click any category below to view complete documentation with type signatures, parameters, examples, and best practices:

Data Composables

Fetch and manage collection data with automatic caching and reactivity

Query Composables

Advanced data fetching with query parameters and reactivity

Mutation Composables

Create, update, and delete operations with cache invalidation

Form Composables

Manage form state and CRUD operations with modal support

Table Composables

Build interactive data tables with sorting and filtering

Utility Composables

Specialized helpers for translations, assets, and more

Nuxt Composables Guide - Learn about Nuxt's composables conventions
Vue Composition API - Understanding Vue's Composition API
Components Reference - UI components documentation
TypeScript Types - Type definitions and interfaces

Utility Components

Helper components for loading states, errors, and special behaviors

Data Composables

Fetch and manage collection data with automatic caching and reactivity