Skip to content

[ENHANCEMENT] Make panel display attribute optional #16

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

Draft
AntoineThebaud wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[ENHANCEMENT] Make panel display attribute optional #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions dashboards/src/components/Panel/Panel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,8 +225,8 @@ export const Panel = memo(function Panel(props: PanelProps) {
<PanelHeader
extra={panelOptions?.extra?.({ panelDefinition: definition, panelGroupItemId })}
id={headerId}
title={definition.spec.display.name}
description={definition.spec.display.description}
title={definition.spec.display?.name}
description={definition.spec.display?.description}
queryResults={queryResults}
readHandlers={readHandlers}
editHandlers={editHandlers}
Expand Down
2 changes: 1 addition & 1 deletion dashboards/src/components/Panel/PanelHeader.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ type OmittedProps = 'children' | 'action' | 'title' | 'disableTypography';

export interface PanelHeaderProps extends Omit<CardHeaderProps, OmittedProps> {
id: string;
title: string;
title?: string;
description?: string;
links?: Link[];
extra?: ReactNode;
Expand Down
19 changes: 17 additions & 2 deletions dashboards/src/components/PanelDrawer/PanelEditorForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,23 @@ export function PanelEditorForm(props: PanelEditorFormProps): ReactElement {
// - update action: ask for discard approval if changed
// - read action: don´t ask for discard approval
function handleCancel(): void {
if (JSON.stringify(initialValues) !== JSON.stringify(form.getValues())) {
const currentValues = form.getValues();

// Normalize display: if both name and description are undefined, set display to undefined
const normalizeDisplay = (values: PanelEditorValues): PanelEditorValues => {
if (
values.panelDefinition.spec.display?.name === undefined &&
values.panelDefinition.spec.display?.description === undefined
) {
values.panelDefinition.spec.display = undefined;
}
return values;
};

const normalizedInitial = normalizeDisplay(JSON.parse(JSON.stringify(initialValues)));
const normalizedCurrent = normalizeDisplay(JSON.parse(JSON.stringify(currentValues)));

if (JSON.stringify(normalizedInitial) !== JSON.stringify(normalizedCurrent)) {
setDiscardDialogOpened(true);
} else {
onClose();
Expand Down Expand Up @@ -145,7 +161,6 @@ export function PanelEditorForm(props: PanelEditorFormProps): ReactElement {
render={({ field, fieldState }) => (
<TextField
{...field}
required
fullWidth
label="Name"
error={!!fieldState.error}
Expand Down
13 changes: 8 additions & 5 deletions dashboards/src/components/PanelDrawer/usePanelEditor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,10 @@ export const usePanelEditor: (panelDefinition: PanelDefinition) => UsePanelEdito
panelDefinition: PanelDefinition
) => {
const { display, plugin: pluginDefinition, queries: initialQueries, links: initialLinks } = panelDefinition.spec;
const [name, setName] = useState(display.name);
const [description, setDescription] = useState(display.description);
// Provide default display object if undefined
const displayData = display ?? { name: undefined, description: undefined };
const [name, setName] = useState(displayData.name);
const [description, setDescription] = useState(displayData.description);
const [links, setLinks] = useState(initialLinks);
const [plugin, setPlugin] = useState(pluginDefinition);

Expand Down Expand Up @@ -61,8 +63,9 @@ export const usePanelEditor: (panelDefinition: PanelDefinition) => UsePanelEdito
const setPanelDefinition = useCallback(
(panelDefinition: PanelDefinition) => {
const { display, plugin, queries, links } = panelDefinition.spec;
setName(display.name);
setDescription(display.description);
const displayData = display ?? { name: undefined, description: undefined };
setName(displayData.name);
setDescription(displayData.description);
setLinks(links);
setPlugin(plugin);
setQueries(queries);
Expand All @@ -75,7 +78,7 @@ export const usePanelEditor: (panelDefinition: PanelDefinition) => UsePanelEdito
panelDefinition: {
kind: 'Panel',
spec: {
display: { name, description },
display: name !== undefined || description !== undefined ? { name, description } : undefined,
plugin,
queries: currentQueries,
links,
Expand Down
Loading