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.

Sign up for GitHub

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

Jump to bottom

feat: add a tooltip to clarify metric_name in the DatasetEditor #24348

Merged
merged 5 commits into from
Jun 13, 2023
Merged

feat: add a tooltip to clarify metric_name in the DatasetEditor #24348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
064eebc
feat: add a tooltip to clarify metric_name in the DatasetEditor
mistercrunch Jun 10, 2023
c05359c
lint
mistercrunch Jun 12, 2023
377a2ee
lint
mistercrunch Jun 12, 2023
95c2fd3
add tooltip to calc dims as well, no-wrap\!
mistercrunch Jun 12, 2023
9eb85ed
addressing comments
mistercrunch Jun 13, 2023
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
35 changes: 29 additions & 6 deletions superset-frontend/src/components/Datasource/CollectionTable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@
*/
import React, { ReactNode } from 'react';
import shortid from 'shortid';

import { InfoTooltipWithTrigger } from '@superset-ui/chart-controls';
import { t, styled } from '@superset-ui/core';

import Button from 'src/components/Button';
import Icons from 'src/components/Icons';
import Fieldset from './Fieldset';
Expand All @@ -29,6 +32,7 @@ interface CRUDCollectionProps {
allowDeletes?: boolean;
collection: Array<object>;
columnLabels?: object;
columnLabelTooltips?: object;
emptyMessage?: ReactNode;
expandFieldset?: ReactNode;
extraButtons?: ReactNode;
Expand Down Expand Up @@ -222,6 +226,11 @@ export default class CRUDCollection extends React.PureComponent<
return label;
}

getTooltip(col: string) {
const { columnLabelTooltips } = this.props;
return columnLabelTooltips?.[col];
}

changeCollection(collection: any, newItem?: object) {
this.setState({ collection });
if (this.props.onChange) {
Expand Down Expand Up @@ -311,6 +320,25 @@ export default class CRUDCollection extends React.PureComponent<
return <Icons.Sort onClick={this.sortColumn(col, 1)} />;
}

renderTH(col: string, sortColumns: Array<string>) {
const tooltip = this.getTooltip(col);
return (
<th key={col} className="no-wrap">
Copy link
Member Author

Choose a reason for hiding this comment

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

no-wrap is the real mvp I snuck into this PR

Copy link
Member Author

Choose a reason for hiding this comment

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

fixing this monstruosity:
Screen Shot 2023-06-12 at 4 47 23 PM

{this.getLabel(col)}
{tooltip && (
<>
{' '}
<InfoTooltipWithTrigger
label={t('description')}
tooltip={tooltip}
/>
</>
)}
{sortColumns?.includes(col) && this.renderSortIcon(col)}
</th>
);
}

renderHeaderRow() {
const cols = this.effectiveTableColumns();
const { allowDeletes, expandFieldset, extraButtons, sortColumns } =
Expand All @@ -319,12 +347,7 @@ export default class CRUDCollection extends React.PureComponent<
<thead>
<tr>
{expandFieldset && <th aria-label="Expand" className="tiny-cell" />}
{cols.map(col => (
<th key={col}>
{this.getLabel(col)}
{sortColumns?.includes(col) && this.renderSortIcon(col)}
</th>
))}
{cols.map(col => this.renderTH(col, sortColumns))}
{extraButtons}
{allowDeletes && (
<th key="delete-item" aria-label="Delete" className="tiny-cell" />
Expand Down
20 changes: 18 additions & 2 deletions superset-frontend/src/components/Datasource/DatasourceEditor.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,10 +182,10 @@ function ColumnCollectionTable({
allowAddItem,
allowEditDataType,
itemGenerator,
columnLabelTooltips,
}) {
return (
<CollectionTable
collection={columns}
tableColumns={
isFeatureEnabled(FeatureFlag.ENABLE_ADVANCED_DATA_TYPES)
? [
Expand Down Expand Up @@ -229,6 +229,8 @@ function ColumnCollectionTable({
allowDeletes
allowAddItem={allowAddItem}
itemGenerator={itemGenerator}
collection={columns}
columnLabelTooltips={columnLabelTooltips}
stickyHeader
expandFieldset={
<FormContainer>
Expand Down Expand Up @@ -1194,10 +1196,17 @@ class DatasourceEditor extends React.PureComponent {
tableColumns={['metric_name', 'verbose_name', 'expression']}
sortColumns={['metric_name', 'verbose_name', 'expression']}
columnLabels={{
metric_name: t('Metric'),
metric_name: t('Metric Key'),
verbose_name: t('Label'),
expression: t('SQL expression'),
}}
columnLabelTooltips={{
metric_name: t(
'This field is used as a unique identifier to attach ' +
'the metric to charts. It is also used as the alias in the ' +
'SQL query.',
),
}}
expandFieldset={
<FormContainer>
<Fieldset compact>
Expand Down Expand Up @@ -1417,6 +1426,13 @@ class DatasourceEditor extends React.PureComponent {
onColumnsChange={calculatedColumns =>
this.setColumns({ calculatedColumns })
}
columnLabelTooltips={{
column_name: t(
'This field is used as a unique identifier to attach ' +
'the calculated dimension to charts. It is also used ' +
'as the alias in the SQL query.',
),
}}
onDatasourceChange={this.onDatasourceChange}
datasource={datasource}
editableColumnName
Expand Down
6 changes: 6 additions & 0 deletions superset-frontend/src/components/Datasource/DatasourceEditor.test.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ const props = {
addSuccessToast: () => {},
addDangerToast: () => {},
onChange: () => {},
columnLabels: {
state: 'State',
},
columnLabelTooltips: {
state: 'This is a tooltip for `state`',
},
};
const DATASOURCE_ENDPOINT = 'glob:*/datasource/external_metadata_by_name/*';

Expand Down