draggableTabBar.tsx 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466
  1. import 'intersection-observer'; // polyfill
  2. import {useCallback, useState} from 'react';
  3. import type {InjectedRouter} from 'react-router';
  4. import styled from '@emotion/styled';
  5. import type {Node} from '@react-types/shared';
  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 {Tabs} from 'sentry/components/tabs';
  12. import {t} from 'sentry/locale';
  13. import {defined} from 'sentry/utils';
  14. import normalizeUrl from 'sentry/utils/url/normalizeUrl';
  15. import {DraggableTabMenuButton} from 'sentry/views/issueList/groupSearchViewTabs/draggableTabMenuButton';
  16. import EditableTabTitle from 'sentry/views/issueList/groupSearchViewTabs/editableTabTitle';
  17. import type {IssueSortOptions} from 'sentry/views/issueList/utils';
  18. // TODO(michaelsun): Move params that aren't necessary to draggableTabBar to parent
  19. export interface Tab {
  20. id: string;
  21. key: string;
  22. label: string;
  23. query: string;
  24. querySort: IssueSortOptions;
  25. content?: React.ReactNode;
  26. queryCount?: number;
  27. unsavedChanges?: [string, IssueSortOptions];
  28. }
  29. export interface DraggableTabBarProps {
  30. orgSlug: string;
  31. router: InjectedRouter;
  32. setTabs: (tabs: Tab[]) => void;
  33. tabs: Tab[];
  34. /**
  35. * Callback function to be called when user clicks the `Add View` button.
  36. */
  37. onAddView?: () => void;
  38. /**
  39. * Callback function to be called when user clicks the `Delete` button.
  40. * Note: The `Delete` button only appears for persistent views
  41. */
  42. onDelete?: (newTabs: Tab[]) => void;
  43. /**
  44. * Callback function to be called when user clicks on the `Discard Changes` button.
  45. * Note: The `Discard Changes` button only appears for persistent views when `isChanged=true`
  46. */
  47. onDiscard?: () => void;
  48. /**
  49. * Callback function to be called when user clicks on the `Discard` button for temporary views.
  50. * Note: The `Discard` button only appears for temporary views
  51. */
  52. onDiscardTempView?: () => void;
  53. /**
  54. * Callback function to be called when user clicks the 'Duplicate' button.
  55. * Note: The `Duplicate` button only appears for persistent views
  56. */
  57. onDuplicate?: (newTabs: Tab[]) => void;
  58. /**
  59. * Callback function to be called when the user reorders the tabs. Returns the
  60. * new order of the tabs along with their props.
  61. */
  62. onReorder?: (newTabs: Tab[]) => void;
  63. /**
  64. * Callback function to be called when user clicks the 'Save' button.
  65. * Note: The `Save` button only appears for persistent views when `isChanged=true`
  66. */
  67. onSave?: (newTabs: Tab[]) => void;
  68. /**
  69. * Callback function to be called when user clicks the 'Save View' button for temporary views.
  70. */
  71. onSaveTempView?: (newTabs: Tab[]) => void;
  72. /**
  73. * Callback function to be called when user renames a tab.
  74. * Note: The `Rename` button only appears for persistent views
  75. */
  76. onTabRenamed?: (newTabs: Tab[], newLabel: string) => void;
  77. }
  78. const generateTempViewId = () => `_${Math.random().toString().substring(2, 7)}`;
  79. export function DraggableTabBar({
  80. tabs,
  81. setTabs,
  82. orgSlug,
  83. router,
  84. onReorder,
  85. onAddView,
  86. onDelete,
  87. onDiscard,
  88. onDuplicate,
  89. onTabRenamed,
  90. onSave,
  91. onDiscardTempView,
  92. onSaveTempView,
  93. }: DraggableTabBarProps) {
  94. // TODO: Extract this to a separate component encompassing Tab.Item in the future
  95. const [editingTabKey, setEditingTabKey] = useState<string | null>(null);
  96. const {cursor: _cursor, page: _page, ...queryParams} = router.location?.query ?? {};
  97. const selectedTabKey = queryParams.viewId ?? 'temporary-tab';
  98. const setSelectedTabKey = useCallback(
  99. (key: string) => {
  100. router.replace({
  101. query: {
  102. ...queryParams,
  103. viewId: key,
  104. },
  105. pathname: `/organizations/${orgSlug}/issues/`,
  106. });
  107. },
  108. [orgSlug, queryParams, router]
  109. );
  110. const [tempTab, setTempTab] = useState<Tab | undefined>(
  111. selectedTabKey === 'temporary-tab' && queryParams.query
  112. ? {
  113. id: 'temporary-tab',
  114. key: 'temporary-tab',
  115. label: 'Unsaved',
  116. query: queryParams.query,
  117. querySort: queryParams.sort,
  118. queryCount: undefined,
  119. }
  120. : undefined
  121. );
  122. const handleOnReorder = (newOrder: Node<DraggableTabListItemProps>[]) => {
  123. const newTabs = newOrder
  124. .map(node => {
  125. const foundTab = tabs.find(tab => tab.key === node.key);
  126. return foundTab?.key === node.key ? foundTab : null;
  127. })
  128. .filter(defined);
  129. setTabs(newTabs);
  130. onReorder?.(newTabs);
  131. };
  132. const handleOnSaveChanges = () => {
  133. const originalTab = tabs.find(tab => tab.key === selectedTabKey);
  134. if (originalTab) {
  135. const newTabs = tabs.map(tab => {
  136. if (tab.key === selectedTabKey && tab.unsavedChanges) {
  137. tab.query = tab.unsavedChanges[0];
  138. tab.querySort = tab.unsavedChanges[1];
  139. tab.unsavedChanges = undefined;
  140. }
  141. return tab;
  142. });
  143. setTabs(newTabs);
  144. onSave?.(newTabs);
  145. }
  146. };
  147. const handleOnDiscardChanges = () => {
  148. const originalTab = tabs.find(tab => tab.key === selectedTabKey);
  149. if (originalTab) {
  150. setTabs(
  151. tabs.map(tab => {
  152. if (tab.key === selectedTabKey) {
  153. tab.unsavedChanges = undefined;
  154. }
  155. return tab;
  156. })
  157. );
  158. router.push(
  159. normalizeUrl({
  160. query: {
  161. ...queryParams,
  162. query: originalTab.query,
  163. sort: originalTab.querySort,
  164. ...(originalTab.id ? {viewId: originalTab.id} : {}),
  165. },
  166. pathname: `/organizations/${orgSlug}/issues/`,
  167. })
  168. );
  169. onDiscard?.();
  170. }
  171. };
  172. const handleOnTabRenamed = (newLabel: string, tabKey: string) => {
  173. const renamedTab = tabs.find(tb => tb.key === tabKey);
  174. if (renamedTab && newLabel !== renamedTab.label) {
  175. const newTabs = tabs.map(tab =>
  176. tab.key === renamedTab.key ? {...tab, label: newLabel} : tab
  177. );
  178. setTabs(newTabs);
  179. onTabRenamed?.(newTabs, newLabel);
  180. }
  181. };
  182. const handleOnDuplicate = () => {
  183. const idx = tabs.findIndex(tb => tb.key === selectedTabKey);
  184. if (idx !== -1) {
  185. const tempId = generateTempViewId();
  186. const duplicatedTab = tabs[idx];
  187. const newTabs = [
  188. ...tabs.slice(0, idx + 1),
  189. {
  190. ...duplicatedTab,
  191. id: tempId,
  192. key: tempId,
  193. label: `${duplicatedTab.label} (Copy)`,
  194. },
  195. ...tabs.slice(idx + 1),
  196. ];
  197. setTabs(newTabs);
  198. setSelectedTabKey(duplicatedTab.key);
  199. onDuplicate?.(newTabs);
  200. }
  201. };
  202. const handleOnDelete = () => {
  203. if (tabs.length > 1) {
  204. const newTabs = tabs.filter(tb => tb.key !== selectedTabKey);
  205. setTabs(newTabs);
  206. setSelectedTabKey(newTabs[0].key);
  207. onDelete?.(newTabs);
  208. }
  209. };
  210. const handleOnSaveTempView = () => {
  211. if (tempTab) {
  212. const tempId = generateTempViewId();
  213. const newTab: Tab = {
  214. id: tempId,
  215. key: tempId,
  216. label: 'New View',
  217. query: tempTab.query,
  218. querySort: tempTab.querySort,
  219. };
  220. const newTabs = [...tabs, newTab];
  221. setTabs(newTabs);
  222. setSelectedTabKey(tempId);
  223. onSaveTempView?.(newTabs);
  224. }
  225. };
  226. const handleOnDiscardTempView = () => {
  227. setSelectedTabKey(tabs[0].key);
  228. setTempTab(undefined);
  229. onDiscardTempView?.();
  230. };
  231. const handleOnAddView = () => {
  232. const tempId = generateTempViewId();
  233. const currentTab = tabs.find(tab => tab.key === selectedTabKey);
  234. if (currentTab) {
  235. const newTabQuery = currentTab.unsavedChanges
  236. ? currentTab.unsavedChanges[0]
  237. : currentTab.query;
  238. const newTabSort = currentTab.unsavedChanges
  239. ? currentTab.unsavedChanges[1]
  240. : currentTab.querySort;
  241. const newTabs = [
  242. ...tabs,
  243. {
  244. id: tempId,
  245. key: tempId,
  246. label: 'New View',
  247. query: newTabQuery,
  248. querySort: newTabSort,
  249. },
  250. ];
  251. setTabs(newTabs);
  252. setSelectedTabKey(tempId);
  253. onAddView?.();
  254. }
  255. };
  256. const makeMenuOptions = (tab: Tab): MenuItemProps[] => {
  257. if (tab.key === 'temporary-tab') {
  258. return makeTempViewMenuOptions({
  259. onSaveTempView: handleOnSaveTempView,
  260. onDiscardTempView: handleOnDiscardTempView,
  261. });
  262. }
  263. if (tab.unsavedChanges) {
  264. return makeUnsavedChangesMenuOptions({
  265. onRename: () => setEditingTabKey(tab.key),
  266. onDuplicate: handleOnDuplicate,
  267. onDelete: tabs.length > 1 ? handleOnDelete : undefined,
  268. onSave: handleOnSaveChanges,
  269. onDiscard: handleOnDiscardChanges,
  270. });
  271. }
  272. return makeDefaultMenuOptions({
  273. onRename: () => setEditingTabKey(tab.key),
  274. onDuplicate: handleOnDuplicate,
  275. onDelete: tabs.length > 1 ? handleOnDelete : undefined,
  276. });
  277. };
  278. const allTabs = tempTab ? [...tabs, tempTab] : tabs;
  279. return (
  280. <Tabs value={selectedTabKey} onChange={setSelectedTabKey}>
  281. <DraggableTabList
  282. onReorder={handleOnReorder}
  283. selectedKey={selectedTabKey}
  284. showTempTab={!!tempTab}
  285. onAddView={handleOnAddView}
  286. orientation="horizontal"
  287. hideBorder
  288. >
  289. {allTabs.map(tab => (
  290. <DraggableTabList.Item
  291. textValue={`${tab.label} tab`}
  292. key={tab.key}
  293. to={normalizeUrl({
  294. query: {
  295. ...queryParams,
  296. query: tab.unsavedChanges?.[0] ?? tab.query,
  297. sort: tab.unsavedChanges?.[1] ?? tab.querySort,
  298. ...(tab.id !== 'temporary-tab' ? {id: tab.id} : {}),
  299. },
  300. pathname: `/organizations/${orgSlug}/issues/`,
  301. })}
  302. >
  303. <TabContentWrap selected={selectedTabKey === tab.key}>
  304. <EditableTabTitle
  305. label={tab.label}
  306. isEditing={editingTabKey === tab.key}
  307. setIsEditing={isEditing => setEditingTabKey(isEditing ? tab.key : null)}
  308. onChange={newLabel => handleOnTabRenamed(newLabel.trim(), tab.key)}
  309. />
  310. {tab.key !== 'temporary-tab' && tab.queryCount !== undefined && (
  311. <StyledBadge>
  312. <QueryCount
  313. hideParens
  314. hideIfEmpty={false}
  315. count={tab.queryCount}
  316. max={1000}
  317. />
  318. </StyledBadge>
  319. )}
  320. {selectedTabKey === tab.key && (
  321. <DraggableTabMenuButton
  322. hasUnsavedChanges={!!tab.unsavedChanges}
  323. menuOptions={makeMenuOptions(tab)}
  324. aria-label={`${tab.label} Tab Options`}
  325. />
  326. )}
  327. </TabContentWrap>
  328. </DraggableTabList.Item>
  329. ))}
  330. </DraggableTabList>
  331. </Tabs>
  332. );
  333. }
  334. const makeDefaultMenuOptions = ({
  335. onRename,
  336. onDuplicate,
  337. onDelete,
  338. }: {
  339. onDelete?: (key: string) => void;
  340. onDuplicate?: (key: string) => void;
  341. onRename?: (key: string) => void;
  342. }): MenuItemProps[] => {
  343. const menuOptions: MenuItemProps[] = [
  344. {
  345. key: 'rename-tab',
  346. label: t('Rename'),
  347. onAction: onRename,
  348. },
  349. {
  350. key: 'duplicate-tab',
  351. label: t('Duplicate'),
  352. onAction: onDuplicate,
  353. },
  354. ];
  355. if (onDelete) {
  356. menuOptions.push({
  357. key: 'delete-tab',
  358. label: t('Delete'),
  359. priority: 'danger',
  360. onAction: onDelete,
  361. });
  362. }
  363. return menuOptions;
  364. };
  365. const makeUnsavedChangesMenuOptions = ({
  366. onRename,
  367. onDuplicate,
  368. onDelete,
  369. onSave,
  370. onDiscard,
  371. }: {
  372. onDelete?: (key: string) => void;
  373. onDiscard?: (key: string) => void;
  374. onDuplicate?: (key: string) => void;
  375. onRename?: (key: string) => void;
  376. onSave?: (key: string) => void;
  377. }): MenuItemProps[] => {
  378. return [
  379. {
  380. key: 'changed',
  381. children: [
  382. {
  383. key: 'save-changes',
  384. label: t('Save Changes'),
  385. priority: 'primary',
  386. onAction: onSave,
  387. },
  388. {
  389. key: 'discard-changes',
  390. label: t('Discard Changes'),
  391. onAction: onDiscard,
  392. },
  393. ],
  394. },
  395. {
  396. key: 'default',
  397. children: makeDefaultMenuOptions({onRename, onDuplicate, onDelete}),
  398. },
  399. ];
  400. };
  401. const makeTempViewMenuOptions = ({
  402. onSaveTempView,
  403. onDiscardTempView,
  404. }: {
  405. onDiscardTempView: () => void;
  406. onSaveTempView: () => void;
  407. }): MenuItemProps[] => {
  408. return [
  409. {
  410. key: 'save-changes',
  411. label: t('Save View'),
  412. priority: 'primary',
  413. onAction: onSaveTempView,
  414. },
  415. {
  416. key: 'discard-changes',
  417. label: t('Discard'),
  418. onAction: onDiscardTempView,
  419. },
  420. ];
  421. };
  422. const TabContentWrap = styled('span')<{selected: boolean}>`
  423. white-space: nowrap;
  424. display: flex;
  425. align-items: center;
  426. flex-direction: row;
  427. padding: 0;
  428. gap: 6px;
  429. ${p => (p.selected ? 'z-index: 1;' : 'z-index: 0;')}
  430. `;
  431. const StyledBadge = styled(Badge)`
  432. display: flex;
  433. height: 16px;
  434. align-items: center;
  435. justify-content: center;
  436. border-radius: 10px;
  437. background: transparent;
  438. border: 1px solid ${p => p.theme.gray200};
  439. color: ${p => p.theme.gray300};
  440. margin-left: 0;
  441. `;