Skip to content
Merged
26 changes: 26 additions & 0 deletions src/main/java/io/jenkins/plugins/designlibrary/EmptyStates.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package io.jenkins.plugins.designlibrary;

import edu.umd.cs.findbugs.annotations.NonNull;
import hudson.Extension;

@Extension
public class EmptyStates extends UISample {

@Override
public @NonNull String getDisplayName() {
return "Empty States";
}

@Override
public String getIconFileName() {
return "symbol-trash-bin-outline plugin-ionicons-api";
}

@Override
public String getDescription() {
return "For when there is no data, no configuration or no plugins installed that support the required feature an empty state can be provided instead.";
}

@Extension
public static final class DescriptorImpl extends UISampleDescriptor {}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<!--
The MIT License

Copyright 2022 Jenkins project contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-->

<?jelly escape-by-default='true'?>
<j:jelly xmlns:j="jelly:core" xmlns:s="/lib/samples" xmlns:f="/lib/form" xmlns:l="/lib/layout">
<s:layout>
<s:section>
<s:group>
<s:preview>
<l:notice title="${%noticeTitle}" icon="symbol-plugins" />
</s:preview>
<s:code file="empty-states.jelly" />
</s:group>

<p class="jdl-paragraph">${%parameters}</p>
<ul class="jdl-list">
<li>title - ${%parameters.title}</li>
<li>icon - ${%parameters.icon}</li>
</ul>
</s:section>

<s:section title="${%childSectionTitle}" description="${%descriptionChildContent}">
<s:group>
<s:preview>
<l:notice title="${%childNoticeTitle}" icon="symbol-weather-icon-health-00to19">
<button
type="button"
class="jenkins-button jenkins-button--secondary">
${%newJobText}
</button>
</l:notice>
</s:preview>
<s:code file="empty-states-child-content.jelly" />
</s:group>
</s:section>
</s:layout>
</j:jelly>
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
noticeTitle=No plugins installed
parameters=Supported Parameters:
parameters.title=The message displayed in the notice box
parameters.icon=The icon shown with the message
descriptionChildContent=You can also include child content within the notice as a call to action.


childSectionTitle=Child content inside notices
childNoticeTitle=No jobs created
newJobText=Create your first job
6 changes: 6 additions & 0 deletions src/main/resources/scss/components/_component-sample.scss
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,10 @@
animation: none;
box-shadow: var(--jdl-box-shadow);
}

.jenkins-notice {
margin-bottom: 0;
width: 100%;
max-width: 650px;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<l:notice title="No jobs created" icon="symbol-weather-icon-health-00to19">
<button
type="button"
class="jenkins-button jenkins-button--secondary">
Create your first job

</button>
</l:notice>
1 change: 1 addition & 0 deletions src/main/webapp/EmptyStates/empty-states.jelly
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<l:notice title="No plugins installed" icon="symbol-plugins" />