Skip to content

Avoid double click in a sidebar link after search #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 21, 2015
Merged

Avoid double click in a sidebar link after search #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 29 additions & 7 deletions lib/ex_doc/formatter/html/templates/js/app.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@
});
}

/**
* When the search field is empty show the children nodes of the #full_list
*
* Also removes the class .search_uncollapsed, .in_search, .found and .loading
* among other things to reset the sidebar default status
*/
function showAllResults() {
clearTimeout(inSearch);
inSearch = defaultSearchItemTimeOut;
Expand All @@ -56,6 +62,12 @@
highlight();
}

/**
* If no results were found, shows a message to the user.
*
* Also remove the 'loading' icon and clear the timeout returned
* initially by setTimeout.
*/
function searchDone() {
highlight(true);
if ($('#full_list li.found').size() === 0) {
Expand All @@ -75,6 +87,7 @@
searchName,
matchString,
matchRegexp;

for (i = 0; i < searchCache.length / 50; i += 1) {
item = searchCache[searchIndex];
searchName = (searchString.indexOf('.') !== -1 ? item.fullName : item.name);
Expand Down Expand Up @@ -102,12 +115,19 @@
}, defaultSearchItemTimeOut);
}

/**
* Fill the searchCache Array with the links found inside of the #full_list
*
* Define the initial set of events for the search field.
*/
function fullListSearch() {
// generate cache
searchCache = [];

$('#full_list li').each(function () {
var link = $(this).find('a.object_link:first'),
fullName;

if (link.attr('title')) {
fullName = link.attr('title').split(' ')[0];
searchCache.push({
Expand All @@ -120,20 +140,21 @@
});

$('#search input').keypress(function (e) {
if (e.which === 13) {
if (e.which === 13) { // enter
$('#full_list li.found:first').find('a.object_link:first').click();
}
});

$('#search input').bind("keyup search reset change propertychange input paste", function (evnt) {
if ((evnt.keyCode > ignoreKeyCodeMin && evnt.keyCode < ignoreKeyCodeMax) || evnt.keyCode === commandKey) {
$('#search input').on('input', function (e) {
if ((e.keyCode > ignoreKeyCodeMin && e.keyCode < ignoreKeyCodeMax) || e.keyCode === commandKey) {
return;
}

$('#search').addClass('loading');
searchString = this.value;
caseSensitiveMatch = searchString.match(/[A-Z]/) !== null;
regexSearchString = escapeText(searchString);

if (searchString === "") {
showAllResults();
} else {
Expand All @@ -152,7 +173,7 @@
}

function linkList() {
$('#full_list li, #full_list li a:last').click(function (evt) {
$('#full_list li, #full_list li a:last').click(function (e) {
var toggle,
win;

Expand All @@ -162,7 +183,7 @@

if (this.tagName.toLowerCase() === "li") {
toggle = $(this).children('a.toggle');
if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {
if (toggle.size() > 0 && e.pageX < toggle.offset().left) {
toggle.click();
return false;
}
Expand All @@ -173,6 +194,7 @@
}

win = window.top.frames.main || window.parent;

if (this.tagName.toLowerCase() === "a") {
clicked = $(this).parent('li').addClass('clicked');
win.location = this.href;
Expand Down Expand Up @@ -200,8 +222,8 @@
}

function escapeShortcut() {
$(document).keydown(function (evt) {
if (evt.which === 27) {
$(document).keydown(function (e) {
if (e.which === 27) { // escape
$('#search_frame', window.top.document).slideUp(100);
$('#search a', window.top.document).removeClass('active inactive');
$(window.top).focus();
Expand Down
6 changes: 3 additions & 3 deletions lib/ex_doc/formatter/html/templates/sidebar_template.eex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
</h2>

<div class="nav">
<span class="selected"><a id="modules_list" href="#">Modules</a></span>
<span><a id="exceptions_list" href="#">Exceptions</a></span>
<span><a id="protocols_list" href="#">Protocols</a></span>
<span class="selected"><a id="modules_list" href="#full_list">Modules</a></span>
<span><a id="exceptions_list" href="#full_list">Exceptions</a></span>
<span><a id="protocols_list" href="#full_list">Protocols</a></span>
</div>

<div id="search"><input type="search" id="search_field" placeholder="Search" autocomplete="off" autofocus="autofocus" results="0" /></div>
Expand Down