graham-campbell / navigation
Navigation 是 Laravel 5 的导航栏生成器
Requires
- php: >=5.5.9
- illuminate/contracts: 5.0.*|5.1.*
- illuminate/http: 5.0.*|5.1.*
- illuminate/support: 5.0.*|5.1.*
Requires (Dev)
- graham-campbell/testbench: ~3.0
- mockery/mockery: ^0.9.4
- phpunit/phpunit: ^4.7.6
This package is not auto-updated.
Last update: 2022-02-01 12:30:23 UTC
README
Laravel Navigation 由 Graham Campbell 创建并维护,是一个用于 Laravel 5 的导航栏生成器。您可以自由查看 发布版本、许可证 和 贡献指南。
安装
需要 PHP 5.5+ 或 HHVM 3.6+ 以及 Composer。
要获取 Laravel Navigation 的最新版本,只需将以下行添加到您的 composer.json
文件的 require 块中:
"graham-campbell/navigation": "~2.2"
然后您需要运行 composer install
或 composer update
以下载它并更新自动加载器。
一旦安装了 Laravel Navigation,您需要注册服务提供者。打开 config/app.php
并将以下内容添加到 providers
键中。
'GrahamCampbell\Navigation\NavigationServiceProvider'
如果您喜欢,可以在 config/app.php
文件的 aliases
键中注册 Navigation 门面。
'Navigation' => 'GrahamCampbell\Navigation\Facades\Navigation'
配置
Laravel Navigation 不需要配置。只需遵循简单的安装说明即可。
使用
导航
这是最感兴趣的类。它绑定到 ioc 容器中的 'navigation'
,可以通过 Facades\Navigation
门面访问。有三个公开方法值得关注。
'addToMain'
和 'addToBar'
方法将以指定方式将项目添加到内部主导航数组中。这两个方法都接受三个参数。除了第一个参数外,其他都是可选的。第一个参数必须是数组。它必须有 'slug'
键或 'url'
键,其中 slug 是相对于基础 URL 的目标 URL,而 URL 是您可能指定的完整 URL(用于链接到应用程序外的某处)。它还必须有一个 'title'
键,用于指定标题,您还可以可选地添加一个 'icon'
键,这将添加相关的字体图标到混合中。第二个参数指定您想添加到哪个导航栏。默认为 'default'
,但您可能有多个导航栏,例如,Bootstrap CMS 有一个 'admin'
导航栏。最后一个参数指定项目是否应添加到内部数组的前面。默认为 false
。
第三种方法是 'render'
,接受三个参数。所有参数都是可选的。第一个参数用于选择要返回的主要导航栏。默认设置为 'default'
。第三个参数用于选择要返回的栏导航栏。默认设置为 false
,表示不返回任何导航栏。您可以将其设置为任何字符串以返回相应的导航栏。最后一个参数是要传递给导航视图的变量数组。默认为 ['title' => 'Navigation', 'side' => 'dropdown', 'inverse' => true]
。
请注意,被称为 'main'
的导航栏是将在页面顶部横向显示的导航栏,而被称为 'bar'
的导航栏是将在侧边显示的下拉菜单。在默认视图(针对 Twitter Bootstrap 3)的上下文中,这些也被提及。
另外,请注意,render 方法会触发事件,您可以在懒加载中调用 addTo 方法。触发的事件是 'navigation.main'
和 'navigation.bar'
,它们在 render 方法开始处理每个导航栏之前触发。还会触发所选导航栏的名称。查看 源代码。
Facades\Navigation
这个外观将动态地将静态方法调用传递到 ioc 容器中的 'navigation'
对象,默认是 Navigation
类。
NavigationServiceProvider
这个类没有感兴趣的公共方法。这个类应该添加到 config/app.php
中的 providers 数组。这个类将设置 ioc 绑定。
License
Laravel Navigation 使用 MIT 许可协议 (MIT) 许可。