infinety-es/stylist-custom

Laravel 5 主题包。

维护者

详细信息

github.com/Krato/stylist

源代码

1.2 2019-10-17 08:29 UTC

This package is auto-updated.

Last update: 2024-09-17 20:08:35 UTC


README

关于

Build Status

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

这是一个用于自定义的分支。请使用原始源代码

https://github.com/floatingpointsoftware/stylist

安装

通过通常的 composer 命令

composer require infinety-es/stylist-custom

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

'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')