draggableTabBar.tsx 9.4 KB

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