sindev95/stylist

Laravel主题包。

dev-master 2024-02-21 17:40 UTC

This package is auto-updated.

Last update: 2024-09-21 19:14:59 UTC


README

关于

Build Status

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

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

安装

通过常规composer命令

composer require deltaspikeme/stylist-theme

由于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外观

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