capham/stylist

该软件包最新版本(1.0.0)没有可用的许可证信息。

Laravel 主题软件包。

1.0.0 2020-03-13 03:34 UTC

This package is auto-updated.

Last update: 2024-09-17 18:38:46 UTC


README

关于

Build Status

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

安装

通过常规 composer 命令

composer require floatingpoint/stylist

然后,确保通过更新您的 config/app.php 文件,使 Stylist 服务提供程序对您的应用程序可用

'FloatingPoint\Stylist\StylistServiceProvider',

现在您可以开始使用了!

设置主题

为了让 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 库,但您可以使用 Stylist 的主题外观而不是 HTML 类

{{ 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

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

主题继承

主题可以有父主题。这意味着您可以请求一个视图,Stylist 将首先查找您激活的子主题,然后逐级向上查找。如果您喜欢某个主题但只想定制单个视图文件,这将非常棒。

定义父主题

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

"parent": "Another theme"

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

父主题不需要激活即可使用。只需要激活您的主题即可。然而,它们确实需要注册。这可能由管理您主题的包来处理,或者您可以自己注册。

样式表

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

辅助方法

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

Theme::url()

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

Theme::url('favicon.ico')