README

"带有别名的标题" 输入 - Filament 表单的易于使用永久链接别名（PHP / Laravel / Livewire）

此包为 FilamentPHP 添加了表单组件 TitleAndSlugInput，允许轻松编辑标题和别名。

它灵感来源于经典的 WordPress 标题 & 别名 实现。

插件完全可配置。您可以更改所有标签，使用自己的别名生成器，使用 route() 生成“查看”链接，隐藏主机名，等等。请参阅完整文档

TitleAndSlugInput::make(
    fieldTitle: 'title', // The name of the field in your model that stores the title.
    fieldSlug: 'slug', // The name of the field in your model that will store the slug.
),

输出如下：（观看 » 演示视频 «）

功能

别名编辑表单。
“访问”链接以查看生成的 URL。
如果尚未手动更新，则自动从标题生成别名。
撤销编辑的别名。
所有文本均可自定义和翻译。
支持深色模式。
完全可配置，请参阅所有可用参数。

视频

您可以在以下包中观看简短的视频演示。

安装

您可以通过 composer 安装此包

composer require altwaireb/filament-title-and-slug

如果需要，您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="filament-title-and-slug-config"

翻译

如果需要，您可以使用以下命令发布翻译文件

php artisan vendor:publish --tag="filament-title-and-slug-translations"

您将在这里找到已发布的翻译：trans/vendor/filament-title-and-slug

此包已翻译为

您也翻译了吗？在我们的 GitHub 讨论页上分享您的翻译。

用法与示例

基本用法 - 将 TitleAndSlugInput 添加到 Filament 表单中

此包为 Filament 表单构建器 提供自定义输入字段 TitleAndSlugInput。

在此处阅读 Filament 的安装详细信息。

以下是一个示例，说明如何在您的 Filament 资源中放置新字段。

fieldTitle：在您的模型中存储标题的字段名称。
fieldSlug：将存储别名的模型中的字段名称。

use \Altwaireb\Filament\Forms\Components\TitleAndSlugInput;

class PostResource extends Resource
{
    public static function form(Form $form): Form
    {
        return $form->schema([
        
            TitleAndSlugInput::make(
                fieldTitle: 'title',
                fieldSlug: 'slug',
            )
            
        ]);
    }
}

提示：要占用全部宽度，请使用 TitleAndSlugInput::make()->columnSpan('full')。

输出如下

更改模型字段名称

该包假设您建模的字段名为 title 和 slug。

您可以根据需要轻松更改它们。

在下面的示例中，该包现在使用数据库字段 name 作为标题，使用 identifier 作为别名。

\Altwaireb\Filament\Forms\Components\TitleAndSlugInput::make(
    fieldTitle: 'name',
    fieldSlug: 'identifier',
)

更改标签、标题、占位符

可以动态更改所有标签。

在此示例中，我们还添加了基本路径 /books/。

\Altwaireb\Filament\Forms\Components\TitleAndSlugInput::make(
    urlPath: '/book/',
    urlVisitLinkLabel: 'Visit Book',
    titleLabel: 'Title',
    titlePlaceholder: 'Insert the title...',
    slugLabel: 'Link:',
)

提示：您可以完全翻译该包。

输出如下

永久链接预览：隐藏主机

您可以选择隐藏永久链接预览中的主机部分。

\Altwaireb\Filament\Forms\Components\TitleAndSlugInput::make(
    urlHostVisible: false,
)

输出如下

永久链接预览：更改主机和路径

您可以为预览设置路径和主机。

\Altwaireb\Filament\Forms\Components\TitleAndSlugInput::make(
    urlPath: '/category/',
    urlHost: 'https://project.local',
)

输出如下

"访问"链接 - 使用路由器通过 route() 生成 URL

您可以使用命名路由，例如 route('product.show', ['slug' => $record->slug])，来生成“访问”链接。

\Altwaireb\Filament\Forms\Components\TitleAndSlugInput::make(
    urlPath: '/product/',
    urlHost: 'camya.com',
    urlVisitLinkRoute: fn(?Model $record) => $record?->slug 
        ? route('product.show', ['slug' => $record->slug])
        : null,
)

Laravel 文档：生成命名路由的 URL

默认情况下，该包将字符串 host + path + slug 连接起来以生成“访问”链接。

因为“访问”链接现在是由路由生成的，所以您可以使用部分主机，例如 urlHost: 'camya.com' 来缩短永久链接预览。

输出如下

隐藏"访问"链接

您可以完全删除“访问”链接。

\Altwaireb\Filament\Forms\Components\TitleAndSlugInput::make(
    urlVisitLinkVisible: false,
)

样式化"标题"输入字段

为了样式化“标题”输入字段，您可以通过 titleExtraInputAttributes 参数传递 class 属性。

\Altwaireb\Filament\Forms\Components\TitleAndSlugInput::make(
    titleExtraInputAttributes: ['class' => 'italic'],
)

输出如下

为标题或别名添加额外的验证规则

您可以通过传递变量 titleRules 或 slugRules 来添加额外的验证规则。

此外，自动应用对 slug 字段的唯一验证规则。要修改唯一规则，请参阅标题（和 slug）的唯一验证规则。

\Altwaireb\Filament\Forms\Components\TitleAndSlugInput::make(
    titleRules: [
        'required',
        'string',
        'min:3',
        'max:12',
    ],
)

您还可以自定义错误消息。

自定义错误消息

您可以通过添加 $messages 成员变量来在 EditModel 和 CreateModel Filament 资源中自定义错误消息。

protected $messages = [
  'data.slug.regex' => 'Invalid Slug. Use only chars (a-z), numbers (0-9), and the dash (-).',
];

自定义标题（和别名）的唯一验证规则

唯一验证规则只能通过使用参数 titleRuleUniqueParameters 和 slugRuleUniqueParameters 的对应参数来修改。

这是为了正确设置 Filament 的“可忽略”参数。

\Altwaireb\Filament\Forms\Components\TitleAndSlugInput::make(
    titleRuleUniqueParameters: [
        'callback' => fn(Unique $rule) => $rule->where('is_published', 1),
        'ignorable' => fn(?Model $record) => $record,
    ],
)

此数组被插入到输入字段的 ->unique(...[$slugRuleUniqueParameters]) 方法中。

请参阅 Filament 的Unique 方法文档。

可用的数组键

'ignorable' (Model | Closure)
'callback' (?Closure)
'ignoreRecord' (bool)
'table' (string | Closure | null)  
'column' (string | Closure | null)

自定义别名生成器

此包使用 Laravel 的缩写器 Str::slug()，但您可以用自己的替换它。

以下示例生成只包含字符 a-z 的缩写，并用正则表达式验证它们。

\Altwaireb\Filament\Forms\Components\TitleAndSlugInput::make(
    slugSlugifier: fn($string) => preg_replace( '/[^a-z]/', '', $string),
    slugRuleRegex: '/^[a-z]*$/',
)

注意：您可以自定义验证错误，请参阅自定义错误消息。

深色模式

该包支持 Filament 的暗黑模式。暗黑模式输出如下所示

如何设置空的主页别名

要设置空别名，您必须首先删除别名的 required 规则。您可以通过覆盖 slugRules 数组来完成此操作。

\Altwaireb\Filament\Forms\Components\TitleAndSlugInput::make(
    slugRules: [],
),

在组件别名的表单输入字段中，使用 / 字符设置主页。

/ 字符是必要的，以绕过当缩写字段为空字符串时将触发的 自动缩写生成。

输入如下所示

在关系重复器中使用

您可以在具有数据库关系的重复器中使用 TitleAndSlugInput。

此示例使用 Eloquent 关系 "Post hasMany FAQEntries"。

请参阅 Laravel Eloquent Relationship 和 Filament Repeater 文档以获取详细信息。

\Filament\Forms\Components\Repeater::make('FAQEntries')
    ->relationship()
    ->collapsible()
    ->schema([

        \Altwaireb\Filament\Forms\Components\TitleAndSlugInput::make(
            fieldTitle: 'title',
            fieldSlug: 'slug',
            urlPath: '/faq/',
            urlHostVisible: false,
            titleLabel: 'Title',
            titlePlaceholder: 'Insert FAQ title...'
        )

    ]),

输出如下

制作一个 URL 别名三明治。（路径/别名/路径）

您可以在路径中间创建包含别名的 URL。

示例：“/books/ slug /detail/”

添加一个 urlVisitLinkRoute 闭包来创建正确的访问链接非常重要。请阅读有关"使用命名路由创建urlVisitLinkRoute"的文档。

\Altwaireb\Filament\Forms\Components\TitleAndSlugInput::make(
    urlPath: '/books/',
    urlVisitLinkRoute: fn (?Model $record) => $record?->slug
        ? '/books/'.$record->slug.'/detail'
        : null,
    slugLabelPostfix: '/detail/',
    urlVisitLinkLabel: 'Visit Book Details'
),

输出如下

使用别名作为子域名

您可以使用以下设置来创建URL的子域部分。

例如: "https:// my-subdomain .camya.com"

添加一个 urlVisitLinkRoute 闭包来创建正确的访问链接非常重要。此外，您需要使用 slugField 设置子域的Eloquent模型字段名称。

请阅读有关"使用命名路由创建urlVisitLinkRoute"的文档。

\Altwaireb\Filament\Forms\Components\TitleAndSlugInput::make(
    fieldSlug: 'subdomain',
    urlPath: '',
    urlHostVisible: false,
    urlVisitLinkLabel: 'Visit Domain',
    urlVisitLinkRoute: fn (?Model $record) => $record?->slug
        ? 'https://'.$record->slug.'.camya.com'
        : null,
    slugLabel: 'Domain:',
    slugLabelPostfix: '.camya.com',
),

输出如下

包配置文件 - 设置默认值

此包提供了一些默认值，可以轻松通过编程方式覆盖。

如果您有其他默认值，可以发布配置文件并全局更改它们。

php artisan vendor:publish --tag="filament-title-and-slug-field-config"

您可以在以下位置找到已发布的配置：config/title-and-slug-field.php

可以使用以下方式编程覆盖值：TitleAndSlugInput::make(fieldTitle: 'title')

[
    'field_title' => 'title', // Overwrite with (fieldTitle: 'title')
    'field_slug' => 'slug', // Overwrite with (fieldSlug: 'title')
    'url_host' => env('APP_URL'), // Overwrite with (urlHost: 'https://www.camya.com/')
];

所有可用参数

您可以在没有参数的情况下调用 TitleAndSlugInput，它将使用默认值工作。

要设置参数，您使用PHP8的命名参数语法。

\Altwaireb\Filament\Forms\Components\TitleAndSlugInput::make(
    fieldTitle: 'title',
    fieldSlug: 'slug',
);

以下是一个覆盖一些默认值的示例。

\Altwaireb\Filament\Forms\Components\TitleAndSlugInput::make(

    // Model fields
    fieldTitle: 'title',
    fieldSlug: 'slug',

    // Url
    urlPath: '/blog/',
    urlHost: 'https://www.camya.com',
    urlHostVisible: true,
    urlVisitLinkLabel: 'View',
    urlVisitLinkRoute: fn(?Model $record) => $record?->slug 
        ? route('post.show', ['slug' => $record->slug])
        : null,
    urlVisitLinkVisible: true,

    // Title
    titleLabel: 'The Title',
    titlePlaceholder: 'Post Title',
    titleExtraInputAttributes: ['class' => 'italic'],
    titleRules: [
        'required',
        'string',
    ],
    titleRuleUniqueParameters: [
        'callback' => fn(Unique $rule) => $rule->where('is_published', 1),
        'ignorable' => fn(?Model $record) => $record,
    ],
    titleIsReadonly: fn($context) => $context !== 'create',
    titleAutofocus: true,
    titleAfterStateUpdated: function ($state) {},
    
    // Slug
    slugLabel: 'The Slug: ',
    slugRules: [
        'required',
        'string',
    ],
    slugRuleUniqueParameters: [
        'callback' => fn(Unique $rule) => $rule->where('is_published', 1),
        'ignorable' => fn(?Model $record) => $record,
    ],
    slugIsReadonly: fn($context) => $context !== 'create',
    slugSlugifier: fn($string) => Str::slug($string),
    slugRuleRegex: '/^[a-z0-9\-\_]*$/',
    slugAfterStateUpdated: function ($state) {},
    slugLabelPostfix: null,

)->columnSpan('full'),

变更日志

有关最近更改的更多信息，请参阅版本更改日志。

贡献

想要实现功能、修复错误或翻译此包？请查看贡献指南的详细信息。

安全漏洞

请查看我们的安全策略以了解如何报告安全漏洞。

致谢

Abdulmajeed Altwaireb (开发者)
Andreas Scheibel (camya) (在camya.com / epicbundle.com)的开发者)

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。

altwaireb / filament-title-and-slug

维护者

详细信息

README

"带有别名的标题" 输入 - Filament 表单的易于使用永久链接别名（PHP / Laravel / Livewire）

功能

视频

目录

安装

翻译

用法与示例

基本用法 - 将 TitleAndSlugInput 添加到 Filament 表单中

更改模型字段名称

更改标签、标题、占位符

永久链接预览：隐藏主机

永久链接预览：更改主机和路径

"访问"链接 - 使用路由器通过 route() 生成 URL

隐藏"访问"链接

样式化"标题"输入字段

为标题或别名添加额外的验证规则

自定义错误消息

自定义标题（和别名）的唯一验证规则

自定义别名生成器

深色模式

如何设置空的主页别名

在关系重复器中使用

制作一个 URL 别名三明治。（路径/别名/路径）

使用别名作为子域名

包配置文件 - 设置默认值

所有可用参数

变更日志

贡献

安全漏洞

致谢

许可证