Skip to content

Commit c17deff

Browse files
jonathanhefnerjonathanhefner
committed
Redesign banner and mobile menu bar
This commit redesigns the banner that was formerly displayed at the top of each page. The banner and the logo are now integrated, and they also serve as the mobile menu bar. The `menu.svg` and `close.svg` files are from [Feather icons][feather] v4.29.0, and are [licensed under the MIT license][license]. [feather]: https://feathericons.com/ [license]: https://github.com/feathericons/feather/blob/v4.29.0/LICENSE
1 parent 3feb058 commit c17deff

File tree

11 files changed

+247
-385
lines changed

11 files changed

+247
-385
lines changed

‎lib/rdoc/generator/template/rails/_context.rhtml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id="content">
1+
<div id="context">
22
<% unless (description = context.description).empty? %>
33
<% unless context.comment_title %>
44
<h1><%= context.title %></h1>

‎lib/rdoc/generator/template/rails/_panel.rhtml‎

Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,34 @@
33
<div id="version-badge"><%= project_version %></div>
44
<% end %>
55

6-
<input type="checkbox" id="hamburger" class="panel_checkbox">
7-
<label class="panel_mobile_button" for="hamburger"><span></span> Menu</label>
8-
<nav class="panel panel_tree" id="panel" data-turbo-permanent>
9-
<div class="logo">
10-
<a href="/">
11-
<img width="300" src="/i/logo.svg" alt="<%= project_name %>">
12-
</a>
6+
<nav id="panel" class="panel">
7+
<div class="banner">
8+
<div class="banner__segment">
9+
<label class="banner__menu-button" for="panel__state"></label>
10+
</div>
11+
<div class="banner__segment">
12+
<a class="banner__logo" href="/"><img src="/i/logo.svg" alt="<%= project_name %>"></a>
13+
<span class="banner__version" title="<%= project_git_head %>"><%= project_version %></span>
14+
</div>
1315
</div>
14-
<div class="header">
15-
<input type="text" placeholder="Search (/) for a class, method, ..." autosave="searchdoc" results="10" id="search" autocomplete="off" tabindex="-1" />
16-
<label class="panel_mobile_button_close" for="hamburger"><span></span> Close</label>
17-
</div>
18-
<div class="tree">
19-
<ul>
20-
</ul>
21-
</div>
22-
<div class="result">
23-
<ul>
24-
</ul>
16+
17+
<input id="panel__state" type="checkbox">
18+
19+
<div id="panel__tray" class="panel__tray" data-turbo-permanent>
20+
<input id="search" type="text" autocomplete="off" tabindex="-1" autosave="searchdoc" results="10"
21+
placeholder="Search (/) for a class, method, ...">
22+
23+
<div class="panel__tree">
24+
<div class="result hidden">
25+
<ul>
26+
</ul>
27+
</div>
28+
<div class="tree">
29+
<ul>
30+
</ul>
31+
</div>
32+
</div>
33+
34+
<a id="links" href="links.html">index</a>
2535
</div>
26-
<a href="links.html" id="links">index</a>
2736
</nav>

‎lib/rdoc/generator/template/rails/class.rhtml‎

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -13,31 +13,21 @@
1313
</head>
1414

1515
<body>
16-
<a class="sr-only sr-only-focusable" href="#content" data-turbo="false">Skip to Content</a>
16+
<a class="sr-only sr-only-focusable" href="#context" data-turbo="false">Skip to Content</a>
1717
<a class="sr-only sr-only-focusable" href="#search" data-turbo="false">Skip to Search</a>
1818

1919
<%= include_template '_panel.rhtml' %>
2020

21-
<div class="banner">
22-
<% if project_name %>
23-
<div>
24-
<%= project_name %>
25-
<span title="<%= project_git_head %>"><%= project_version %></span>
26-
</div>
27-
<% end %>
21+
<main id="content">
22+
<div class="content__full-name">
23+
<span class="qualifier"><%= klass.type %></span>
24+
<%= full_name klass %>
25+
<% if !klass.module? && superclass = klass.superclass %>
26+
<span class="qualifier">&lt;</span>
27+
<%= superclass.is_a?(String) ? full_name(superclass) : link_to(superclass) %>
28+
<% end %>
29+
</div>
2830

29-
<h2>
30-
<span class="type"><%= klass.module? ? 'Module' : 'Class' %></span>
31-
<%= full_name klass %>
32-
<% if klass.type == "class" && superclass = klass.superclass %>
33-
<span class="parent">
34-
&lt; <%= superclass.is_a?(String) ? full_name(superclass) : link_to(superclass) %>
35-
</span>
36-
<% end %>
37-
</h2>
38-
</div>
39-
40-
<main id="bodyContent">
4131
<%= include_template '_context.rhtml', {:context => klass} %>
4232

4333
<div class="sectiontitle">Definition files</div>

‎lib/rdoc/generator/template/rails/file.rhtml‎

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,33 +10,21 @@
1010
</head>
1111

1212
<body>
13-
<a class="sr-only sr-only-focusable" href="#content" data-turbo="false">Skip to Content</a>
13+
<a class="sr-only sr-only-focusable" href="#context" data-turbo="false">Skip to Content</a>
1414
<a class="sr-only sr-only-focusable" href="#search" data-turbo="false">Skip to Search</a>
1515

1616
<%= include_template '_panel.rhtml' %>
1717

18-
<div class="banner">
19-
<% if project_name %>
20-
<div>
21-
<%= project_name %>
22-
<span title="<%= project_git_head %>"><%= project_version %></span>
23-
</div>
24-
<% end %>
18+
<main id="content">
19+
<h1 class="content__full-name">
20+
<span class="qualifier">File</span>
21+
<%= full_name file %>
22+
</h1>
2523

26-
<h2>
27-
<%= h file.name %>
28-
</h2>
29-
<ul class="files">
30-
<li>
31-
<%= full_name file %>
32-
<% if github = github_url(file.relative_name) %>
33-
<a href="<%= github %>" target="_blank" class="github_url">on GitHub</a>
34-
<% end %>
35-
</li>
36-
</ul>
37-
</div>
24+
<% if source_url = github_url(file.relative_name) %>
25+
<p><%= link_to_external "View on GitHub", source_url %></p>
26+
<% end %>
3827

39-
<main id="bodyContent">
4028
<%= include_template '_context.rhtml', {:context => file} %>
4129
</main>
4230
</body>

‎lib/rdoc/generator/template/rails/index.rhtml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
</head>
99

1010
<body>
11-
<a class="sr-only sr-only-focusable" href="#content" data-turbo="false">Skip to Content</a>
11+
<a class="sr-only sr-only-focusable" href="#context" data-turbo="false">Skip to Content</a>
1212
<a class="sr-only sr-only-focusable" href="#search" data-turbo="false">Skip to Search</a>
1313

1414
<%= include_template '_panel.rhtml' %>
1515

16-
<main id="bodyContent">
16+
<main id="content">
1717
<%= include_template '_context.rhtml', {:context => index } %>
1818
</main>
1919
</body>

0 commit comments

Comments
 (0)