floatingpoint / stylist
Laravel 5 主题包。
Requires
- php: ^7.0
- illuminate/support: ~5.5
- laravelcollective/html: ~5.5
Requires (Dev)
- mockery/mockery: ^0.9.5
- orchestra/testbench: ~3.0
- phpunit/phpunit: ~6.0
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 库,但您应该使用 Stylist 的 Theme 门面而不是 HTML 类
{{ Theme::image('path/to/image.png') }}
它将首先在您的主题目录中查找图像:/public/themes/active-theme/images/path/to/image.png
相同的做法也适用于您的样式、js 以及任何其他静态资产。每当您想使用主题资产时,请确保您使用 Theme 类。
这意味着当您调用 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
然后您的主题资产将被发布到相关的目录。重要的是要注意,返回的数组必须包含指向 THEME 目录的数组元素,而不是主题的 ASSETS 目录。这是因为 Stylist 将尝试与主题及其 json 文件一起工作,并发布所需的文件。
主题继承
主题可以有父主题。这意味着您可以请求一个视图,Stylist 将首先查看您已激活的子主题,然后沿着树向上查找。如果您喜欢某个主题但只想自定义单个视图文件,这真是太好了。
定义父主题
为主题定义父主题非常简单。你只需在theme.json文件中定义父主题即可。
"parent": "Another theme"
这将确保Stylist首先在您的主题目录中查找文件和资源,然后才会查找父主题的目录。如果您的主题的父主题也有父主题,那么它将继续向上查找直到找到文件。
父主题不需要激活,您的主题即可使用它们。但是,它们确实需要被注册。这可能由管理您主题的包处理,或者您可以自行注册。
样式表
主题也可以继承样式表。为了实现这一点,子主题必须有一个与父主题完全相同的样式表名称。如果是这种情况,则首先加载父CSS文件,然后是子主题的CSS。这使得通过简单地覆盖某些样式来创建主题的“皮肤”变得非常容易。
辅助方法
Stylist还有一些辅助方法,以简化开发。
Theme::url()
在视图中使用时,此方法将返回主题公共目录的相对路径。您也可以使用它来访问任何文件
Theme::url('favicon.ico')