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

[ML] Migrate influencers list from SCSS to Emotion #200019

Merged
merged 3 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
1 change: 0 additions & 1 deletion x-pack/plugins/ml/public/application/_index.scss
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
@import 'components/annotations/annotation_description_list/index'; // SASSTODO: This file overwrites EUI directly
@import 'components/anomalies_table/index'; // SASSTODO: This file overwrites EUI directly
@import 'components/entity_cell/index';
@import 'components/influencers_list/index';
@import 'components/job_selector/index';
@import 'components/rule_editor/index'; // SASSTODO: This file overwrites EUI directly

Expand Down

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import { getSeverity, getFormattedSeverityScore } from '@kbn/ml-anomaly-utils';
import { abbreviateWholeNumber } from '../../formatters/abbreviate_whole_number';
import type { EntityCellFilter } from '../entity_cell';
import { EntityCell } from '../entity_cell';
import { useInfluencersListStyles } from './influencers_list_styles';

export interface InfluencerValueData {
influencerFieldValue: string;
Expand Down Expand Up @@ -65,6 +66,7 @@ function getTooltipContent(maxScoreLabel: string, totalScoreLabel: string) {
}

const Influencer: FC<InfluencerProps> = ({ influencerFieldName, influencerFilter, valueData }) => {
const styles = useInfluencersListStyles();
const maxScore = Math.floor(valueData.maxAnomalyScore);
const maxScoreLabel = getFormattedSeverityScore(valueData.maxAnomalyScore);
const severity = getSeverity(maxScore);
Expand All @@ -73,40 +75,35 @@ const Influencer: FC<InfluencerProps> = ({ influencerFieldName, influencerFilter

// Ensure the bar has some width for 0 scores.
const barScore = maxScore !== 0 ? maxScore : 1;
const barStyle = {
width: `${barScore}%`,
};

const tooltipContent = getTooltipContent(maxScoreLabel, totalScoreLabel);

return (
<div data-test-subj={`mlInfluencerEntry field-${influencerFieldName}`}>
<div className="field-label" data-test-subj="mlInfluencerEntryFieldLabel">
<div css={styles.fieldLabel} data-test-subj="mlInfluencerEntryFieldLabel">
<EntityCell
entityName={influencerFieldName}
entityValue={valueData.influencerFieldValue}
filter={influencerFilter}
/>
</div>
<div className={`progress ${severity.id}`}>
<div className="progress-bar-holder">
<div className="progress-bar" style={barStyle} />
<div css={styles.progress}>
<div css={styles.progressBarHolder(barScore)}>
<div css={styles.progressBar(severity.id)} />
</div>
<div className="score-label">
<div css={styles.scoreLabel(severity.id)}>
<EuiToolTip
position="right"
className="ml-influencers-list-tooltip"
title={`${influencerFieldName}: ${valueData.influencerFieldValue}`}
content={tooltipContent}
>
<span>{maxScoreLabel}</span>
</EuiToolTip>
</div>
</div>
<div className="total-score-label">
<div css={styles.totalScoreLabel}>
<EuiToolTip
position="right"
className="ml-influencers-list-tooltip"
title={`${influencerFieldName}: ${valueData.influencerFieldValue}`}
content={tooltipContent}
>
Expand Down Expand Up @@ -145,12 +142,14 @@ const InfluencersByName: FC<InfluencersByNameProps> = ({
};

export const InfluencersList: FC<InfluencersListProps> = ({ influencers, influencerFilter }) => {
const styles = useInfluencersListStyles();

if (influencers === undefined || Object.keys(influencers).length === 0) {
return (
<EuiFlexGroup justifyContent="spaceAround" className="ml-influencers-list">
<EuiFlexGroup justifyContent="spaceAround" css={styles.influencersList}>
<EuiFlexItem grow={false}>
<EuiSpacer size="xxl" />
<EuiTitle size="xxs" className="influencer-title">
<EuiTitle size="xxs">
<h3>
<FormattedMessage
id="xpack.ml.influencersList.noInfluencersFoundTitle"
Expand All @@ -172,5 +171,5 @@ export const InfluencersList: FC<InfluencersListProps> = ({ influencers, influen
/>
));

return <div className="ml-influencers-list">{influencersByName}</div>;
return <div css={styles.influencersList}>{influencersByName}</div>;
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import { css } from '@emotion/react';
import { useCurrentEuiThemeVars } from '@kbn/ml-kibana-theme';
import { mlColors } from '../../styles';
import { useMlKibana } from '../../contexts/kibana';

export const useInfluencersListStyles = () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As shown in your before / after screenshots, the total height of each influencer div has decreased slightly (looks like from 41 to 36px in my testing). On the plus side, this means less vertical whitespace. But on the downside, the progress bar now looks closer to the influencer below it than it's own text label.

Do you know what is causing the change in total height? I couldn't track down the source of the change.

Copy link
Contributor Author

@rbrtj rbrtj Nov 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I played a little bit more with the layout, but still can't find the cause.
One could be that top margin for the total score number is removed, though it's only about 2px.
Screenshot 2024-11-18 at 19 11 07
It is kinda hard to catch, as initially, I couldn't get the layout correct. After some adjustments, I discovered that the progress bar had float: left applied from another file 🤔 . I aligned it more closely with the SCSS styles, but the height remains smaller. We could add some margin to separate it more from the next influencer.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy to go with what you have now. The slightly compressed height is a win.

const {
services: { theme },
} = useMlKibana();
const { euiTheme } = useCurrentEuiThemeVars(theme);

return {
influencersList: css({
lineHeight: 1.45,
}),
fieldLabel: css({
fontSize: euiTheme.euiFontSizeXS,
textAlign: 'left',
maxHeight: euiTheme.euiFontSizeS,
maxWidth: 'calc(100% - 102px)',
}),
progress: css({
display: 'inline-block',
width: 'calc(100% - 34px)',
height: '22px',
minWidth: '70px',
marginBottom: 0,
color: euiTheme.euiColorDarkShade,
backgroundColor: 'transparent',
}),
progressBarHolder: (barScore: number) =>
css({
width: `${barScore}%`,
display: 'inline-block',
maxWidth: `calc(100% - 28px)`,
}),
progressBar: (severity: string) =>
css({
height: `calc(${euiTheme.euiSizeXS} / 2)`,
marginTop: euiTheme.euiSizeM,
textAlign: 'right',
lineHeight: '18px',
display: 'inline-block',
transition: 'none',
width: `100%`,
backgroundColor:
severity === 'critical'
? mlColors.critical
: severity === 'major'
? mlColors.major
: severity === 'minor'
? mlColors.minor
: mlColors.warning,
}),
scoreLabel: (severity: string) =>
css({
textAlign: 'center',
lineHeight: '14px',
whiteSpace: 'nowrap',
fontSize: euiTheme.euiFontSizeXS,
marginLeft: euiTheme.euiSizeXS,
display: 'inline-block',
borderColor:
severity === 'critical'
? mlColors.critical
: severity === 'major'
? mlColors.major
: severity === 'minor'
? mlColors.minor
: mlColors.warning,
}),
totalScoreLabel: css({
width: euiTheme.euiSizeXL,
verticalAlign: 'top',
textAlign: 'center',
color: euiTheme.euiColorDarkShade,
fontSize: '11px',
lineHeight: '14px',
borderRadius: euiTheme.euiBorderRadius,
padding: `calc(${euiTheme.euiSizeXS} / 2)`,
display: 'inline-block',
border: euiTheme.euiBorderThin,
}),
};
};