Tabs: Auto-generate README

WordPress · Dec 20, 2024 · c3b9f31 · c3b9f31
1 parent 869d26b
commit c3b9f31
Show file tree

Hide file tree

Showing 8 changed files with 301 additions and 194 deletions.
diff --git a/packages/components/src/tabs/README.md b/packages/components/src/tabs/README.md
diff --git a/packages/components/src/tabs/docs-manifest.json b/packages/components/src/tabs/docs-manifest.json
@@ -0,0 +1,22 @@
+{
+	"$schema": "../../schemas/docs-manifest.json",
+	"displayName": "Tabs",
+	"filePath": "./index.tsx",
+	"subcomponents": [
+		{
+			"displayName": "TabList",
+			"preferredDisplayName": "Tabs.TabList",
+			"filePath": "./tablist.tsx"
+		},
+		{
+			"displayName": "Tab",
+			"preferredDisplayName": "Tabs.Tab",
+			"filePath": "./tab.tsx"
+		},
+		{
+			"displayName": "TabPanel",
+			"preferredDisplayName": "Tabs.TabPanel",
+			"filePath": "./tabpanel.tsx"
+		}
+	]
+}
diff --git a/packages/components/src/tabs/index.tsx b/packages/components/src/tabs/index.tsx
@@ -36,11 +36,14 @@ function internalToExternalTabId(
 }
 
 /**
- * Display one panel of content at a time with a tabbed interface, based on the
- * WAI-ARIA Tabs Pattern⁠.
+ * Tabs is a collection of React components that combine to render
+ * an [ARIA-compliant tabs pattern](https://www.w3.org/WAI/ARIA/apg/patterns/tabs/).
  *
- * @see https://www.w3.org/WAI/ARIA/apg/patterns/tabs/
- * ```
+ * Tabs organizes content across different screens, data sets, and interactions.
+ * It has two sections: a list of tabs, and the view to show when tabs are chosen.
+ *
+ * `Tabs` itself is a wrapper component and context provider.
+ * It is responsible for managing the state of the tabs, and rendering the `TabList` and `TabPanels`.
  */
 export const Tabs = Object.assign(
 	function Tabs( {
@@ -121,12 +124,26 @@ export const Tabs = Object.assign(
 		);
 	},
 	{
+		/**
+		 * Renders a single tab.
+		 *
+		 * The currently active tab receives default styling that can be
+		 * overridden with CSS targeting `[aria-selected="true"]`.
+		 */
 		Tab: Object.assign( Tab, {
 			displayName: 'Tabs.Tab',
 		} ),
+		/**
+		 * A wrapper component for the `Tab` components.
+		 *
+		 * It is responsible for rendering the list of tabs.
+		 */
 		TabList: Object.assign( TabList, {
 			displayName: 'Tabs.TabList',
 		} ),
+		/**
+		 * Renders the content to display for a single tab once that tab is selected.
+		 */
 		TabPanel: Object.assign( TabPanel, {
 			displayName: 'Tabs.TabPanel',
 		} ),

diff --git a/packages/components/src/tabs/stories/best-practices.mdx b/packages/components/src/tabs/stories/best-practices.mdx
@@ -0,0 +1,92 @@
+import { Meta } from '@storybook/blocks';
+
+import * as TabsStories from './index.story';
+
+<Meta of={ TabsStories } name="Best Practices" />
+
+# Tabs
+
+## Usage
+
+### Uncontrolled Mode
+
+Tabs can be used in an uncontrolled mode, where the component manages its own state. In this mode, the `defaultTabId` prop can be used to set the initially selected tab. If this prop is not set, the first tab will be selected by default. In addition, in most cases where the currently active tab becomes disabled or otherwise unavailable, uncontrolled mode will automatically fall back to selecting the first available tab.
+
+```jsx
+import { Tabs } from '@wordpress/components';
+
+const onSelect = ( tabName ) => {
+  console.log( 'Selecting tab', tabName );
+};
+
+const MyUncontrolledTabs = () => (
+    <Tabs onSelect={ onSelect } defaultTabId="tab2">
+      <Tabs.TabList>
+        <Tabs.Tab tabId="tab1" title="Tab 1">
+          Tab 1
+        </Tabs.Tab>
+        <Tabs.Tab tabId="tab2" title="Tab 2">
+          Tab 2
+        </Tabs.Tab>
+        <Tabs.Tab tabId="tab3" title="Tab 3">
+          Tab 3
+        </Tabs.Tab>
+      </Tabs.TabList>
+      <Tabs.TabPanel tabId="tab1">
+        <p>Selected tab: Tab 1</p>
+      </Tabs.TabPanel>
+      <Tabs.TabPanel tabId="tab2">
+        <p>Selected tab: Tab 2</p>
+      </Tabs.TabPanel>
+      <Tabs.TabPanel tabId="tab3">
+        <p>Selected tab: Tab 3</p>
+      </Tabs.TabPanel>
+    </Tabs>
+  );
+```
+
+### Controlled Mode
+
+Tabs can also be used in a controlled mode, where the parent component specifies the `selectedTabId` and the `onSelect` props to control tab selection. In this mode, the `defaultTabId` prop will be ignored if it is provided. If the `selectedTabId` is `null`, no tab is selected. In this mode, if the currently selected tab becomes disabled or otherwise unavailable, the component will _not_ fall back to another available tab, leaving the controlling component in charge of implementing the desired logic.
+
+```tsx
+import { Tabs } from '@wordpress/components';
+  const [ selectedTabId, setSelectedTabId ] = useState<
+    string | undefined | null
+  >();
+
+const onSelect = ( tabName ) => {
+  console.log( 'Selecting tab', tabName );
+};
+
+const MyControlledTabs = () => (
+    <Tabs
+      selectedTabId={ selectedTabId }
+      onSelect={ ( selectedId ) => {
+        setSelectedTabId( selectedId );
+        onSelect( selectedId );
+      } }
+    >
+      <Tabs.TabList>
+        <Tabs.Tab tabId="tab1" title="Tab 1">
+          Tab 1
+        </Tabs.Tab>
+        <Tabs.Tab tabId="tab2" title="Tab 2">
+          Tab 2
+        </Tabs.Tab>
+        <Tabs.Tab tabId="tab3" title="Tab 3">
+          Tab 3
+        </Tabs.Tab>
+      </Tabs.TabList>
+      <Tabs.TabPanel tabId="tab1">
+        <p>Selected tab: Tab 1</p>
+      </Tabs.TabPanel>
+      <Tabs.TabPanel tabId="tab2">
+        <p>Selected tab: Tab 2</p>
+      </Tabs.TabPanel>
+      <Tabs.TabPanel tabId="tab3">
+        <p>Selected tab: Tab 3</p>
+      </Tabs.TabPanel>
+    </Tabs>
+  );
+```
diff --git a/packages/components/src/tabs/tab.tsx b/packages/components/src/tabs/tab.tsx
@@ -18,6 +18,12 @@ import {
 import type { WordPressComponentProps } from '../context';
 import { chevronRight } from '@wordpress/icons';
 
+/**
+ * Renders a single tab.
+ *
+ * The currently active tab receives default styling that can be
+ * overridden with CSS targeting `[aria-selected="true"]`.
+ */
 export const Tab = forwardRef<
 	HTMLButtonElement,
 	Omit< WordPressComponentProps< TabProps, 'button', false >, 'id' >

diff --git a/packages/components/src/tabs/tablist.tsx b/packages/components/src/tabs/tablist.tsx
@@ -67,6 +67,11 @@ function useScrollRectIntoView(
 	}, [ margin, parent, rect ] );
 }
 
+/**
+ * A wrapper component for the `Tab` components.
+ *
+ * It is responsible for rendering the list of tabs.
+ */
 export const TabList = forwardRef<
 	HTMLDivElement,
 	WordPressComponentProps< TabListProps, 'div', false >

diff --git a/packages/components/src/tabs/tabpanel.tsx b/packages/components/src/tabs/tabpanel.tsx
@@ -18,6 +18,9 @@ import warning from '@wordpress/warning';
 import { useTabsContext } from './context';
 import type { WordPressComponentProps } from '../context';
 
+/**
+ * Renders the content to display for a single tab once that tab is selected.
+ */
 export const TabPanel = forwardRef<
 	HTMLDivElement,
 	Omit< WordPressComponentProps< TabPanelProps, 'div', false >, 'id' >

diff --git a/packages/components/src/tabs/types.ts b/packages/components/src/tabs/types.ts
@@ -26,12 +26,10 @@ export type TabsProps = {
 	/**
 	 * Determines if the tab should be selected when it receives focus. If set to
 	 * `false`, the tab will only be selected upon clicking, not when using arrow
-	 * keys to shift focus (manual tab activation). See the official W3C docs
+	 * keys to shift focus (manual tab activation). See the [official W3C docs](https://www.w3.org/WAI/ARIA/apg/patterns/tabpanel/)
 	 * for more info.
 	 *
 	 * @default true
-	 *
-	 * @see https://www.w3.org/WAI/ARIA/apg/patterns/tabpanel/
 	 */
 	selectOnMove?: Ariakit.TabStoreProps[ 'selectOnMove' ];
 	/**
@@ -63,6 +61,7 @@ export type TabsProps = {
 	/**
 	 * The current active tab `id`. The active tab is the tab element within the
 	 * tablist widget that has DOM focus.
+	 *
 	 * - `null` represents the tablist (ie. the base composite element). Users
 	 *   will be able to navigate out of it using arrow keys.
 	 * - If `activeTabId` is initially set to `null`, the base composite element
@@ -87,6 +86,7 @@ export type TabsProps = {
 	/**
 	 * Defines the orientation of the tablist and determines which arrow keys
 	 * can be used to move focus:
+	 *
 	 * - `both`: all arrow keys work.
 	 * - `horizontal`: only left and right arrow keys work.
 	 * - `vertical`: only up and down arrow keys work.