Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

update documentation

  • Loading branch information...
commit 05bf0612f213de60b97b4f28e83b0f3a633ee28d 1 parent d9f8ec1
Nikolay I. Belichuk authored
Showing with 44 additions and 1 deletion.
  1. +44 −1 README.md
View
45 README.md
@@ -1 +1,44 @@
-Accordion menu extension for Yii
+Accordion menu extension for Yii
+------------
+This is 2 level accordeon menu for Yii 1.1.x
+
+Examples:
+ http://belichuk.com/emenu/index.php
+
+How to install:
+
+Download project from github and uncompress to protected/extensions foder.
+This extension has been designed as a widget. Its easy to use. For examples:
+Open your view for edit and define array $items. You can do this in the following way:
+
+$items = array(
+ array(
+ 'name' => 'Google corp',
+ 'link' => 'http://google.com',
+ 'icon' => 'google',
+ 'active' => 'dashboard',
+ 'sub' => array(
+ array(
+ 'name' => 'Gmail',
+ 'link' => 'http://gmail.com',
+ ),
+ array(
+ 'name' => 'Gmap',
+ 'link' => 'http://maps.google.com/',
+ )
+ )
+ )
+);
+
+Array key explanation:
+-Key name - menu item
+-Key link - ancor for menu item
+-Key icon - css suffix for menu item icon
+-Key active - if current used controller / action equals to key active value - than menu item will be expanded -have additional class 'current'
+-Key sub - array with sub menu items
+
+
+Then place next code:
+<?php $this->widget('ext.menu.EMenu', array('items' => $items)); ?>
+
+ Test your application. Take profit
Please sign in to comment.
Something went wrong with that request. Please try again.