-
Notifications
You must be signed in to change notification settings - Fork 86
Added documentation for Empty States #407
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.
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
Merged
Merged
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
e9be91f
Added documentation for Empty States
giovanni-vaccarino 9cf061e
Add missing period to a description to pass ContestTest ; Fixed the a…
giovanni-vaccarino dbdbabc
Apply spotlsess formatting
giovanni-vaccarino 4434b8e
Removed text parameter ; Enhanced second example usage
giovanni-vaccarino a03e77a
Update src/main/webapp/EmptyStates/empty-states-child-content.jelly
giovanni-vaccarino ae13d36
Update src/main/resources/io/jenkins/plugins/designlibrary/EmptyState…
giovanni-vaccarino ebc9e7c
Apply suggestions from code review
timja a25027b
Update src/main/resources/io/jenkins/plugins/designlibrary/EmptyState…
timja 91839bf
Update src/main/webapp/EmptyStates/empty-states-child-content.jelly
timja File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
26 changes: 26 additions & 0 deletions
26
src/main/java/io/jenkins/plugins/designlibrary/EmptyStates.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 {} | ||
| } |
58 changes: 58 additions & 0 deletions
58
src/main/resources/io/jenkins/plugins/designlibrary/EmptyStates/index.jelly
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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> |
10 changes: 10 additions & 0 deletions
10
src/main/resources/io/jenkins/plugins/designlibrary/EmptyStates/index.properties
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| <l:notice title="No plugins installed" icon="symbol-plugins" /> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.