Merge branch 'master' of git://github.com/white-frame/view

white-frame · Nov 19, 2015 · 5255291 · 5255291
2 parents 44851f0 + 5faeea1
commit 5255291
Showing 1 changed file with 54 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,54 @@
+# View
+
+Set of tools for enhancing Laravel blade view management.
+
+**Install** with composer :
+
+    composer require white-frame/view:0.*
+
+**Register** the service provider :
+
+    WhiteFrame\View\ViewServiceProvider::class
+
+## Registering blade views into sections
+
+The facade `WhiteFrame\View` allows you to register blade view into sections of other blade views. It can be usefull if you have a modular application witch need to dynamically add blade view into generic sections of your application.
+
+### Simple example :
+
+Here is your general `layout.blade.php`, with a `sidebar-menu` section. This section has two default links and need to be filled with other new menu links from dynamic modules :
+
+```html
+<!DOCTYPE html>
+[ ... ]
+<body>
+<section class="sidebar">
+	<ul class="sidebar-menu">
+		@section("sidebar-menu")
+		  <li><a href="{{ url('layout_page_1') }}">Layout page 1<</a></li>
+		  <li><a href="{{ url('layout_page_2') }}">Layout page 2</a></li>
+		@show
+	</ul>
+</section>
+[...]
+</body>
+</html>
+```
+
+In a specific module, create a partial view to be included, for example `my_module::layout.menu` :
+
+```html
+<li><a href="{{ url('my_module/my_page') }}">My module page<</a></li>
+````
+
+And then nest this partial view into the layout section using `WhiteFrame\View` into the service provider of your module :
+
+```php
+public function boot()
+{
+  \WhiteFrame\View::add('layout', 'sidebar-menu', 'my_module::layout.menu');
+  /*
+   * You can use 4 params : nesting view, section name, nested view, array containing datas (optionnal)
+   */
+}
+```