superset-frontend/src/features/dashboards/DashboardCard.tsx
/**
* 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 { useEffect, useState } from 'react';
import { Link, useHistory } from 'react-router-dom';
import {
isFeatureEnabled,
FeatureFlag,
t,
useTheme,
SupersetClient,
} from '@superset-ui/core';
import { CardStyles } from 'src/views/CRUD/utils';
import { AntdDropdown } from 'src/components';
import { Menu } from 'src/components/Menu';
import ListViewCard from 'src/components/ListViewCard';
import Icons from 'src/components/Icons';
import Label from 'src/components/Label';
import FacePile from 'src/components/FacePile';
import FaveStar from 'src/components/FaveStar';
import { Dashboard } from 'src/views/CRUD/types';
interface DashboardCardProps {
isChart?: boolean;
dashboard: Dashboard;
hasPerm: (name: string) => boolean;
bulkSelectEnabled: boolean;
loading: boolean;
openDashboardEditModal?: (d: Dashboard) => void;
saveFavoriteStatus: (id: number, isStarred: boolean) => void;
favoriteStatus: boolean;
userId?: string | number;
showThumbnails?: boolean;
handleBulkDashboardExport: (dashboardsToExport: Dashboard[]) => void;
onDelete: (dashboard: Dashboard) => void;
}
function DashboardCard({
dashboard,
hasPerm,
bulkSelectEnabled,
userId,
openDashboardEditModal,
favoriteStatus,
saveFavoriteStatus,
showThumbnails,
handleBulkDashboardExport,
onDelete,
}: DashboardCardProps) {
const history = useHistory();
const canEdit = hasPerm('can_write');
const canDelete = hasPerm('can_write');
const canExport = hasPerm('can_export');
const theme = useTheme();
const [thumbnailUrl, setThumbnailUrl] = useState<string | null>(null);
const [fetchingThumbnail, setFetchingThumbnail] = useState<boolean>(false);
useEffect(() => {
// fetch thumbnail only if it's not already fetched
if (
!fetchingThumbnail &&
dashboard.id &&
(thumbnailUrl === undefined || thumbnailUrl === null) &&
isFeatureEnabled(FeatureFlag.Thumbnails)
) {
// fetch thumbnail
if (dashboard.thumbnail_url) {
// set to empty string if null so that we don't
// keep fetching the thumbnail
setThumbnailUrl(dashboard.thumbnail_url || '');
return;
}
setFetchingThumbnail(true);
SupersetClient.get({
endpoint: `/api/v1/dashboard/${dashboard.id}`,
}).then(({ json = {} }) => {
setThumbnailUrl(json.result?.thumbnail_url || '');
setFetchingThumbnail(false);
});
}
}, [dashboard, thumbnailUrl]);
const menu = (
<Menu>
{canEdit && openDashboardEditModal && (
<Menu.Item>
<div
role="button"
tabIndex={0}
className="action-button"
onClick={() => openDashboardEditModal?.(dashboard)}
data-test="dashboard-card-option-edit-button"
>
<Icons.EditAlt iconSize="l" data-test="edit-alt" /> {t('Edit')}
</div>
</Menu.Item>
)}
{canExport && (
<Menu.Item>
<div
role="button"
tabIndex={0}
onClick={() => handleBulkDashboardExport([dashboard])}
className="action-button"
data-test="dashboard-card-option-export-button"
>
<Icons.Share iconSize="l" /> {t('Export')}
</div>
</Menu.Item>
)}
{canDelete && (
<Menu.Item>
<div
role="button"
tabIndex={0}
className="action-button"
onClick={() => onDelete(dashboard)}
data-test="dashboard-card-option-delete-button"
>
<Icons.Trash iconSize="l" /> {t('Delete')}
</div>
</Menu.Item>
)}
</Menu>
);
return (
<CardStyles
onClick={() => {
if (!bulkSelectEnabled) {
history.push(dashboard.url);
}
}}
>
<ListViewCard
loading={dashboard.loading || false}
title={dashboard.dashboard_title}
certifiedBy={dashboard.certified_by}
certificationDetails={dashboard.certification_details}
titleRight={
<Label>{dashboard.published ? t('published') : t('draft')}</Label>
}
cover={
!isFeatureEnabled(FeatureFlag.Thumbnails) || !showThumbnails ? (
<></>
) : null
}
url={bulkSelectEnabled ? undefined : dashboard.url}
linkComponent={Link}
imgURL={dashboard.thumbnail_url}
imgFallbackURL="/static/assets/images/dashboard-card-fallback.svg"
description={t('Modified %s', dashboard.changed_on_delta_humanized)}
coverLeft={<FacePile users={dashboard.owners || []} />}
actions={
<ListViewCard.Actions
onClick={e => {
e.stopPropagation();
e.preventDefault();
}}
>
{userId && (
<FaveStar
itemId={dashboard.id}
saveFaveStar={saveFavoriteStatus}
isStarred={favoriteStatus}
/>
)}
<AntdDropdown overlay={menu}>
<Icons.MoreVert iconColor={theme.colors.grayscale.base} />
</AntdDropdown>
</ListViewCard.Actions>
}
/>
</CardStyles>
);
}
export default DashboardCard;