README

关于

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 库，但您不使用 HTML 类，而是使用 Stylist 的 Theme 门面

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

它首先会在您的主题目录中查找该图像：/public/themes/active-theme/images/path/to/image.png

这种相同的做法也应用于您的样式、js 和任何其他静态资源。每次您想要使用主题资源时，请确保您使用 Theme 类。

这意味着当您调用 say，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

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

主题继承

主题可以有父主题。这意味着您可以请求一个视图，Stylist 将首先查看您已激活的子主题，然后按顺序向上查找。如果您喜欢某个主题但只想自定义单个视图文件，这真是太棒了。

定义父主题

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

"parent": "Another theme"

这将确保Stylist首先在您的主题目录中查找文件和资源，然后才会查找父主题目录。如果您的主题的父主题还有父主题，它将继续向上查找直到找到文件。

父主题不需要被激活，您的主题就可以使用它们。只需激活您的主题即可。但是，它们确实需要注册。这可以由管理您主题的包处理，或者您可以自行注册。

样式表

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

辅助方法

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

Theme::url()

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

Theme::url('favicon.ico')