All pages
Every page in this documentation, in the order it is meant to be read. Each section below is self-contained: start at its first page and the cross-links at the foot of each page carry you through the rest.
New here? Overview → Requirements → Installation → Opening your first panel.
Something is broken? Troubleshooting is symptom-first — find the page named after what you are seeing.
Start here
Introduction
What this framework is, what it decides for you, and where it stops.
- Overview
- Why PandaBear
- Feature Overview
- Architecture At A Glance
- Inertia And Vue Approach
- Comparison With Filament Concepts
- Package Limits And Tradeoffs
Getting started
From composer require to a panel you can sign into.
- Requirements
- Compatibility matrix
- Installation
- Laravel Vue starter kit setup
- Frontend requirements
- Running
panel:install - Creating the first user
- Opening your first panel
- Directory structure
- Package name migration
- Common install problems
Tutorial
One project taken from an empty directory to a deployed panel, in eight steps.
- Overview — what you will build
- 1 · Prepare your environment
- 2 · Create the project
- 3 · Install PandaBear
- 4 · First account, first login
- 5 · Your first resource
- 6 · Shape the form and the table
- 7 · Actions and dashboard widgets
- 8 · Go to production
How it works
Core concepts
The machinery every other page assumes: panels, discovery, routing, the request lifecycle.
- Panels
- Panel Providers
- Request Lifecycle
- Panel Context
- Server Metadata to Vue
- Discovery
- Routing
- Authorization
- Frontend Assets
- Component Registries
- Caching
Building a panel
Panels
Defining, branding, mounting and gating a panel — and running more than one.
- Defining a Panel
- Panel IDs, Paths, and Domains
- Multi-Panel Applications
- Middleware and Guards
- Panel Access Rules
- Branding, Logo, Icon, Favicon
- Sidebar and Header Layouts
- Navigation Groups
- Panel Switcher
- Dashboards
- Settings Pages
- Render Hooks
- Panel Assets
- Panel Cache
- Panel API Reference
Resources
The CRUD unit: a model, its pages, its queries and its abilities.
- Creating Resources
- Resource Directory Convention
- Model Binding
- List, Create, View and Edit Pages
- Resource Pages
- Resource Queries
- Labels and Navigation
- URLs And Route Names
- Soft Deletes
- Singular Resources
- Nested Resources
- Resource Configuration Per Panel
- Lifecycle Hooks
- Resource Authorization
- Global Search Integration
- Resource API Reference
Forms and schemas
Building a form, and how state moves between Vue and the server.
- FormSchema Basics
- Field State Lifecycle
- Hydration And Dehydration
- Live Fields
- Validation
- Field Visibility
- Disabled And Hidden Fields
- Relationship Forms
- File Uploads
- Options Endpoints
- Form Layouts
- Prime Components
- Custom Fields
Form fields
Every field type, one page each.
- Builder
- Checkbox
- Code Editor
- Color Picker
- Date and Time
- File Upload
- Key Value
- Markdown Editor
- Number
- Radio
- Repeater
- Rich Editor Field
- Select Field
- Slider Field
- Tags Field
- Text Field
- Toggle Field
Tables
Columns, filters, search, sorting, grouping and everything in the toolbar.
- TableSchema Basics
- Columns
- Search
- Sorting
- Filters
- Query Builder Filter
- Filter Tabs
- Grouping
- Summaries
- Pagination
- Persisted Table State
- Column Manager
- Frozen And Pinned Columns
- Editable Columns
- Record Actions
- Bulk Actions
- Toolbar Actions
- Reordering Records
- Relationship Columns
- Array Data Tables
- Table API Reference
Actions
Buttons that do something: modals, confirmation, bulk, authorization, transactions.
- Action Basics
- Action Scopes
- Row Actions
- Table Actions
- Bulk Actions
- Infolist Actions
- Action Authorization
- Action Modals
- Action Forms
- Transactions
- Built-In Actions
- Create, Edit, View, And Delete Actions
- Replicate
- Restore And Force Delete
- Import And Export Actions
- Relation Actions
- Custom Actions
Relations
Editing what hangs off a record — managers, pivots, nested resources.
- Relation Managers
- Relation Pages
- Relation Tables
- Relation Forms
- Attach And Detach
- Associate And Dissociate
- Pivot Fields
- Related Record Policies
- Soft Deleted Relations
- Nested Resource Vs Relation Manager
Infolists
Read-only detail views.
- InfolistSchema Basics
- Entries
- Infolist Layouts
- Repeatable Entries
- Custom Entries
- Actions in Infolists
- Entry Reference
Pages and navigation
Custom pages, clusters, breadcrumbs, sub-navigation, URLs.
- Custom Pages
- Page Discovery
- Page Authorization
- Page Headings
- Breadcrumbs
- Sub Navigation
- Clusters
- Full Page URLs
- Prefetching
- Error Notifications
Widgets
Dashboard stats, charts, tables and your own Vue.
- Widgets
- Stats Widgets
- Chart Widgets
- Table Widgets
- Custom Vue Widgets
- Widget Filters
- Lazy Widgets
- Polling
- Widget Authorization
- Column Span and Layout
Application features
Authentication and users
Login, registration, two-factor, passkeys, profile, and what the panel asks of your user model.
- Fortify Integration
- Login
- Registration
- Password Reset
- Email Verification
- The
panel:userCommand - User Model Requirements
- The
PanelUserContract - Profile Settings
- Security Settings
- Appearance Settings
- Two-Factor Authentication
- Email Code Challenge
- Passkeys
Tenancy
Scoping a panel to a tenant — single-database, database-per-tenant, and the security rules.
- Tenancy Concepts
- Tenant Resolver
HasPanelTenantsPanelTenant- Tenant Switcher
- Tenant URLs
- Resource Tenant Scoping
- Single Database Tenancy
- Database Per Tenant
- Using with
stancl/tenancy - Queues and Tenant Context
- Tenancy Security Checklist
Notifications and broadcasting
Toasts, the notification centre, database notifications, Reverb and Echo.
- Toast Notifications
- Flash Toast Bridge
- Database Notifications
- Notification Center
- Notification Actions
- Broadcasting
- Reverb and Echo Setup
- Channel Authorization
- Queued Notifications
- Testing Notifications
Global search
Making resources findable from the header.
- Global Search Overview
- Searchable Resources
- Search Attributes
- Relationship Search
- Search Result Details
- Search Result URLs
- Panel Search Configuration
- Search Security
Import and export
CSV and XLSX in both directions, queued, with failure reports.
- ExportAction
- ImportAction
- Exporter Classes
- Importer Classes
- Columns And Mapping
- CSV And XLSX
- Queued Imports
- Queued Exports
- Failure Reports
- Storage And Cleanup
- Import And Export Notifications
Extending it
Frontend customization
The published Vue: your own columns, fields, pages, widgets, shell and theme.
- Published Asset Structure
- Vue Component Tree
- Inertia Pages
- Host Modules
- Wayfinder routes
- Custom Page Components
- Custom Columns
- Custom Fields
- Custom Widgets
- Custom Shell Components
- Icons
- Tailwind Theme
- CSS Hooks
- Updating published assets
Plugins
Packaging panel configuration for reuse.
- Plugin Concepts
- Creating a Plugin
- Plugin Contract
- Register and Boot
- Plugin Metadata
- Version Compatibility
- Plugin Assets
- Plugin CLI
- Testing Plugins
Reference
CLI reference
Every artisan command, flag by flag.
panel:installpanel:usermake:panelmake:panel-resourcemake:panel-pagemake:panel-widgetmake:panel-relation-managerpanel:cachepanel:clearpanel:iconspanel:assetspanel:plugins- Publish Tags
Configuration reference
config/panda-panel.php, middleware, routes, redirects, environment.
- config/panda-panel.php
- Panel Config
- Frontend Paths
- Middleware Registration
- Route Registration
- Guest Redirect
- Home Redirect
- Migration Loading
- Environment Variables
- Service Provider Behavior
Testing
The helpers, and what is worth asserting about a panel.
- Test Setup
- Testing Helpers
- Testing Tables
- Testing Forms
- Testing Actions
- Testing Notifications
- Testing Tenancy
- Testing Authorization
- Negative Security Tests
- Frontend Contract Tests
- CI Matrix
API reference
The public classes, grouped by subsystem.
- Core API Reference
- Contracts Reference
- Resources Reference
- Pages Reference
- Forms Reference
- Tables Reference
- Actions Reference
- Widgets
- Infolists Reference
- Notifications Reference
- Tenancy
- Plugins Reference
- Events, Jobs and Controllers Reference
- Exceptions Reference
Glossary
Every term this documentation uses as if you already knew it, with the page that defines it.
Running it in production
Deployment and operations
Caching, queues, Octane, storage, monitoring, rollbacks.
- Production Checklist
- Composer and Autoloading
- Frontend Build
- Route Cache
- Config Cache
- Panel Cache in Production
- Icon Registry
- Queues
- Broadcasting Server
- Storage Setup
- Octane
- Rollbacks
- Monitoring
Upgrading
What the version number promises, what breaks, and the edit that fixes it.
- Versioning Policy
- Upgrade Guide
- Breaking Changes
- Asset Manifest
- Resolving Asset Conflicts
- Migrating Package Names
- Changelog
- Release Checklist
Troubleshooting
Symptom-first pages for the failures that actually happen.
- Installing from Packagist
- Inertia root view and middleware
- Missing host modules
- Vite Build Errors
- Tailwind 4
- Login redirects
- 403 responses
- Panel routes that 404
- Icons that render nothing
- Asset conflicts
- Upload Failures
- Broadcast failures
- Tenant scope leaks
- Import and export failures
Worked examples
Recipes
Whole features built end to end.
- Admin Panel Example
- App Panel Example
- User Resource
- Product Resource
- Relation Manager
- Tenant Panel
- Import and Export
- Custom Widget
- Custom Field
- Plugin
- Locking a Panel Down
Contributing
Working on the package itself.
- Local Development
- Running the Tests
- Frontend Toolchain
- Coding Standards
- Architecture Decisions
- Pull Requests
- Releases
- Security
358 pages. sidebar.md is the same tree collapsed to one entry per section, for a navigation bar.