mirror of
https://github.com/ruby/ruby.git
synced 2025-08-23 21:14:23 +02:00
c5f0fe1285
(https://github.com/ruby/rdoc/pull/1176) * Move method source block to the top Currently, if a method description is long (e.g. `Array.new`), users need to click the method toggle button next to the method title, and then scroll down to the source code expanded below the description. This commit changes the behavior so that the source code is expanded immediately below the method title. * Update method toggle's interface 1. Display the method toggle button by default instead of displaying on hover 2. Only toggle the source code when clicking the method toggle button, not when clicking the entire method title section. This will allow us to display an anchor link next to the method title 3. Simplify the toggle source button's appearance * Use details tag for method toggling * Rename method-click-advice to method-source-toggle * Improve method controls' display on mobile By moving the method controls out of the method header, we can display them to the right of the method name on desktop, and below the method name on mobile. * Add "Example" label to example code blocks The label should help users distinguish example code blocks from other code blocks, such as method source code. It's only applied to Ruby code examples. * Revert "Add "Example" label to example code blocks" This reverts commit69fc9ce6a3. * Give source code blocks a different background color * Change targeted method's highlighting color to work better with the new method sourcee608a84af3
114 lines
3.1 KiB
JavaScript
114 lines
3.1 KiB
JavaScript
/**
|
|
*
|
|
* Darkfish Page Functions
|
|
* $Id: darkfish.js 53 2009-01-07 02:52:03Z deveiant $
|
|
*
|
|
* Author: Michael Granger <mgranger@laika.com>
|
|
*
|
|
*/
|
|
|
|
/* Provide console simulation for firebug-less environments */
|
|
/*
|
|
if (!("console" in window) || !("firebug" in console)) {
|
|
var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml",
|
|
"group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"];
|
|
|
|
window.console = {};
|
|
for (var i = 0; i < names.length; ++i)
|
|
window.console[names[i]] = function() {};
|
|
};
|
|
*/
|
|
|
|
|
|
function showSource( e ) {
|
|
var target = e.target;
|
|
while (!target.classList.contains('method-detail')) {
|
|
target = target.parentNode;
|
|
}
|
|
if (typeof target !== "undefined" && target !== null) {
|
|
target = target.querySelector('.method-source-code');
|
|
}
|
|
if (typeof target !== "undefined" && target !== null) {
|
|
target.classList.toggle('active-menu')
|
|
}
|
|
};
|
|
|
|
function hookSourceViews() {
|
|
document.querySelectorAll('.method-source-toggle').forEach(function (codeObject) {
|
|
codeObject.addEventListener('click', showSource);
|
|
});
|
|
};
|
|
|
|
function hookSearch() {
|
|
var input = document.querySelector('#search-field');
|
|
var result = document.querySelector('#search-results');
|
|
result.classList.remove("initially-hidden");
|
|
|
|
var search_section = document.querySelector('#search-section');
|
|
search_section.classList.remove("initially-hidden");
|
|
|
|
var search = new Search(search_data, input, result);
|
|
|
|
search.renderItem = function(result) {
|
|
var li = document.createElement('li');
|
|
var html = '';
|
|
|
|
// TODO add relative path to <script> per-page
|
|
html += '<p class="search-match"><a href="' + index_rel_prefix + this.escapeHTML(result.path) + '">' + this.hlt(result.title);
|
|
if (result.params)
|
|
html += '<span class="params">' + result.params + '</span>';
|
|
html += '</a>';
|
|
|
|
|
|
if (result.namespace)
|
|
html += '<p class="search-namespace">' + this.hlt(result.namespace);
|
|
|
|
if (result.snippet)
|
|
html += '<div class="search-snippet">' + result.snippet + '</div>';
|
|
|
|
li.innerHTML = html;
|
|
|
|
return li;
|
|
}
|
|
|
|
search.select = function(result) {
|
|
window.location.href = result.firstChild.firstChild.href;
|
|
}
|
|
|
|
search.scrollIntoView = search.scrollInWindow;
|
|
};
|
|
|
|
function hookFocus() {
|
|
document.addEventListener("keydown", (event) => {
|
|
if (document.activeElement.tagName === 'INPUT') {
|
|
return;
|
|
}
|
|
if (event.key === "/") {
|
|
event.preventDefault();
|
|
document.querySelector('#search-field').focus();
|
|
}
|
|
});
|
|
}
|
|
|
|
function hookSidebar() {
|
|
var navigation = document.querySelector('#navigation');
|
|
var navigationToggle = document.querySelector('#navigation-toggle');
|
|
|
|
navigationToggle.addEventListener('click', function() {
|
|
navigation.hidden = !navigation.hidden;
|
|
navigationToggle.ariaExpanded = navigationToggle.ariaExpanded !== 'true';
|
|
});
|
|
|
|
var isSmallViewport = window.matchMedia("(max-width: 1024px)").matches;
|
|
if (isSmallViewport) {
|
|
navigation.hidden = true;
|
|
navigationToggle.ariaExpanded = false;
|
|
}
|
|
}
|
|
|
|
document.addEventListener('DOMContentLoaded', function() {
|
|
hookSourceViews();
|
|
hookSearch();
|
|
hookFocus();
|
|
hookSidebar();
|
|
});
|