forked from grafana/grafana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Dashboard: Outline using EditableElement interface (grafana#101076)
- Loading branch information
Showing
19 changed files
with
509 additions
and
77 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
159 changes: 159 additions & 0 deletions
159
public/app/features/dashboard-scene/edit-pane/DashboardOutline.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| import { css, cx } from '@emotion/css'; | ||
| import { useMemo, useState } from 'react'; | ||
|
|
||
| import { GrafanaTheme2 } from '@grafana/data'; | ||
| import { SceneObject, VizPanel } from '@grafana/scenes'; | ||
| import { Box, Icon, IconButton, Stack, Text, useElementSelection, useStyles2 } from '@grafana/ui'; | ||
| import { t, Trans } from 'app/core/internationalization'; | ||
|
|
||
| import { DashboardGridItem } from '../scene/layout-default/DashboardGridItem'; | ||
| import { isInCloneChain } from '../utils/clone'; | ||
| import { getDashboardSceneFor } from '../utils/utils'; | ||
|
|
||
| import { DashboardEditPane } from './DashboardEditPane'; | ||
| import { getEditableElementFor, hasEditableElement } from './shared'; | ||
|
|
||
| export interface Props { | ||
| editPane: DashboardEditPane; | ||
| } | ||
|
|
||
| export function DashboardOutline({ editPane }: Props) { | ||
| const dashboard = getDashboardSceneFor(editPane); | ||
|
|
||
| return ( | ||
| <Box padding={1} gap={0.5} display="flex" direction="column"> | ||
| <DashboardOutlineNode sceneObject={dashboard} expandable /> | ||
| </Box> | ||
| ); | ||
| } | ||
|
|
||
| function DashboardOutlineNode({ sceneObject, expandable }: { sceneObject: SceneObject; expandable: boolean }) { | ||
| const [isExpanded, setIsExpanded] = useState(true); | ||
| const { key } = sceneObject.useState(); | ||
| const styles = useStyles2(getStyles); | ||
| const { isSelected, onSelect } = useElementSelection(key); | ||
| const isCloned = useMemo(() => isInCloneChain(key!), [key]); | ||
| const editableElement = useMemo(() => getEditableElementFor(sceneObject)!, [sceneObject]); | ||
|
|
||
| const children = collectEditableElementChildren(sceneObject); | ||
| const elementInfo = editableElement.getEditableElementInfo(); | ||
|
|
||
| return ( | ||
| <> | ||
| <Stack | ||
| direction="row" | ||
| gap={0.5} | ||
| alignItems="center" | ||
| role="presentation" | ||
| aria-expanded={expandable ? isExpanded : undefined} | ||
| aria-owns={expandable ? key : undefined} | ||
| > | ||
| {expandable && ( | ||
| <IconButton | ||
| name={isExpanded ? 'angle-down' : 'angle-right'} | ||
| onClick={() => setIsExpanded(!isExpanded)} | ||
| aria-label={ | ||
| isExpanded | ||
| ? t('dashboard.outline.tree.item.collapse', 'Collapse item') | ||
| : t('dashboard.outline.tree.item.expand', 'Expand item') | ||
| } | ||
| /> | ||
| )} | ||
| <button | ||
| role="treeitem" | ||
| className={cx(styles.nodeButton, isCloned && styles.nodeButtonClone, isSelected && styles.nodeButtonSelected)} | ||
| onPointerDown={(evt) => onSelect?.(evt)} | ||
| > | ||
| <Icon name={elementInfo.icon} /> | ||
| <span>{elementInfo.name}</span> | ||
| </button> | ||
| </Stack> | ||
| {expandable && isExpanded && ( | ||
| <div className={styles.container} role="group"> | ||
| {children.length > 0 ? ( | ||
| children.map((child) => ( | ||
| <DashboardOutlineNode | ||
| key={child.sceneObject.state.key} | ||
| sceneObject={child.sceneObject} | ||
| expandable={child.expandable} | ||
| /> | ||
| )) | ||
| ) : ( | ||
| <Text element="p" color="secondary"> | ||
| <Trans i18nKey="dashboard.outline.tree.item.empty">(empty)</Trans> | ||
| </Text> | ||
| )} | ||
| </div> | ||
| )} | ||
| </> | ||
| ); | ||
| } | ||
|
|
||
| function getStyles(theme: GrafanaTheme2) { | ||
| return { | ||
| container: css({ | ||
| display: 'flex', | ||
| flexDirection: 'column', | ||
| gap: theme.spacing(1), | ||
| marginLeft: theme.spacing(1), | ||
| paddingLeft: theme.spacing(1.5), | ||
| borderLeft: `1px solid ${theme.colors.border.medium}`, | ||
| }), | ||
| nodeButton: css({ | ||
| boxShadow: 'none', | ||
| border: 'none', | ||
| background: 'transparent', | ||
| padding: theme.spacing(0.25, 1), | ||
| borderRadius: theme.shape.radius.default, | ||
| display: 'flex', | ||
| alignItems: 'center', | ||
| gap: theme.spacing(1), | ||
| overflow: 'hidden', | ||
| '&:hover': { | ||
| backgroundColor: theme.colors.action.hover, | ||
| }, | ||
| '> span': { | ||
| whiteSpace: 'nowrap', | ||
| overflow: 'hidden', | ||
| textOverflow: 'ellipsis', | ||
| }, | ||
| }), | ||
| nodeButtonSelected: css({ | ||
| color: theme.colors.primary.text, | ||
| }), | ||
| nodeButtonClone: css({ | ||
| color: theme.colors.text.secondary, | ||
| cursor: 'not-allowed', | ||
| }), | ||
| }; | ||
| } | ||
|
|
||
| interface EditableElementConfig { | ||
| sceneObject: SceneObject; | ||
| expandable: boolean; | ||
| } | ||
|
|
||
| function collectEditableElementChildren( | ||
| sceneObject: SceneObject, | ||
| children: EditableElementConfig[] = [] | ||
| ): EditableElementConfig[] { | ||
| sceneObject.forEachChild((child) => { | ||
| if (child instanceof DashboardGridItem) { | ||
| // DashboardGridItem is a special case as it can contain repeated panels | ||
| // In this case, we want to show the repeated panels as separate items, otherwise show the body panel | ||
| if (child.state.repeatedPanels?.length) { | ||
| children.push(...child.state.repeatedPanels.map((panel) => ({ sceneObject: panel, expandable: false }))); | ||
| } else { | ||
| children.push({ sceneObject: child.state.body, expandable: false }); | ||
| } | ||
| } else if (child instanceof VizPanel) { | ||
| children.push({ sceneObject: child, expandable: false }); | ||
| } else if (hasEditableElement(child)) { | ||
| children.push({ sceneObject: child, expandable: true }); | ||
| } else { | ||
| collectEditableElementChildren(child, children); | ||
| } | ||
| }); | ||
|
|
||
| return children; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.