fix: job result (output) descriptions are displayed

fixes #108
daisy · Sep 18, 2023 · 8006f57 · 8006f57
1 parent 9da817c
commit 8006f57
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 2 deletions.
diff --git a/src/renderer/components/JobDetailsPane/Results.tsx b/src/renderer/components/JobDetailsPane/Results.tsx
@@ -17,10 +17,16 @@ export function Results({ job }: { job: Job }) {
                 <ul>
                     {job.jobData.results?.namedResults.map(
                         (item, itemIndex) => (
-                            <li key={`result-${itemIndex}`}>
+                            <li
+                                key={`result-${itemIndex}`}
+                                className="named-result"
+                            >
                                 <FileLink fileHref={item.href}>
-                                    {item.nicename}
+                                    <span className="nicename">
+                                        {item.nicename}
+                                    </span>
                                 </FileLink>
+                                <span className="description">{item.desc}</span>
                             </li>
                         )
                     )}

diff --git a/src/renderer/style/style.scss b/src/renderer/style/style.scss
@@ -221,6 +221,29 @@ select {
         .job-results {
             width: min-content;
             white-space: nowrap;
+
+            /* the outer list item, e.g. "Results folder" */
+            .file-list > li {
+                display: flex;
+                flex-direction: column;
+                gap: var(--pad);
+            }
+
+            /* the inner list e.g. .filelist > ul > li.named-result */
+            li.named-result {
+                display: flex;
+                flex-direction: row;
+                gap: var(--pad);
+
+                .nicename {
+                    font-weight: bold;
+                }
+                .description {
+                    font-style: italic;
+                    font-size: medium;
+
+                }
+            }
         }
         .form-buttons {
             display: flex;

diff --git a/src/shared/parser/pipelineXmlConverter/jobToJson.ts b/src/shared/parser/pipelineXmlConverter/jobToJson.ts
@@ -60,6 +60,7 @@ function jobElementToJson(jobElm: Element): JobData {
                     mimeType: resultElm.getAttribute('mime-type'),
                     name: resultElm.getAttribute('name'),
                     nicename: resultElm.getAttribute('nicename'),
+                    desc: resultElm.getAttribute('desc'),
                     files: [],
                 }
                 // the results are structured so that a "result" element is nested inside another "result" element

diff --git a/src/shared/types/pipeline.ts b/src/shared/types/pipeline.ts
@@ -173,6 +173,7 @@ export type NamedResult = {
     mimeType: string
     name: string
     nicename: string
+    desc: string
     files: Array<ResultFile>
 }