Merge pull request #330 from shairez/pr-tabs-final

Author: shairez

apps/website/src/components/keyboard-interaction-table/keyboard-interaction-table.tsx

@@ -23,7 +23,6 @@ export const KeyboardInteractionTable = component$(
         </thead>
         <tbody>
           {props.keyDescriptors.map((descriptor) => {
-            console.log('descriptor', descriptor);
             return (
               <KBInteractionTableRow
                 key={descriptor.keyTitle}

apps/website/src/routes/docs/headless/(components)/tabs/index.mdx

@@ -88,12 +88,46 @@ import { APITable } from '../../../../../components/api-table/api-table';
   keyDescriptors={[
     {
       keyTitle: 'Tab',
-      description: 'Moves focus to next tab.',
+      description: 'Moves focus to the selected panel.',
     },
     {
       keyTitle: 'Shift + Tab',
+      description: 'Moves focus to the selected tab.',
+    },
+    {
+      keyTitle: 'ArrowRight',
+      description: 'Moves focus to the next tab.',
+    },
+    {
+      keyTitle: 'ArrowLeft',
       description: 'Moves focus to the previous tab.',
     },
+    {
+      keyTitle: 'ArrowDown',
+      description: 'In "vertical mode", moves focus to the next tab.',
+    },
+    {
+      keyTitle: 'ArrowUp',
+      description: 'In "vertical mode", moves focus to the previous tab.',
+    },
+    {
+      /* {
+      keyTitle: 'Home',
+      description: 'Moves focus to the first tab.',
+    },
+    {
+      keyTitle: 'PageUp',
+      description: 'Moves focus to the first tab.',
+    },
+    {
+      keyTitle: 'End',
+      description: 'Moves focus to the last tab.',
+    },
+    {
+      keyTitle: 'PageDown',
+      description: 'Moves focus to the first tab.',
+    }, */
+    },
   ]}
 />
 
@@ -109,6 +143,12 @@ import { APITable } from '../../../../../components/api-table/api-table';
       description:
         'Toggle between automatic or manual. The automatic behavior moves between tabs when hover. The manual behavior moves between tabs on click.',
     },
+    {
+      name: 'vertical',
+      type: 'boolean',
+      description:
+        'If set to true, the behavior of UpArrow and DownArrow will navigate between tabs vertically instead of horizontally.',
+    },
   ]}
 />
 

cypress.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from 'cypress';
+
+export default defineConfig({
+  e2e: {
+    setupNodeEvents(on, config) {
+      // implement node event listeners here
+    },
+  },
+});

cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "[email protected]",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

cypress/support/commands.ts

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+//   namespace Cypress {
+//     interface Chainable {
+//       login(email: string, password: string): Chainable<void>
+//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+//     }
+//   }
+// }

cypress/support/e2e.ts

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/e2e.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands';
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

packages/kit-headless/src/components/tabs/tab.tsx

@@ -7,31 +7,55 @@ import {
   useComputed$,
   useTask$,
   $,
+  useSignal,
 } from '@builder.io/qwik';
 import { tabsContextId } from './tabs-context-id';
+import { KeyCode } from '../../utils/key-code.type';
+import { isBrowser, isServer } from '@builder.io/qwik/build';
 
 export interface TabProps {
   onClick?: PropFunction<() => void>;
   class?: string;
   selectedClassName?: string;
+  disabled?: boolean;
 }
 
 export const Tab = component$((props: TabProps) => {
   const contextService = useContext(tabsContextId);
 
+  const serverAssignedIndexSig = useSignal<number | undefined>(undefined);
   const uniqueId = useId();
 
   useTask$(({ cleanup }) => {
-    contextService.tabsChanged$();
-
+    if (isServer) {
+      serverAssignedIndexSig.value =
+        contextService.lastAssignedTabIndexSig.value;
+      contextService.lastAssignedTabIndexSig.value++;
+    }
+    if (isBrowser) {
+      contextService.onTabsChanged$();
+    }
     cleanup(() => {
-      contextService.tabsChanged$();
+      contextService.onTabsChanged$();
     });
   });
 
+  useTask$(({ track }) => {
+    track(() => props.disabled);
+
+    if (props.disabled && contextService.tabsMap[uniqueId]) {
+      contextService.tabsMap[uniqueId].disabled = true;
+    }
+  });
+
   const isSelectedSignal = useComputed$(() => {
+    if (isServer) {
+      return (
+        serverAssignedIndexSig.value === contextService.selectedIndexSig.value
+      );
+    }
     return (
-      contextService.selectedIndex.value ===
+      contextService.selectedIndexSig.value ===
       contextService.tabsMap[uniqueId]?.index
     );
   });
@@ -40,17 +64,13 @@ export const Tab = component$((props: TabProps) => {
     () => contextService.tabsMap[uniqueId]?.tabPanelId
   );
 
-  // TODO: Figure out a way to fix this shitty hack :)
-  useTask$(({ track }) => {
-    track(() => isSelectedSignal.value);
+  const selectTab$ = $(() => {
+    // TODO: try to move this to the Tabs component
 
-    if (isSelectedSignal.value) {
-      contextService.showTabs$();
+    if (props.disabled) {
+      return;
     }
-  });
-
-  const selectTab$ = $(() => {
-    contextService.selectedIndex.value =
+    contextService.selectedIndexSig.value =
       contextService.tabsMap[uniqueId]?.index || 0;
 
     contextService.selectTab$(uniqueId);
@@ -68,6 +88,8 @@ export const Tab = component$((props: TabProps) => {
       data-tab-id={uniqueId}
       type="button"
       role="tab"
+      disabled={props.disabled}
+      aria-disabled={props.disabled}
       onFocus$={selectIfAutomatic$}
       onMouseEnter$={selectIfAutomatic$}
       aria-selected={isSelectedSignal.value}
@@ -84,6 +106,12 @@ export const Tab = component$((props: TabProps) => {
           props.onClick();
         }
       }}
+      onKeyDown$={(e) => {
+        contextService.onTabKeyDown$(
+          e.key as KeyCode,
+          (e.target as any).getAttribute('data-tab-id')
+        );
+      }}
     >
       <Slot />
     </button>

packages/kit-headless/src/components/tabs/tabs-context.type.ts

@@ -1,14 +1,19 @@
 import { Signal, QRL } from '@builder.io/qwik';
 import { Behavior } from './behavior.type';
 import { TabInfo } from './tabs';
+import { KeyCode } from '../../utils/key-code.type';
 
 export interface TabsContext {
-  selectedIndex: Signal<number>;
-  selectedTabId: Signal<string>;
   selectTab$: QRL<(tabId: string) => void>;
   showTabs$: QRL<() => void>;
-  tabsChanged$: QRL<() => void>;
+  onTabsChanged$: QRL<() => void>;
+  onTabKeyDown$: QRL<(key: KeyCode, tabId: string) => void>;
+  selectedIndexSig: Signal<number>;
+  selectedTabIdSig: Signal<string>;
   tabsMap: { [key: string]: TabInfo };
   tabPanelsMap: { [key: string]: TabInfo };
   behavior: Behavior;
+
+  lastAssignedTabIndexSig: Signal<number>;
+  lastAssignedPanelIndexSig: Signal<number>;
 }

packages/kit-headless/src/components/tabs/tabs-list.tsx

@@ -1,11 +1,10 @@
-import { component$, Slot } from '@builder.io/qwik';
+import { component$, QwikIntrinsicElements, Slot } from '@builder.io/qwik';
 import { Behavior } from './behavior.type';
 
-export interface TabListProps {
+export type TabListProps = QwikIntrinsicElements['div'] & {
   labelledBy?: string;
   behavior?: Behavior;
-  class?: string;
-}
+};
 
 // List of tabs that can be clicked to show different content.
 export const TabList = component$((props: TabListProps) => {

packages/kit-headless/src/components/tabs/tabs-panel.tsx

@@ -5,32 +5,49 @@ import {
   Slot,
   useTask$,
   useComputed$,
+  useSignal,
 } from '@builder.io/qwik';
 import { tabsContextId } from './tabs-context-id';
+import { isBrowser, isServer } from '@builder.io/qwik/build';
 
 export interface TabPanelProps {
   class?: string;
 }
 
 export const TabPanel = component$(({ ...props }: TabPanelProps) => {
   const contextService = useContext(tabsContextId);
+
+  const serverAssignedIndexSig = useSignal<number | undefined>(undefined);
+
   const panelUID = useId();
 
   const matchedTabId = useComputed$(
     () => contextService.tabPanelsMap[panelUID]?.tabId
   );
 
   useTask$(({ cleanup }) => {
-    contextService.tabsChanged$();
-
+    if (isServer) {
+      serverAssignedIndexSig.value =
+        contextService.lastAssignedPanelIndexSig.value;
+      contextService.lastAssignedPanelIndexSig.value++;
+    }
+    if (isBrowser) {
+      contextService.onTabsChanged$();
+    }
     cleanup(() => {
-      contextService.tabsChanged$();
+      contextService.onTabsChanged$();
     });
   });
 
   const isSelectedSignal = useComputed$(() => {
+    if (isServer) {
+      return (
+        serverAssignedIndexSig.value === contextService.selectedIndexSig.value
+      );
+    }
+
     return (
-      contextService.selectedIndex.value ===
+      contextService.selectedIndexSig.value ===
       contextService.tabPanelsMap[panelUID]?.index
     );
   });