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.

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

Fixes design issues in metadata panel #2009

Merged
merged 18 commits into from
Aug 13, 2024
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
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
6 changes: 6 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
- Use present tense (e.g. 'Add new feature')
- Include the ID number for the related PR (or PRs) in parentheses
-->
# Upcoming Release

Check warning on line 8 in RELEASE.md

View workflow job for this annotation

GitHub Actions / vale

[vale] RELEASE.md#L8

[Kedro-viz.headings] 'Upcoming Release' should use sentence-style capitalization.
Raw output
{"message": "[Kedro-viz.headings] 'Upcoming Release' should use sentence-style capitalization.", "location": {"path": "RELEASE.md", "range": {"start": {"line": 8, "column": 3}}}, "severity": "WARNING"}

## Bug fixes and other changes

- Fixes design issues in metadata panel. (#2009)

# Release 9.2.0

## Major features and improvements
Expand Down
5 changes: 5 additions & 0 deletions src/components/json-object/json-object.scss
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@
margin-right: -35px;
margin-top: 1.2em;

// to contain contents of parameter json similar to a metadata value
word-break: break-word;
white-space: pre-wrap;
display: contents;

.pretty-json-container {
font-family: variables.$font-monospace;
font-size: 0.87em;
Expand Down
11 changes: 0 additions & 11 deletions src/components/metadata-modal/metadata-modal.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import PlotlyChart from '../plotly-chart';
import PreviewTable from '../preview-table';
import JSONObject from '../../components/json-object';
import CollapseIcon from '../icons/collapse';

Check warning on line 6 in src/components/metadata-modal/metadata-modal.js

View workflow job for this annotation

GitHub Actions / javascript_lint_and_tests

'CollapseIcon' is defined but never used

Check warning on line 6 in src/components/metadata-modal/metadata-modal.js

View workflow job for this annotation

GitHub Actions / javascript_lint_and_tests

'CollapseIcon' is defined but never used
import BackIcon from '../icons/back';
import NodeIcon from '../icons/node-icon';
import { togglePlotModal } from '../../actions';
Expand Down Expand Up @@ -61,17 +61,6 @@
layout={metadata.preview.layout}
view="modal"
/>
<div className="pipeline-metadata-modal__bottom">
<button
className="pipeline-metadata-modal__collapse-plot"
onClick={onCollapsePlotClick}
>
<CollapseIcon className="pipeline-metadata-modal__collapse-plot-icon"></CollapseIcon>
<span className="pipeline-metadata-modal__collapse-plot-text">
Collapse Plotly Visualization
</span>
</button>
</div>
</>
)}
{hasImage && (
Expand Down
6 changes: 0 additions & 6 deletions src/components/metadata-modal/metadata-modal.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,6 @@ describe('Plotly Modal', () => {
expect(wrapper.find('.pipeline-metadata-modal').length).toBe(1);
});

it('modal closes when collapse button is clicked', () => {
const wrapper = mount({ nodeId: nodeID });
wrapper.find('.pipeline-metadata-modal__collapse-plot').simulate('click');
expect(wrapper.find('.pipeline-metadata-modal').length).toBe(0);
});

it('modal closes when back button is clicked', () => {
const wrapper = mount({ nodeId: nodeID });
wrapper.find('.pipeline-metadata-modal__back').simulate('click');
Expand Down
34 changes: 19 additions & 15 deletions src/components/metadata/metadata.js
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ const MetaData = ({
>
<ExpandIcon className="pipeline-metadata__link-icon"></ExpandIcon>
<span className="pipeline-metadata__link-text">
Expand Plotly Visualization
Expand preview
</span>
</button>
</>
Expand All @@ -307,7 +307,7 @@ const MetaData = ({
>
<ExpandIcon className="pipeline-metadata__link-icon"></ExpandIcon>
<span className="pipeline-metadata__link-text">
Expand Matplotlib Image
Expand preview
</span>
</button>
</>
Expand All @@ -332,11 +332,13 @@ const MetaData = ({
{hasTablePreview && (
<>
<div className="pipeline-metadata__preview">
<PreviewTable
data={metadata?.preview}
size="small"
onClick={onExpandMetaDataClick}
/>
<div className="scrollable-container">
<PreviewTable
data={metadata?.preview}
size="small"
onClick={onExpandMetaDataClick}
/>
</div>
<div className="pipeline-metadata__preview-shadow-box-right" />
<div className="pipeline-metadata__preview-shadow-box-bottom" />
</div>
Expand All @@ -346,20 +348,22 @@ const MetaData = ({
>
<ExpandIcon className="pipeline-metadata__link-icon"></ExpandIcon>
<span className="pipeline-metadata__link-text">
Expand Preview Table
Expand preview
</span>
</button>
</>
)}
{hasJSONPreview && (
<>
<div className="pipeline-metadata__preview-json">
<JSONObject
value={JSON.parse(metadata.preview)}
theme={theme}
style={{ background: 'transparent', fontSize: '14px' }}
collapsed={3}
/>
<div className="scrollable-container">
<JSONObject
value={JSON.parse(metadata.preview)}
theme={theme}
style={{ background: 'transparent', fontSize: '14px' }}
collapsed={3}
/>
</div>
<div className="pipeline-metadata__preview-shadow-box-right" />
<div className="pipeline-metadata__preview-shadow-box-bottom" />
</div>
Expand All @@ -369,7 +373,7 @@ const MetaData = ({
>
<ExpandIcon className="pipeline-metadata__link-icon"></ExpandIcon>
<span className="pipeline-metadata__link-text">
Expand JSON View
Expand preview
</span>
</button>
</>
Expand Down
2 changes: 1 addition & 1 deletion src/components/metadata/styles/metadata-code.scss
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
padding: 0 variables.$metadata-sidebar-width-open 0 0;
transform: translateX(100vw);
transition: transform ease 0.5s 0.1s, left ease 0.5s;
z-index: 2;
z-index: variables.$z-index-metadata-code;

&--visible {
transform: translateX(variables.$global-toolbar-width);
Expand Down
38 changes: 25 additions & 13 deletions src/components/metadata/styles/metadata.scss
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,11 @@
top: -1px; /* Avoids pixel rounding gaps */
right: -1px;
bottom: -1px;
z-index: 2;
z-index: variables.$z-index-metadata-panel;
display: flex;
flex-direction: column;
width: 100%;
max-width: variables.$metadata-sidebar-width-open;
padding: 6px 0 0;
overflow: hidden auto;
background: var(--color-metadata-bg);
border-left: 1px solid var(--color-border-line);
Expand All @@ -51,8 +50,8 @@

.pipeline-metadata__close-button {
position: absolute;
top: 2px;
right: -14px;
top: 0;
right: 0;

&,
& svg {
Expand All @@ -63,21 +62,20 @@

.pipeline-metadata__label,
.pipeline-metadata__row {
margin: 2.285em 36px;
margin: 32px 36px;
}

.pipeline-metadata__header {
display: flex;
justify-content: space-between;
margin-top: -0.12em;
}

.pipeline-metadata__header-toolbox {
position: relative;
display: flex;
flex-direction: column-reverse;
justify-content: space-between;
margin: 3em 3.6em;
margin: 3.2em 3.6em;
padding-right: 24px;
}

Expand Down Expand Up @@ -238,8 +236,12 @@ $list-inline-spacing: 0.2em;
.pipeline-metadata__properties {
flex-grow: 1;
height: 0;
margin-top: -3em;
margin-top: auto;
overflow-y: auto;

& :nth-child(1) {
margin-top: 0;
}
}

.pipeline-metadata__link {
Expand All @@ -261,12 +263,12 @@ $list-inline-spacing: 0.2em;
.pipeline-metadata__link-icon {
width: 1.9em;
height: 1.9em;
margin: 0 6px 0 36px;
margin: 0 0.8em 0 0;
fill: var(--color-button-text);
}

.pipeline-metadata__link-text {
margin: 12px 10px 12px 5px;
margin: 18px 0;
color: var(--color-button-text);
font-size: 1.6em;
}
Expand All @@ -281,16 +283,26 @@ $list-inline-spacing: 0.2em;
.pipeline-metadata__preview {
background: var(--color-metadata-preview-bg);
height: 300px;
overflow: hidden;
position: relative;
}

.pipeline-metadata__preview-json {
background: var(--color-metadata-preview-bg);
height: 300px;
overflow: hidden;
position: relative;
padding: 10px 20px 0;
padding: 10px 0 0 20px;

.scrollable-container {
padding-bottom: 10px;
}
}

.scrollable-container {
overflow: scroll;
max-width: 400px;
max-height: 300px;
height: 100%;
width: 100%;
}

.pipeline-metadata__preview-shadow-box-right {
Expand Down
4 changes: 2 additions & 2 deletions src/components/ui/command-copier/command-copier.scss
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
align-items: center;
font-family: variables.$font-monospace;
font-size: 13px;
padding-right: 24px;

&--no-visible {
opacity: 0;
Expand All @@ -32,7 +33,7 @@
display: block;
width: 26px;
height: 34px;
margin: -0.1em 0 0 auto;
margin: -0.1em 0 0;
padding: 0;
list-style: none;
}
Expand All @@ -41,7 +42,6 @@
width: auto;
height: auto;
margin-top: 0.3em;
margin-right: -0.6em;
opacity: 0.55;

.pipeline-icon {
Expand Down
6 changes: 3 additions & 3 deletions src/components/ui/toggle/toggle.scss
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@
}

.pipeline-toggle {
margin-top: 0.3em;
margin-bottom: 2em;
margin-bottom: 3.2em;
transition: opacity 0.2s ease;
display: flex;
}

.pipeline-toggle--no-hasCode {
Expand All @@ -41,7 +41,7 @@

.pipeline-toggle-label {
position: relative;
padding: 0 0 0 2.8em;
padding: 0.1em 0 0 2.2em;
cursor: pointer;
user-select: none;
color: var(--color-toggle-off-label);
Expand Down
4 changes: 4 additions & 0 deletions src/styles/_variables.scss
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ $metadata-modal-breakpoint: 700px;
$global-toolbar-width: 80px;
$run-list-controls-height: 95px;

// -- levels -- //
$z-index-metadata-panel: 3;
$z-index-metadata-code: 3;

// Micro-animation
$run-width: 375px;
$run-width-comparison-view: 310px;
Expand Down
Loading