summaryrefslogtreecommitdiff
path: root/docs/js/theme.js
blob: d107e34a899f5f315791158088a6d95abe89248d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
$( document ).ready(function() {
    // Shift nav in mobile when clicking the menu.
    $(document).on('click', "[data-toggle='wy-nav-top']", function() {
      $("[data-toggle='wy-nav-shift']").toggleClass("shift");
      $("[data-toggle='rst-versions']").toggleClass("shift");
    });

    // Close menu when you click a link.
    $(document).on('click', ".wy-menu-vertical .current ul li a", function() {
      $("[data-toggle='wy-nav-shift']").removeClass("shift");
      $("[data-toggle='rst-versions']").toggleClass("shift");
    });

    // Keyboard navigation
    document.addEventListener("keydown", function(e) {
      var key = e.which || e.keyCode || window.event && window.event.keyCode;
      var page;
      switch (key) {
          case 78:  // n
              page = $('[role="navigation"] a:contains(Next):first').prop('href');
              break;
          case 80:  // p
              page = $('[role="navigation"] a:contains(Previous):first').prop('href');
              break;
          case 13:  // enter
              if (e.target === document.getElementById('mkdocs-search-query')) {
                e.preventDefault();
              }
              break;
          default: break;
      }
      if ($(e.target).is(':input')) {
        return true;
      } else if (page) {
        window.location.href = page;
      }
    });

    $(document).on('click', "[data-toggle='rst-current-version']", function() {
      $("[data-toggle='rst-versions']").toggleClass("shift-up");
    });

    // Make tables responsive
    $("table.docutils:not(.field-list)").wrap("<div class='wy-table-responsive'></div>");

    $('table').addClass('docutils');

    /*
     * Custom rtd-dropdown
     */
    toggleCurrent = function (elem) {
        var parent_li = elem.closest('li');
        var menu_li = parent_li.next();
        var menu_ul = menu_li.children('ul');
        parent_li.siblings('li').not(menu_li).removeClass('current').removeClass('with-children');
        parent_li.siblings().find('> ul').not(menu_ul).removeClass('current').addClass('toc-hidden');
        parent_li.toggleClass('current').toggleClass('with-children');
        menu_li.toggleClass('current');
        menu_ul.toggleClass('current').toggleClass('toc-hidden');
    }

    // https://github.com/rtfd/sphinx_rtd_theme/blob/master/js/theme.js
    $('.tocbase').find('.toctree-expand').each(function () {
        var link = $(this).parent();
        $(this).on('click', function (ev) {
            console.log('click expand');
            toggleCurrent(link);
            ev.stopPropagation();
            return false;
        });
        link.on('click', function (ev) {
            console.log('click link');
            toggleCurrent(link);
        });
    });
});

window.SphinxRtdTheme = (function (jquery) {
    var stickyNav = (function () {
        var navBar,
            win,
            stickyNavCssClass = 'stickynav',
            applyStickNav = function () {
                if (navBar.height() <= win.height()) {
                    navBar.addClass(stickyNavCssClass);
                } else {
                    navBar.removeClass(stickyNavCssClass);
                }
            },
            enable = function () {
                applyStickNav();
                win.on('resize', applyStickNav);
            },
            init = function () {
                navBar = jquery('nav.wy-nav-side:first');
                win    = jquery(window);
            };
        jquery(init);
        return {
            enable : enable
        };
    }());
    return {
        StickyNav : stickyNav
    };
}($));

// The code below is a copy of @seanmadsen code posted Jan 10, 2017 on issue 803.
// https://github.com/mkdocs/mkdocs/issues/803
// This just incorporates the auto scroll into the theme itself without
// the need for additional custom.js file.
//
$(function() {
  $.fn.isFullyWithinViewport = function(){
      var viewport = {};
      viewport.top = $(window).scrollTop();
      viewport.bottom = viewport.top + $(window).height();
      var bounds = {};
      bounds.top = this.offset().top;
      bounds.bottom = bounds.top + this.outerHeight();
      return ( ! (
        (bounds.top <= viewport.top) ||
        (bounds.bottom >= viewport.bottom)
      ) );
  };
  if( $('li.toctree-l1.current').length && !$('li.toctree-l1.current').isFullyWithinViewport() ) {
    $('.wy-nav-side')
      .scrollTop(
        $('li.toctree-l1.current').offset().top -
        $('.wy-nav-side').offset().top -
        60
      );
  }
});