draggableTabBar.tsx 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326
  1. import 'intersection-observer'; // polyfill
  2. import {useEffect, useState} from 'react';
  3. import styled from '@emotion/styled';
  4. import type {Key, Node} from '@react-types/shared';
  5. import Badge from 'sentry/components/badge/badge';
  6. import {DraggableTabList} from 'sentry/components/draggableTabs/draggableTabList';
  7. import type {DraggableTabListItemProps} from 'sentry/components/draggableTabs/item';
  8. import type {MenuItemProps} from 'sentry/components/dropdownMenu';
  9. import QueryCount from 'sentry/components/queryCount';
  10. import {TabPanels, Tabs} from 'sentry/components/tabs';
  11. import {t} from 'sentry/locale';
  12. import {space} from 'sentry/styles/space';
  13. import {defined} from 'sentry/utils';
  14. import {DraggableTabMenuButton} from 'sentry/views/issueList/groupSearchViewTabs/draggableTabMenuButton';
  15. import EditableTabTitle from 'sentry/views/issueList/groupSearchViewTabs/editableTabTitle';
  16. export interface Tab {
  17. content: React.ReactNode;
  18. key: string;
  19. label: string;
  20. hasUnsavedChanges?: boolean;
  21. queryCount?: number;
  22. }
  23. export interface DraggableTabBarProps {
  24. defaultNewTab: Tab;
  25. setTabs: (tabs: Tab[]) => void;
  26. showTempTab: boolean;
  27. tabs: Tab[];
  28. tempTab: Tab;
  29. onAddView?: React.MouseEventHandler;
  30. /**
  31. * Callback function to be called when user clicks the `Delete` button.
  32. * Note: The `Delete` button only appears for persistent views
  33. */
  34. onDelete?: (key: MenuItemProps['key']) => void;
  35. /**
  36. * Callback function to be called when user clicks on the `Discard Changes` button.
  37. * Note: The `Discard Changes` button only appears for persistent views when `isChanged=true`
  38. */
  39. onDiscard?: (key: MenuItemProps['key']) => void;
  40. /**
  41. * Callback function to be called when user clicks on the `Discard` button for temporary views.
  42. * Note: The `Discard` button only appears for temporary views
  43. */
  44. onDiscardTempView?: () => void;
  45. /**
  46. * Callback function to be called when user clicks the 'Duplicate' button.
  47. * Note: The `Duplicate` button only appears for persistent views
  48. */
  49. onDuplicate?: (key: MenuItemProps['key']) => void;
  50. /**
  51. * Callback function to be called when user clicks the 'Save' button.
  52. * Note: The `Save` button only appears for persistent views when `isChanged=true`
  53. */
  54. onSave?: (key: MenuItemProps['key']) => void;
  55. /**
  56. * Callback function to be called when user clicks the 'Save View' button for temporary views.
  57. */
  58. onSaveTempView?: () => void;
  59. /**
  60. * Callback function to be called when user renames a tab.
  61. * Note: The `Rename` button only appears for persistent views
  62. */
  63. onTabRenamed?: (key: MenuItemProps['key'], newLabel: string) => void;
  64. tempTabContent?: React.ReactNode;
  65. tempTabLabel?: string;
  66. }
  67. export function DraggableTabBar({
  68. tabs,
  69. setTabs,
  70. tempTab,
  71. defaultNewTab,
  72. showTempTab,
  73. onAddView,
  74. onDelete,
  75. onDiscard,
  76. onDuplicate,
  77. onTabRenamed,
  78. onSave,
  79. onDiscardTempView,
  80. onSaveTempView,
  81. }: DraggableTabBarProps) {
  82. const [selectedTabKey, setSelectedTabKey] = useState<Key>(tabs[0].key);
  83. // TODO: Extract this to a separate component encompassing Tab.Item in the future
  84. const [editingTabKey, setEditingTabKey] = useState<string | null>(null);
  85. useEffect(() => {
  86. if (!showTempTab && selectedTabKey === 'temporary-tab') {
  87. setSelectedTabKey(tabs[0].key);
  88. }
  89. }, [showTempTab, selectedTabKey, tabs]);
  90. const onReorder: (newOrder: Node<DraggableTabListItemProps>[]) => void = newOrder => {
  91. setTabs(
  92. newOrder
  93. .map(node => {
  94. const foundTab = tabs.find(tab => tab.key === node.key);
  95. return foundTab?.key === node.key ? foundTab : null;
  96. })
  97. .filter(defined)
  98. );
  99. };
  100. const handleOnDelete = (tab: Tab) => {
  101. if (tabs.length > 1) {
  102. setTabs(tabs.filter(tb => tb.key !== tab.key));
  103. onDelete?.(tab.key);
  104. }
  105. };
  106. const handleOnDuplicate = (tab: Tab) => {
  107. const idx = tabs.findIndex(tb => tb.key === tab.key);
  108. if (idx !== -1) {
  109. setTabs([
  110. ...tabs.slice(0, idx + 1),
  111. {
  112. ...tab,
  113. key: `${tab.key}-copy`,
  114. label: `${tab.label} (Copy)`,
  115. hasUnsavedChanges: false,
  116. },
  117. ...tabs.slice(idx + 1),
  118. ]);
  119. onDuplicate?.(tab.key);
  120. }
  121. };
  122. const handleOnAddView = (e: React.MouseEvent<Element, MouseEvent>) => {
  123. setTabs([...tabs, defaultNewTab]);
  124. onAddView?.(e);
  125. };
  126. const handleOnTabRenamed = (newLabel: string, tabKey: string) => {
  127. const tab = tabs.find(tb => tb.key === tabKey);
  128. if (tab && newLabel !== tab.label) {
  129. setTabs(tabs.map(tb => (tb.key === tab.key ? {...tb, label: newLabel} : tb)));
  130. onTabRenamed?.(tab.key, newLabel);
  131. }
  132. };
  133. const makeMenuOptions = (tab: Tab): MenuItemProps[] => {
  134. if (tab.key === 'temporary-tab') {
  135. return makeTempViewMenuOptions({
  136. onSave: () => onSaveTempView?.(),
  137. onDiscard: () => onDiscardTempView?.(),
  138. });
  139. }
  140. if (tab.hasUnsavedChanges) {
  141. return makeUnsavedChangesMenuOptions({
  142. onRename: () => setEditingTabKey(tab.key),
  143. onDuplicate: () => handleOnDuplicate(tab),
  144. onDelete: tabs.length > 1 ? () => handleOnDelete(tab) : undefined,
  145. onSave: () => onSave?.(tab.key),
  146. onDiscard: () => onDiscard?.(tab.key),
  147. });
  148. }
  149. return makeDefaultMenuOptions({
  150. onRename: () => setEditingTabKey(tab.key),
  151. onDuplicate: () => handleOnDuplicate(tab),
  152. onDelete: tabs.length > 1 ? () => handleOnDelete(tab) : undefined,
  153. });
  154. };
  155. return (
  156. <Tabs>
  157. <DraggableTabList
  158. onReorder={onReorder}
  159. onSelectionChange={setSelectedTabKey}
  160. selectedKey={selectedTabKey}
  161. showTempTab={showTempTab}
  162. onAddView={e => handleOnAddView(e)}
  163. orientation="horizontal"
  164. >
  165. {[...tabs, tempTab].map(tab => (
  166. <DraggableTabList.Item
  167. textValue={`${tab.label} tab`}
  168. key={tab.key}
  169. hidden={tab.key === 'temporary-tab' && !showTempTab}
  170. >
  171. <TabContentWrap>
  172. <EditableTabTitle
  173. label={tab.label}
  174. isEditing={editingTabKey === tab.key}
  175. setIsEditing={isEditing => setEditingTabKey(isEditing ? tab.key : null)}
  176. onChange={newLabel => handleOnTabRenamed(newLabel.trim(), tab.key)}
  177. />
  178. {tab.key !== 'temporary-tab' && tab.queryCount && (
  179. <StyledBadge>
  180. <QueryCount hideParens count={tab.queryCount} max={1000} />
  181. </StyledBadge>
  182. )}
  183. {selectedTabKey === tab.key && (
  184. <DraggableTabMenuButton
  185. hasUnsavedChanges={tab.hasUnsavedChanges}
  186. menuOptions={makeMenuOptions(tab)}
  187. aria-label={`${tab.label} Tab Options`}
  188. />
  189. )}
  190. </TabContentWrap>
  191. </DraggableTabList.Item>
  192. ))}
  193. </DraggableTabList>
  194. <TabPanels>
  195. {[...tabs, tempTab].map(tab => (
  196. <TabPanels.Item key={tab.key}>{tab.content}</TabPanels.Item>
  197. ))}
  198. </TabPanels>
  199. </Tabs>
  200. );
  201. }
  202. const makeDefaultMenuOptions = ({
  203. onRename,
  204. onDuplicate,
  205. onDelete,
  206. }: {
  207. onDelete?: (key: string) => void;
  208. onDuplicate?: (key: string) => void;
  209. onRename?: (key: string) => void;
  210. }): MenuItemProps[] => {
  211. const menuOptions: MenuItemProps[] = [
  212. {
  213. key: 'rename-tab',
  214. label: t('Rename'),
  215. onAction: onRename,
  216. },
  217. {
  218. key: 'duplicate-tab',
  219. label: t('Duplicate'),
  220. onAction: onDuplicate,
  221. },
  222. ];
  223. if (onDelete) {
  224. menuOptions.push({
  225. key: 'delete-tab',
  226. label: t('Delete'),
  227. priority: 'danger',
  228. onAction: onDelete,
  229. });
  230. }
  231. return menuOptions;
  232. };
  233. const makeUnsavedChangesMenuOptions = ({
  234. onRename,
  235. onDuplicate,
  236. onDelete,
  237. onSave,
  238. onDiscard,
  239. }: {
  240. onDelete?: (key: string) => void;
  241. onDiscard?: (key: string) => void;
  242. onDuplicate?: (key: string) => void;
  243. onRename?: (key: string) => void;
  244. onSave?: (key: string) => void;
  245. }): MenuItemProps[] => {
  246. return [
  247. {
  248. key: 'changed',
  249. children: [
  250. {
  251. key: 'save-changes',
  252. label: t('Save Changes'),
  253. priority: 'primary',
  254. onAction: onSave,
  255. },
  256. {
  257. key: 'discard-changes',
  258. label: t('Discard Changes'),
  259. onAction: onDiscard,
  260. },
  261. ],
  262. },
  263. {
  264. key: 'default',
  265. children: makeDefaultMenuOptions({onRename, onDuplicate, onDelete}),
  266. },
  267. ];
  268. };
  269. const makeTempViewMenuOptions = ({
  270. onSave,
  271. onDiscard,
  272. }: {
  273. onDiscard: () => void;
  274. onSave: () => void;
  275. }): MenuItemProps[] => {
  276. return [
  277. {
  278. key: 'save-changes',
  279. label: t('Save View'),
  280. priority: 'primary',
  281. onAction: onSave,
  282. },
  283. {
  284. key: 'discard-changes',
  285. label: t('Discard'),
  286. onAction: onDiscard,
  287. },
  288. ];
  289. };
  290. const TabContentWrap = styled('span')`
  291. white-space: nowrap;
  292. display: flex;
  293. align-items: center;
  294. flex-direction: row;
  295. padding: ${space(0)} ${space(0)};
  296. gap: 6px;
  297. `;
  298. const StyledBadge = styled(Badge)`
  299. display: flex;
  300. height: 16px;
  301. align-items: center;
  302. justify-content: center;
  303. border-radius: 10px;
  304. background: transparent;
  305. border: 1px solid ${p => p.theme.gray200};
  306. color: ${p => p.theme.gray300};
  307. margin-left: ${space(0)};
  308. `;