Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit e7da1b8
Showing
21 changed files
with
3,747 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
node_modules | ||
waslidemenu.sublime-workspace | ||
waslidemenu.sublime-project |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
Copyright 2014 webAsyst, | ||
http://www.webasyst.com | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining | ||
a copy of this software and associated documentation files (the | ||
"Software"), to deal in the Software without restriction, including | ||
without limitation the rights to use, copy, modify, merge, publish, | ||
distribute, sublicense, and/or sell copies of the Software, and to | ||
permit persons to whom the Software is furnished to do so, subject to | ||
the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be | ||
included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | ||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | ||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,304 @@ | ||
# waSlideMenu | ||
|
||
jQuery плагин, который делает скучное и объёмное многоуровневое меню, удобным и компактным. Прототип: https://www.facebook.com/help. | ||
|
||
### Опции | ||
|
||
#### Скорость слайда | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
slideSpeed: 500 | ||
}); | ||
``` | ||
|
||
По умолчанию ```400```. | ||
|
||
#### Эффект слайда | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
slideEasing: 'linear' | ||
}); | ||
``` | ||
|
||
#### Контент для ссылки "Назад" | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
backLinkContent: 'Take me back, sir.' | ||
}); | ||
``` | ||
|
||
По умолчанию ```Back```. | ||
|
||
#### Выбор расположения ссылки назад | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
backOntTop: true | ||
}); | ||
``` | ||
|
||
По умолчанию ```false```. | ||
|
||
#### Класс для "текущего" пункта меню | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
selectedClass: 'selected-menu' | ||
}); | ||
``` | ||
По умолчанию ```'selected'```. | ||
|
||
#### Селектор контейнера, куда загружать контент "текущего" пункта меню | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
loadContainer : '#content' | ||
}); | ||
``` | ||
По умолчанию ```''```, то есть ничего не загружается. | ||
|
||
#### Минимальная высота меню | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
minHeightMenu : 400 | ||
}); | ||
``` | ||
По умолчанию ```0```, то есть высота может быть любой. | ||
|
||
#### Автоматическая подстройка под размер меню | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
autoHeightMenu : true | ||
}); | ||
``` | ||
По умолчанию ```true```, высота меню подстраивается под высоту текущего подменю. | ||
|
||
#### URL исключения (не буду загружаться по ссылкам из меню) | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
excludeUri : ['/dont-load/', '#pleasedontloadme'] | ||
}); | ||
``` | ||
Адреса ```'/dont-load/'``` и ```'#pleasedontloadme'``` не будут подгружаться в ```loadContainer```. По умолчанию ```['/', '#']```. | ||
|
||
#### Подгружать контент только последних пунктов меню | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
loadOnlyLatest : true | ||
}); | ||
``` | ||
По умолчанию ```false```. Если установлено в ```true```, то меню будет прокурчиваться, не загружая ссылки, пока мы не дойдем до крайнего пункта меню. | ||
|
||
#### Селектор меню | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
menuSelector : '.i-am-menu' | ||
}); | ||
``` | ||
По умолчанию ```'ul'```. | ||
|
||
#### Селектор пунктов меню | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
itemSelector : '.i-am-menu-item' | ||
}); | ||
``` | ||
По умолчанию ```'li'```. | ||
|
||
#### Устанавливать title для страницы (из атрибута меню title) | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
setTitle : true | ||
}); | ||
``` | ||
По умолчанию ```false```. После загрузки url из пункта меню, устанавливается Title страницы, как в атрибуте title ссылки из пункта меню. | ||
|
||
#### Скорость прокрутки страницы вверх до "текущего" пункта меню | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
scrollToTopSpeed : 100 | ||
}); | ||
``` | ||
По умолчанию ```0```. Возникают моменты, когда после слайда к следующему подменю его пункты пропадают из видимой области. В этом случае страница прокрутиться наверх, до выбранного пункта меню. | ||
|
||
#### Callbacks | ||
|
||
##### После инициализации | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
onInit : function(){ | ||
alert('Here I am!'); | ||
} | ||
}); | ||
``` | ||
|
||
##### После слайда на следующее подменю | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
onSlideForward : function(){ | ||
alert('I slide forward (deeper)!'); | ||
} | ||
}); | ||
``` | ||
|
||
##### После слайда на меню уровнем выше | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
onSlideBack : function(){ | ||
alert('I slide back (bubling)!'); | ||
} | ||
}); | ||
``` | ||
|
||
##### После завершения прокрутки | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
afterSlide : function(){ | ||
alert('Yep! I just slide!!'); | ||
} | ||
}); | ||
``` | ||
|
||
##### Всегда, незвасимо от результат загрузки URL | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
afterLoadAlways : function(){ | ||
alert('You URL request just completed!'); | ||
} | ||
}); | ||
``` | ||
|
||
##### После успешной загрузки URL | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
afterLoadDone : function(){ | ||
alert('Nice URL! 200 OK!'); | ||
} | ||
}); | ||
``` | ||
|
||
##### После провальной загрузки URL | ||
|
||
```javascript | ||
$('#menu').waSlideMenu({ | ||
afterLoadFail : function(){ | ||
alert('Bad URL :('); | ||
} | ||
}); | ||
``` | ||
|
||
#### Event triggers | ||
|
||
Так же доступны следующие события ```onInit.waSlideMenu```, ```afterLoadDone.waSlideMenu```, ```afterLoadFail.waSlideMenu```, ```afterLoadAlways.waSlideMenu```. | ||
|
||
```javascript | ||
$('#menu').on('onInit.waSlideMenu', function(){ | ||
alert('After INIT waSlideMenu Event'); | ||
}).on('afterLoadDone.waSlideMenu', function(){ | ||
alert('After URL load success Event'); | ||
}).on('afterLoadFail.waSlideMenu', function(){ | ||
alert('After URL load fails Event'); | ||
}).on('afterLoadAlways.waSlideMenu', function(){ | ||
alert('After URL request completed Event'); | ||
}); | ||
``` | ||
|
||
### И еще раз | ||
|
||
* Не зависит от тегов, главное чтобы меню было вложенным | ||
|
||
```html | ||
<ul> | ||
<li> | ||
<a href="#1">1</a> | ||
<ul> | ||
<li><a href="#1.1">1.1</a></li> | ||
<li><a href="#1.2">1.2</a></li> | ||
</ul> | ||
<li><a href="#2">2</a></li> | ||
<li><a href="#3">3</a></li> | ||
</li> | ||
</ul> | ||
``` | ||
```javascript | ||
$('#menu').waSlideMenu({}); | ||
``` | ||
|
||
```html | ||
<div class="menu"> | ||
<div class="item"> | ||
<a href="#1">1</a> | ||
<div class="menu"> | ||
<div class="item"><a href="#1.1">1.1</a></li> | ||
<div class="item"><a href="#1.2">1.2</a></li> | ||
</div class="menu"> | ||
<div class="item"><a href="#2">2</a></li> | ||
<div class="item"><a href="#3">3</a></li> | ||
</li> | ||
</ul> | ||
``` | ||
```javascript | ||
$('#menu').waSlideMenu({ | ||
menuSelector : '.menu', | ||
itemSelector : '.item' | ||
}); | ||
``` | ||
|
||
* Опции и сallback можно устанваливать после инициализации плагина | ||
|
||
```javascript | ||
var slidemenu = $('#menu').waSlideMenu({}); | ||
slidemenu.waSlideMenu({ | ||
slideSpeed : 3000, // veeeeeeeery smooooooth | ||
afterSlide : function(){ | ||
alert('Yeah!!11 This was coooool smoooth sliiide!'); | ||
} | ||
}); | ||
``` | ||
|
||
* На одной странице может быть сколько угодно меню | ||
|
||
|
||
## Установка | ||
|
||
Добавьте файл стилей | ||
```html | ||
<link rel="stylesheet" href="/path/to/waslidemenu.css"> | ||
``` | ||
|
||
И js файлы *после* библиотеки jQuery: | ||
|
||
```html | ||
<script src="jquery.js" type="text/javascript"></script> | ||
<script src="/path/to/jquery.waslidemenu.js" type="text/javascript"></script> | ||
``` | ||
|
||
```javascript | ||
$(document).ready(function(){ | ||
$(menu-selector).waSlideMenu({}); | ||
}); | ||
``` | ||
|
||
## Совместимость | ||
|
||
* IE9+ | ||
* Google Chrome | ||
* Firefox | ||
* надо еще потестировать... |
Oops, something went wrong.