Back to Details

filament-docs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

FilamentPHP Documentation Reference Skill

FilamentPHP文档参考Skill

Overview

概述

This skill provides access to the complete FilamentPHP v4 official documentation. Use this skill to look up exact implementations, method signatures, and patterns before generating any Filament code.
本Skill可访问完整的FilamentPHP v4官方文档。在生成任何Filament代码之前，可使用本Skill查找具体实现、方法签名及模式。

Documentation Location

文档位置

All documentation is stored in: 
/home/mwguerra/projects/mwguerra/claude-code-plugins/filament-specialist/skills/filament-docs/references/
所有文档存储于： 
/home/mwguerra/projects/mwguerra/claude-code-plugins/filament-specialist/skills/filament-docs/references/

Directory Structure

目录结构

references/
├── actions/                    # Action buttons and modals
│   └── *.md                    # Action types and configurations
├── forms/                      # Form components
│   └── *.md                    # All form field types
├── general/
│   ├── 01-introduction/        # Getting started, installation
│   ├── 03-resources/           # CRUD resources
│   ├── 06-navigation/          # Menu and navigation
│   ├── 07-users/               # Auth and permissions
│   ├── 08-styling/             # Themes and CSS
│   ├── 09-advanced/            # Advanced patterns
│   ├── 10-testing/             # Testing guide
│   ├── 11-plugins/             # Plugin development
│   └── 12-components/          # UI components
├── infolists/                  # Infolist entries
│   └── *.md                    # Display components
├── notifications/              # Notification system
│   └── *.md                    # Toast and DB notifications
├── schemas/                    # Schema validation
│   └── *.md                    # Schema patterns
├── tables/                     # Table components
│   ├── 02-columns/             # Column types
│   └── 03-filters/             # Filter types
└── widgets/                    # Dashboard widgets
    └── *.md                    # Widget types
references/
├── actions/                    # 操作按钮与模态框
│   └── *.md                    # 操作类型与配置
├── forms/                      # 表单组件
│   └── *.md                    # 所有表单字段类型
├── general/
│   ├── 01-introduction/        # 入门指南、安装
│   ├── 03-resources/           # CRUD资源
│   ├── 06-navigation/          # 菜单与导航
│   ├── 07-users/               # 认证与权限
│   ├── 08-styling/             # 主题与CSS
│   ├── 09-advanced/            # 高级模式
│   ├── 10-testing/             # 测试指南
│   ├── 11-plugins/             # 插件开发
│   └── 12-components/          # UI组件
├── infolists/                  # 信息列表条目
│   └── *.md                    # 展示组件
├── notifications/              # 通知系统
│   └── *.md                    # 提示框与数据库通知
├── schemas/                    # Schema验证
│   └── *.md                    # Schema模式
├── tables/                     # 表格组件
│   ├── 02-columns/             # 列类型
│   └── 03-filters/             # 筛选器类型
└── widgets/                    # 仪表盘小部件
    └── *.md                    # 小部件类型

Usage

使用方法

When to Use This Skill

适用场景

  1. Before generating any Filament component code
  2. When troubleshooting Filament errors
  3. To verify method signatures and parameters
  4. To find correct import statements
  5. To understand Filament v4 patterns
  1. 生成任何Filament组件代码之前
  2. 排查Filament错误时
  3. 验证方法签名与参数
  4. 查找正确的导入语句
  5. 理解Filament v4模式

Search Workflow

搜索流程

  1. Identify Topic: Determine what documentation is needed
  2. Navigate to Folder: Go to relevant directory
  3. Read Documentation: Extract exact patterns
  4. Apply Knowledge: Use in code generation
  1. 确定主题：明确所需文档内容
  2. 导航至对应文件夹：进入相关目录
  3. 阅读文档：提取具体模式
  4. 应用知识：用于代码生成

Common Lookups

常见查询

TopicDirectory
Resource creation
general/03-resources/
Form fields
forms/
Table columns
tables/02-columns/
Table filters
tables/03-filters/
Actions
actions/
Widgets
widgets/
Infolists
infolists/
Testing
general/10-testing/
Styling
general/08-styling/
Navigation
general/06-navigation/
Auth/Permissions
general/07-users/
Plugin Development
general/11-plugins/
主题目录
资源创建
general/03-resources/
表单字段
forms/
表格列
tables/02-columns/
表格筛选器
tables/03-filters/
操作
actions/
小部件
widgets/
信息列表
infolists/
测试
general/10-testing/
样式定制
general/08-styling/
导航
general/06-navigation/
认证/权限
general/07-users/
插件开发
general/11-plugins/

Documentation Reading Pattern

文档阅读模式

When reading documentation:
  1. Find the right file: Match component to documentation file
  2. Read the overview: Understand the component's purpose
  3. Extract code examples: Copy exact patterns
  4. Note imports: Get correct use statements
  5. Check configuration: Review options and parameters
阅读文档时：
  1. 找到对应文件：将组件与文档文件匹配
  2. 阅读概述：理解组件用途
  3. 提取代码示例：复制具体模式
  4. 记录导入语句：获取正确的use声明
  5. 查看配置：审阅选项与参数

Example Usage

使用示例

Looking up TextInput field

查询TextInput字段

  1. Navigate to 
    forms/
    directory
  2. Find text-input documentation
  3. Extract:
    • Basic usage pattern
    • Available methods (required, email, tel, etc.)
    • Validation integration
    • Correct import statement
  1. 导航至
    forms/
    目录
  2. 找到text-input文档
  3. 提取：
    • 基础使用模式
    • 可用方法（required、email、tel等）
    • 验证集成
    • 正确的导入语句

Looking up Table columns

查询表格列

  1. Navigate to 
    tables/02-columns/
  2. Find specific column type
  3. Extract:
    • Column configuration
    • Formatting options
    • Relationship handling
    • Sorting and searching
  1. 导航至
    tables/02-columns/
  2. 找到特定列类型
  3. 提取：
    • 列配置
    • 格式化选项
    • 关联关系处理
    • 排序与搜索

Output

输出结果

After reading documentation, provide:
  1. Exact code pattern from docs
  2. Required imports
  3. Configuration options
  4. Best practices noted
  5. Version-specific considerations
阅读文档后，需提供：
  1. 文档中的精确代码模式
  2. 所需导入语句
  3. 配置选项
  4. 注意到的最佳实践
  5. 版本特定注意事项