mehedi/stylist

Laravel 主题包。

1.0 2020-04-19 08:37 UTC

This package is auto-updated.

Last update: 2024-09-15 02:07:57 UTC


README

关于

Build Status

免责声明:我没有编写这个包的代码,我所做的就是将包更新为与 Laravel 6 兼容。

Stylist 是一个与 Laravel 5.5 兼容的主题包,用于为主题化您的 Laravel 应用程序。

安装

通过常用的 composer 命令

composer require sindev95/stylist

这一步不是必须的,因为 Laravel 包自动发现

现在您已经准备好开始了!

设置主题

为了让 Stylist 开始使用主题,您必须至少将一个主题注册到包中,并激活它。

Stylist::registerPath('/absolute/path/to/theme', true);

您的主题应包含一个 theme.json 文件,其中包含一些基本信息

{
    "name": "My theme",
    "description": "This is my theme. There are many like it, but this one is mine."
}

一次只能激活一个主题,因此多次调用激活主题将简单地停用之前激活的主题。

那么,现在加载视图时会发生什么?

Stylist 的工作原理

每次您注册并激活一个新主题时,Stylist 就会知道一个新的位置来搜索视图、样式表、JavaScript 和图像文件。Stylist 还有一些建议的主题目录结构。这样做的原因是让每个主题都遵循相同的做法。例如,当您将 Stylist 指向您的主题目录时,它应该有以下目录(如果需要的话)

/public/stylesheets
/public/javascripts
/public/images
/views/

然后,当您调用如下所示

return View::make('layout.application');

它将在您的主题目录中查找:/views/layout/application.blade.php。简单吗?

在处理资产时,Stylist 需要 Illuminate\Html 库,但您不是使用 HTML 类,而是使用 Stylist 的主题外观

{{ Theme::image('path/to/image.png') }}

这将首先在您的主题目录中查找图像:/public/themes/active-theme/images/path/to/image.png

相同的做法也适用于您的样式、js 以及任何其他静态资产。每次您想使用主题资产时,请确保您使用主题类。

这意味着当您调用,例如,Theme::image 时,您的 HTML 中的输出 URL 实际上看起来像以下

/themes/active-theme/images/path/to/image.png

当然,如果您不想让 Stylist 为您管理这些,只需使用常规的 HTML 外观即可。

我们仍缺少一步 - 那就是发布您的主题资产。这不是一个必要的步骤 - 您可以轻松地将主题的资产从其目录中复制到 Laravel 5 中的公共目录中适当的目录。您只需确保在发布之前,您的主题是可用并注册的。服务提供者是完成此操作的好地方。

public function register()
{
    Stylist::registerPaths(Stylist::discover('/path/to/my/themes'));
}

然后简单地运行发布命令

php artisan stylist:publish

或者,如果您想发布特定的主题

php artisan stylist:publish ThemeName

然后您的主题资产将发布到相关的目录中。需要注意的是,返回的数组必须包含指向主题目录的数组元素,而不是主题的资产目录。这是因为 Stylist 将尝试与主题及其 json 文件一起工作,并发布所需的文件。

主题继承

主题可以有父主题。这意味着您可以通过请求一个视图来使用子主题,Stylist 将首先查找您已激活的子主题,并逐步查找树。如果您喜欢某个主题但只想定制单个视图文件,这将非常棒。

定义父主题

为主题定义父主题非常简单。您只需在 theme.json 中定义父主题即可

"parent": "Another theme"

这将确保 Stylist 将首先在您的主题目录中查找文件和资产,然后查找父主题的目录。如果主题的父主题也有父主题,那么它将继续向上查找树,直到找到文件。

家长无需激活即可使用您主题中的功能。只需激活您的主题即可。然而,它们确实需要注册。这可能由管理您主题的包处理,或者您可以自行注册。

样式表

主题也可以继承样式表。为了实现这一点,子主题必须有一个与父主题相同的样式表名称。如果是这样,则首先加载父CSS文件,然后加载子主题的CSS。这使得通过简单地覆盖某些样式来创建主题的“皮肤”变得非常容易。

辅助方法

Stylist还有一些辅助方法,以简化开发。

Theme::url()

在视图中使用时,此方法将返回主题公共目录的相对路径。您也可以使用它来访问任何文件

Theme::url('favicon.ico')