Skip to content
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

[JENKINS-71578] allow making sidepanel sticky #8269

Merged
merged 9 commits into from
Dec 19, 2023
Merged

[JENKINS-71578] allow making sidepanel sticky #8269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3e72a42
[JENKINS-71578] allow making sidebar sticky
mawinter69 Jul 14, 2023
d4706db
improve documentation
mawinter69 Jul 14, 2023
7154060
no sticky for users
mawinter69 Jul 14, 2023
f2ad2de
Merge branch 'master' into JENKINS-71578
mawinter69 Jul 15, 2023
bc8654e
move div to side-panel
mawinter69 Aug 17, 2023
6f42031
unused variable
mawinter69 Aug 17, 2023
5cf4146
Merge branch 'master' into JENKINS-71578
mawinter69 Aug 17, 2023
901be04
guard everything with if mode=side-panel
mawinter69 Aug 18, 2023
d4c42ff
Merge branch 'master' into JENKINS-71578
mawinter69 Aug 23, 2023
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
2 changes: 1 addition & 1 deletion core/src/main/resources/hudson/PluginManager/sidepanel.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ THE SOFTWARE.
-->
<?jelly escape-by-default='true'?>
<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form" xmlns:i="jelly:fmt">
<l:side-panel>
<l:side-panel sticky="true">
<l:app-bar title="${%Plugins}" />
<l:tasks>
<l:task href="${rootURL}/manage/pluginManager/" icon="symbol-download" title="${%Updates}" badge="${app.updateCenter.badge}"/>
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/resources/hudson/model/Job/configure.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ THE SOFTWARE.

<l:breadcrumb title="${%Configuration}" />

<l:side-panel>
<l:side-panel sticky="true">
<l:app-bar title="${%Configure}" />
<div id="tasks" />
</l:side-panel>
Expand Down
12 changes: 2 additions & 10 deletions core/src/main/resources/lib/layout/layout.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,16 +196,8 @@ THE SOFTWARE.

<div id="page-body" class="app-page-body app-page-body--${layoutType} clear">
<j:if test="${layoutType=='two-column'}">
<div id="side-panel" class="app-page-body__sidebar">
<j:set var="mode" value="side-panel" />
<d:invokeBody />

<!-- add YUI logger if debugging YUI -->
<j:if test="${h.yuiSuffix=='debug'}">
<!-- script to transform this into the Logger Console is done in hudson-behavior.js -->
<div id="yui-logreader" style="margin-top:1em"/>
</j:if>
</div>
<j:set var="mode" value="side-panel" />
<d:invokeBody />
</j:if>
<div id="main-panel">
<j:set var="mode" value="main-panel" />
Expand Down
16 changes: 14 additions & 2 deletions core/src/main/resources/lib/layout/side-panel.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,22 @@ THE SOFTWARE.
<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define">
<st:documentation>
Generates a left side content as part of a Jenkins page. Typically known as two-column or left-side + main-content layouts
<st:attribute name="sticky">
Make the side panel sticky. Should not be used on pages that include widgets in the sidepanel and when plugins can
add their own tasks, so the number of tasks is not fixed.
</st:attribute>

</st:documentation>

<j:if test="${mode=='side-panel'}">
<d:invokeBody />
<div id="side-panel" class="app-page-body__sidebar ${attrs.sticky == 'true' ? 'app-page-body__sidebar--sticky' : ''}">
<d:invokeBody />
<!-- add YUI logger if debugging YUI -->
<j:if test="${h.yuiSuffix=='debug'}">
<!-- script to transform this into the Logger Console is done in hudson-behavior.js -->
<div id="yui-logreader" style="margin-top:1em"/>
</j:if>
</div>
</j:if>

</j:jelly>
</j:jelly>
4 changes: 0 additions & 4 deletions war/src/main/js/section-to-sidebar-items.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,9 @@ const HEADER_SELECTOR =
const DEFAULT_ICON = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M262.29 192.31a64 64 0 1057.4 57.4 64.13 64.13 0 00-57.4-57.4zM416.39 256a154.34 154.34 0 01-1.53 20.79l45.21 35.46a10.81 10.81 0 012.45 13.75l-42.77 74a10.81 10.81 0 01-13.14 4.59l-44.9-18.08a16.11 16.11 0 00-15.17 1.75A164.48 164.48 0 01325 400.8a15.94 15.94 0 00-8.82 12.14l-6.73 47.89a11.08 11.08 0 01-10.68 9.17h-85.54a11.11 11.11 0 01-10.69-8.87l-6.72-47.82a16.07 16.07 0 00-9-12.22 155.3 155.3 0 01-21.46-12.57 16 16 0 00-15.11-1.71l-44.89 18.07a10.81 10.81 0 01-13.14-4.58l-42.77-74a10.8 10.8 0 012.45-13.75l38.21-30a16.05 16.05 0 006-14.08c-.36-4.17-.58-8.33-.58-12.5s.21-8.27.58-12.35a16 16 0 00-6.07-13.94l-38.19-30A10.81 10.81 0 0149.48 186l42.77-74a10.81 10.81 0 0113.14-4.59l44.9 18.08a16.11 16.11 0 0015.17-1.75A164.48 164.48 0 01187 111.2a15.94 15.94 0 008.82-12.14l6.73-47.89A11.08 11.08 0 01213.23 42h85.54a11.11 11.11 0 0110.69 8.87l6.72 47.82a16.07 16.07 0 009 12.22 155.3 155.3 0 0121.46 12.57 16 16 0 0015.11 1.71l44.89-18.07a10.81 10.81 0 0113.14 4.58l42.77 74a10.8 10.8 0 01-2.45 13.75l-38.21 30a16.05 16.05 0 00-6.05 14.08c.33 4.14.55 8.3.55 12.47z" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="32"/></svg>`;

window.addEventListener("load", function () {
const sidebar = document.querySelector("#side-panel");
const sidebarItems = document.querySelector("#tasks");
const sectionHeaders = document.querySelectorAll(HEADER_SELECTOR);

// Ensure sidebar is sticky
sidebar.classList.add("app-page-body__sidebar--sticky");

// Create the sidebar items
sectionHeaders.forEach(function (header, i) {
const headerId = toId(header.textContent);
Expand Down