Files
superset2/superset-frontend/src/dashboard/components/PublishedStatus/index.tsx
Evan Rusackas 2a133d2d89 chore(lint): convert dashboard components to function components
Converts Dashboard, DashboardGrid, SliceAdder, DragDroppable,
FilterScopeModal, FilterScopeSelector, gridComponents (Chart, Divider,
Header, Markdown, DraggableNewComponent), menu components (HoverMenu,
BackgroundStyleDropdown, MarkdownModeDropdown, WithPopoverMenu),
nativeFilters (FilterValue, DefaultValue), PublishedStatus, and
UndoRedoKeyListeners from class to function components.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-12 10:08:45 -07:00

107 lines
3.2 KiB
TypeScript

/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import { useCallback } from 'react';
import { t } from '@apache-superset/core';
import { Tooltip, PublishedLabel } from '@superset-ui/core/components';
import { HeaderProps, HeaderDropdownProps } from '../Header/types';
export type DashboardPublishedStatusType = {
dashboardId: HeaderDropdownProps['dashboardId'];
userCanEdit: HeaderDropdownProps['userCanEdit'];
userCanSave: HeaderDropdownProps['userCanSave'];
isPublished: HeaderProps['isPublished'];
savePublished: HeaderProps['savePublished'];
};
const draftButtonTooltip = t(
'This dashboard is not published, it will not show up in the list of dashboards. ' +
'Click here to publish this dashboard.',
);
const draftDivTooltip = t(
'This dashboard is not published which means it will not show up in the list of dashboards.' +
' Favorite it to see it there or access it by using the URL directly.',
);
const publishedTooltip = t(
'This dashboard is published. Click to make it a draft.',
);
export default function PublishedStatus({
dashboardId,
userCanEdit,
userCanSave,
isPublished,
savePublished,
}: DashboardPublishedStatusType) {
const togglePublished = useCallback(() => {
savePublished(dashboardId, !isPublished);
}, [dashboardId, isPublished, savePublished]);
// Show everybody the draft badge
if (!isPublished) {
// if they can edit the dash, make the badge a button
if (userCanEdit && userCanSave) {
return (
<Tooltip
id="unpublished-dashboard-tooltip"
placement="bottom"
title={draftButtonTooltip}
>
<div>
<PublishedLabel
isPublished={isPublished}
onClick={togglePublished}
/>
</div>
</Tooltip>
);
}
return (
<Tooltip
id="unpublished-dashboard-tooltip"
placement="bottom"
title={draftDivTooltip}
>
<div>
<PublishedLabel isPublished={isPublished} />
</div>
</Tooltip>
);
}
// Show the published badge for the owner of the dashboard to toggle
if (userCanEdit && userCanSave) {
return (
<Tooltip
id="published-dashboard-tooltip"
placement="bottom"
title={publishedTooltip}
>
<div>
<PublishedLabel isPublished={isPublished} onClick={togglePublished} />
</div>
</Tooltip>
);
}
// Don't show anything if one doesn't own the dashboard and it is published
return null;
}