@magic-spells/tab-group 0.1.0 → 1.1.0

package/dist/tab-group.css

@@ -1,95 +1,19 @@
 tab-group {
   display: block;
-  width: 100%;
-  font-family: var(--font-family);
-  font-size: var(--font-size-base);
-  line-height: var(--line-height);
-  color: var(--color-text);
 }
 
 tab-list {
   display: flex;
-  border-bottom: var(--tab-list-border-bottom, 1px solid var(--color-border));
-  margin-bottom: var(--spacing-md);
   overflow-x: auto;
   overflow-y: hidden;
-  padding: var(--tab-list-padding, 0.5rem 0.25rem 0);
-  gap: var(--tab-list-gap, 0.25rem);
-  justify-content: var(--tab-list-justify, flex-start);
-  background-color: var(--tab-list-background, transparent);
-  background-image: var(--tab-list-background-image, none);
-  border-radius: var(--tab-list-radius, 0);
 }
 
 tab-button {
   display: block;
-  padding: var(--spacing-sm) var(--spacing-md);
-  margin: var(--spacing-xs);
-  border: 1px solid transparent;
-  border-bottom: none;
-  background-color: var(--color-background);
-  color: var(--color-text);
   cursor: pointer;
-  border-radius: var(--tab-button-radius, var(--border-radius) var(--border-radius) 0 0);
-  white-space: nowrap;
   user-select: none;
-  transition: all var(--transition-duration);
-  margin-bottom: -1px;
-  position: relative;
-  font-size: var(--font-size-base);
-  font-weight: var(--tab-button-font-weight, normal);
-  text-align: center;
-  min-width: 100px;
-}
-tab-button:hover {
-  background-color: var(--color-hover);
-}
-tab-button:focus {
-  outline: none;
-  box-shadow: var(--tab-button-focus-shadow, 0 0 0 2px var(--color-primary));
-}
-tab-button[aria-selected=true] {
-  background-color: var(--tab-active-background, var(--color-background));
-  border-color: var(--color-border);
-  border-bottom: 1px solid var(--color-background);
-  font-weight: var(--tab-active-font-weight, 600);
-  color: var(--tab-active-color, var(--color-primary));
-  box-shadow: var(--tab-active-shadow, none);
-  transform: var(--tab-active-transform, none);
-}
-tab-button[aria-selected=true]::after {
-  content: "";
-  position: absolute;
-  bottom: 0;
-  left: var(--tab-indicator-left, 0);
-  right: var(--tab-indicator-right, 0);
-  height: var(--tab-indicator-height, 2px);
-  background-color: var(--tab-indicator-color, var(--color-primary));
-  border-radius: var(--tab-indicator-radius, 0);
 }
 
-tab-panel {
-  display: block;
-  padding: var(--panel-padding, var(--spacing-md));
-  background-color: var(--panel-background, var(--color-background));
-  border-radius: var(--panel-radius, 0 0 var(--border-radius) var(--border-radius));
-  border: var(--panel-border, none);
-  border-top: var(--panel-border-top, none);
-  box-shadow: var(--panel-shadow, none);
-  transition: var(--panel-transition, all 0.3s ease);
-  margin: var(--panel-margin, 0);
-  min-height: var(--panel-min-height, 150px);
-}
 tab-panel[hidden] {
   display: none;
 }
-
-@media (max-width: 768px) {
-  tab-list {
-    flex-wrap: wrap;
-  }
-  tab-button {
-    flex: 1 0 auto;
-    text-align: center;
-  }
-}

package/dist/tab-group.esm.js

@@ -3,23 +3,13 @@
  * A fully accessible tab group web component
  */
 
+let instanceCount = 0;
+
 /**
  * @class TabGroup
  * the parent container that coordinates tabs and panels
  */
 class TabGroup extends HTMLElement {
-	// static counter to ensure global unique ids for tabs and panels
-	static tabCount = 0;
-	static panelCount = 0;
-
-	constructor() {
-		super();
-		// ensure that the number of <tab-button> and <tab-panel> elements match
-		// note: in some scenarios the child elements might not be available in the constructor,
-		// so adjust as necessary or consider running this check in connectedCallback()
-		this.ensureConsistentTabsAndPanels();
-	}
-
 	/**
 	 * @function ensureConsistentTabsAndPanels
 	 * makes sure there is an equal number of <tab-button> and <tab-panel> elements.
@@ -27,24 +17,24 @@ class TabGroup extends HTMLElement {
 	 * if there are more tabs than panels, inject extra panels.
 	 */
 	ensureConsistentTabsAndPanels() {
-		// get current tabs and panels within the tab group
-		let tabs = this.querySelectorAll("tab-button");
-		let panels = this.querySelectorAll("tab-panel");
+		// get current tabs and panels scoped to direct children only
+		let tabs = this.querySelectorAll(':scope > tab-list > tab-button');
+		let panels = this.querySelectorAll(':scope > tab-panel');
 
 		// if there are more panels than tabs
 		if (panels.length > tabs.length) {
 			const difference = panels.length - tabs.length;
 			// try to find a <tab-list> to insert new tabs
-			let tabList = this.querySelector("tab-list");
+			let tabList = this.querySelector(':scope > tab-list');
 			if (!tabList) {
 				// if not present, create one and insert it at the beginning
-				tabList = document.createElement("tab-list");
+				tabList = document.createElement('tab-list');
 				this.insertBefore(tabList, this.firstChild);
 			}
 			// inject extra <tab-button> elements into the tab list
 			for (let i = 0; i < difference; i++) {
-				const newTab = document.createElement("tab-button");
-				newTab.textContent = "default tab";
+				const newTab = document.createElement('tab-button');
+				newTab.textContent = 'default tab';
 				tabList.appendChild(newTab);
 			}
 		}
@@ -53,8 +43,8 @@ class TabGroup extends HTMLElement {
 			const difference = tabs.length - panels.length;
 			// inject extra <tab-panel> elements at the end of the tab group
 			for (let i = 0; i < difference; i++) {
-				const newPanel = document.createElement("tab-panel");
-				newPanel.innerHTML = "<p>default panel content</p>";
+				const newPanel = document.createElement('tab-panel');
+				newPanel.innerHTML = '<p>default panel content</p>';
 				this.appendChild(newPanel);
 			}
 		}
@@ -64,58 +54,149 @@ class TabGroup extends HTMLElement {
 	 * called when the element is connected to the dom
 	 */
 	connectedCallback() {
-		const _ = this;
+		// assign a stable instance id on first connect
+		if (!this._instanceId) {
+			this._instanceId = `tg-${instanceCount++}`;
+		}
+
+		// ensure that the number of <tab-button> and <tab-panel> elements match
+		this.ensureConsistentTabsAndPanels();
 
 		// find the <tab-list> element (should be exactly one)
-		_.tabList = _.querySelector("tab-list");
-		if (!_.tabList) return;
+		this.tabList = this.querySelector(':scope > tab-list');
+		if (!this.tabList) return;
 
 		// find all <tab-button> elements inside the <tab-list>
-		_.tabButtons = Array.from(_.tabList.querySelectorAll("tab-button"));
+		this.tabButtons = Array.from(
+			this.tabList.querySelectorAll('tab-button')
+		);
 
 		// find all <tab-panel> elements inside the <tab-group>
-		_.tabPanels = Array.from(_.querySelectorAll("tab-panel"));
+		this.tabPanels = Array.from(this.querySelectorAll(':scope > tab-panel'));
 
-		// initialize each tab-button with roles, ids and aria attributes
-		_.tabButtons.forEach((tab, index) => {
-			const tabIndex = TabGroup.tabCount++;
+		const prefix = this._instanceId;
 
-			// generate a unique id for each tab, e.g. "tab-0", "tab-1", ...
-			const tabId = `tab-${tabIndex}`;
+		// initialize each tab-button with roles, ids and aria attributes
+		this.tabButtons.forEach((tab, index) => {
+			const tabId = `${prefix}-tab-${index}`;
+			const panelId = `${prefix}-panel-${index}`;
 			tab.id = tabId;
-
-			// generate a corresponding panel id, e.g. "panel-0"
-			const panelId = `panel-${tabIndex}`;
-			tab.setAttribute("role", "tab");
-			tab.setAttribute("aria-controls", panelId);
+			tab.setAttribute('role', 'tab');
+			tab.setAttribute('aria-controls', panelId);
 
 			// first tab is active by default
 			if (index === 0) {
-				tab.setAttribute("aria-selected", "true");
-				tab.setAttribute("tabindex", "0");
+				tab.setAttribute('aria-selected', 'true');
+				tab.setAttribute('tabindex', '0');
 			} else {
-				tab.setAttribute("aria-selected", "false");
-				tab.setAttribute("tabindex", "-1");
+				tab.setAttribute('aria-selected', 'false');
+				tab.setAttribute('tabindex', '-1');
 			}
 		});
 
 		// initialize each tab-panel with roles, ids and aria attributes
-		_.tabPanels.forEach((panel, index) => {
-			const panelIndex = TabGroup.panelCount++;
-			const panelId = `panel-${panelIndex}`;
+		this.tabPanels.forEach((panel, index) => {
+			const panelId = `${prefix}-panel-${index}`;
 			panel.id = panelId;
-
-			panel.setAttribute("role", "tabpanel");
-			panel.setAttribute("aria-labelledby", `tab-${panelIndex}`);
+			panel.setAttribute('role', 'tabpanel');
+			panel.setAttribute('aria-labelledby', `${prefix}-tab-${index}`);
 
 			// hide panels except for the first one
 			panel.hidden = index !== 0;
 		});
 
 		// set up keyboard navigation and click delegation on the <tab-list>
-		_.tabList.setAttribute("role", "tablist");
-		_.tabList.addEventListener("keydown", (e) => _.onKeyDown(e));
-		_.tabList.addEventListener("click", (e) => _.onClick(e));
+		this.tabList.setAttribute('role', 'tablist');
+
+		// store bound handlers so we can remove them in disconnectedCallback
+		if (!this._onKeyDown) {
+			this._onKeyDown = (e) => this.onKeyDown(e);
+			this._onClick = (e) => this.onClick(e);
+		}
+		this.tabList.addEventListener('keydown', this._onKeyDown);
+		this.tabList.addEventListener('click', this._onClick);
+	}
+
+	/**
+	 * called when the element is disconnected from the dom
+	 */
+	disconnectedCallback() {
+		if (this._animationController) {
+			this._animationController.abort();
+			this._animationController = null;
+		}
+		if (this.tabList && this._onKeyDown) {
+			this.tabList.removeEventListener('keydown', this._onKeyDown);
+			this.tabList.removeEventListener('click', this._onClick);
+		}
+	}
+
+	/**
+	 * reads animation attributes from the element
+	 */
+	_getAnimateConfig() {
+		const outClass = this.getAttribute('animate-out-class');
+		const inClass = this.getAttribute('animate-in-class');
+		const timeout = parseInt(this.getAttribute('animate-timeout'), 10) || 500;
+		return { outClass, inClass, timeout, hasAnimation: !!(outClass || inClass) };
+	}
+
+	/**
+	 * adds a class and waits for animationend (or timeout), with abort support
+	 */
+	_waitForAnimation(element, className, timeout, signal) {
+		return new Promise((resolve) => {
+			if (signal.aborted) {
+				resolve();
+				return;
+			}
+
+			element.classList.add(className);
+
+			let timer;
+			const cleanup = () => {
+				element.classList.remove(className);
+				clearTimeout(timer);
+				element.removeEventListener('animationend', onEnd);
+				signal.removeEventListener('abort', onAbort);
+				resolve();
+			};
+
+			const onEnd = (e) => {
+				if (e.target === element) cleanup();
+			};
+
+			const onAbort = () => cleanup();
+
+			element.addEventListener('animationend', onEnd);
+			signal.addEventListener('abort', onAbort);
+			timer = setTimeout(cleanup, timeout);
+		});
+	}
+
+	/**
+	 * orchestrates out-animation → swap → in-animation
+	 */
+	async _animateTransition(oldPanel, newPanel, config, controller) {
+		const { signal } = controller;
+
+		// Phase 1: animate out
+		if (config.outClass && oldPanel) {
+			await this._waitForAnimation(oldPanel, config.outClass, config.timeout, signal);
+		}
+		if (signal.aborted) return;
+
+		// Phase 2: swap hidden
+		if (oldPanel) oldPanel.hidden = true;
+		newPanel.hidden = false;
+
+		// Phase 3: animate in
+		if (config.inClass) {
+			if (signal.aborted) return;
+			// force reflow so the browser sees the element before animating
+			newPanel.offsetHeight;
+			await this._waitForAnimation(newPanel, config.inClass, config.timeout, signal);
+		}
 	}
 
 	/**
@@ -124,35 +205,86 @@ class TabGroup extends HTMLElement {
 	 * @param {number} index - index of the tab to activate
 	 */
 	setActiveTab(index) {
-		const _ = this;
-		const previousIndex = _.tabButtons.findIndex(tab => tab.getAttribute("aria-selected") === "true");
+		if (index < 0 || index >= this.tabButtons.length) return;
+		const previousIndex = this.tabButtons.findIndex(
+			(tab) => tab.getAttribute('aria-selected') === 'true'
+		);
+
+		// cancel any in-flight animation
+		if (this._animationController) {
+			this._animationController.abort();
+			this._animationController = null;
+			// force-hide all panels (clean slate)
+			this.tabPanels.forEach((panel) => {
+				panel.hidden = true;
+			});
+		}
 
-		// update each tab-button
-		_.tabButtons.forEach((tab, i) => {
+		// update each tab-button (ARIA updates fire immediately)
+		this.tabButtons.forEach((tab, i) => {
 			const isActive = i === index;
-			tab.setAttribute("aria-selected", isActive ? "true" : "false");
-			tab.setAttribute("tabindex", isActive ? "0" : "-1");
+			tab.setAttribute('aria-selected', isActive ? 'true' : 'false');
+			tab.setAttribute('tabindex', isActive ? '0' : '-1');
 			if (isActive) {
 				tab.focus();
 			}
 		});
 
-		// update each tab-panel
-		_.tabPanels.forEach((panel, i) => {
-			panel.hidden = i !== index;
-		});
-
 		// dispatch event only if the tab actually changed
 		if (previousIndex !== index) {
 			const detail = {
 				previousIndex,
 				currentIndex: index,
-				previousTab: _.tabButtons[previousIndex],
-				currentTab: _.tabButtons[index],
-				previousPanel: _.tabPanels[previousIndex],
-				currentPanel: _.tabPanels[index]
+				previousTab: this.tabButtons[previousIndex],
+				currentTab: this.tabButtons[index],
+				previousPanel: this.tabPanels[previousIndex],
+				currentPanel: this.tabPanels[index],
 			};
-			_.dispatchEvent(new CustomEvent('tabchange', { detail, bubbles: true }));
+			this.dispatchEvent(
+				new CustomEvent('tabchange', { detail, bubbles: true })
+			);
+		}
+
+		const config = this._getAnimateConfig();
+		const oldPanel = previousIndex >= 0 ? this.tabPanels[previousIndex] : null;
+		const newPanel = this.tabPanels[index];
+
+		if (!config.hasAnimation || previousIndex === index) {
+			// instant switch (original behavior)
+			this.tabPanels.forEach((panel, i) => {
+				panel.hidden = i !== index;
+			});
+			return;
+		}
+
+		// animated transition
+		const controller = new AbortController();
+		this._animationController = controller;
+
+		// old panel was already force-hidden by abort above, so if we aborted
+		// a previous animation, skip animate-out (old panel is already gone)
+		const skipOut = oldPanel && oldPanel.hidden;
+
+		if (skipOut) {
+			// just animate in the new panel
+			newPanel.hidden = false;
+			if (config.inClass) {
+				newPanel.offsetHeight;
+				this._waitForAnimation(newPanel, config.inClass, config.timeout, controller.signal).then(() => {
+					if (this._animationController === controller) {
+						this._animationController = null;
+					}
+				});
+			} else {
+				this._animationController = null;
+			}
+		} else {
+			// full out → swap → in sequence
+			this._animateTransition(oldPanel, newPanel, config, controller).then(() => {
+				if (this._animationController === controller) {
+					this._animationController = null;
+				}
+			});
 		}
 	}
 
@@ -162,17 +294,16 @@ class TabGroup extends HTMLElement {
 	 * @param {MouseEvent} e - the click event
 	 */
 	onClick(e) {
-		const _ = this;
 		// check if the click occurred on or within a <tab-button>
-		const tabButton = e.target.closest("tab-button");
+		const tabButton = e.target.closest('tab-button');
 		if (!tabButton) return;
 
 		// determine the index of the clicked tab-button
-		const index = _.tabButtons.indexOf(tabButton);
+		const index = this.tabButtons.indexOf(tabButton);
 		if (index === -1) return;
 
 		// activate the tab with the corresponding index
-		_.setActiveTab(index);
+		this.setActiveTab(index);
 	}
 
 	/**
@@ -181,39 +312,39 @@ class TabGroup extends HTMLElement {
 	 * @param {KeyboardEvent} e - the keydown event
 	 */
 	onKeyDown(e) {
-		const _ = this;
 		// only process keys if focus is on a <tab-button>
-		const targetIndex = _.tabButtons.indexOf(e.target);
+		const targetIndex = this.tabButtons.indexOf(e.target);
 		if (targetIndex === -1) return;
 
 		let newIndex = targetIndex;
 		switch (e.key) {
-			case "ArrowLeft":
-			case "ArrowUp":
+			case 'ArrowLeft':
+			case 'ArrowUp':
 				// move to the previous tab (wrap around if necessary)
-				newIndex = targetIndex > 0 ? targetIndex - 1 : _.tabButtons.length - 1;
+				newIndex =
+					targetIndex > 0 ? targetIndex - 1 : this.tabButtons.length - 1;
 				e.preventDefault();
 				break;
-			case "ArrowRight":
-			case "ArrowDown":
+			case 'ArrowRight':
+			case 'ArrowDown':
 				// move to the next tab (wrap around if necessary)
-				newIndex = (targetIndex + 1) % _.tabButtons.length;
+				newIndex = (targetIndex + 1) % this.tabButtons.length;
 				e.preventDefault();
 				break;
-			case "Home":
+			case 'Home':
 				// jump to the first tab
 				newIndex = 0;
 				e.preventDefault();
 				break;
-			case "End":
+			case 'End':
 				// jump to the last tab
-				newIndex = _.tabButtons.length - 1;
+				newIndex = this.tabButtons.length - 1;
 				e.preventDefault();
 				break;
 			default:
 				return; // ignore other keys
 		}
-		_.setActiveTab(newIndex);
+		this.setActiveTab(newIndex);
 	}
 }
 
@@ -221,49 +352,31 @@ class TabGroup extends HTMLElement {
  * @class TabList
  * a container for the <tab-button> elements
  */
-class TabList extends HTMLElement {
-	constructor() {
-		super();
-	}
-
-	connectedCallback() {
-		// additional logic or styling can be added here if desired
-	}
-}
+class TabList extends HTMLElement {}
 
 /**
  * @class TabButton
  * a single tab button element
  */
-class TabButton extends HTMLElement {
-	constructor() {
-		super();
-	}
-
-	connectedCallback() {
-		// note: role and other attributes are handled by the parent
-	}
-}
+class TabButton extends HTMLElement {}
 
 /**
  * @class TabPanel
  * a single tab panel element
  */
-class TabPanel extends HTMLElement {
-	constructor() {
-		super();
-	}
-
-	connectedCallback() {
-		// note: role and other attributes are handled by the parent
-	}
+class TabPanel extends HTMLElement {}
+
+// define the custom elements (guarded against double-registration and SSR)
+if (typeof window !== 'undefined' && window.customElements) {
+	if (!customElements.get('tab-group'))
+		customElements.define('tab-group', TabGroup);
+	if (!customElements.get('tab-list'))
+		customElements.define('tab-list', TabList);
+	if (!customElements.get('tab-button'))
+		customElements.define('tab-button', TabButton);
+	if (!customElements.get('tab-panel'))
+		customElements.define('tab-panel', TabPanel);
 }
 
-// define the custom elements
-customElements.define("tab-group", TabGroup);
-customElements.define("tab-list", TabList);
-customElements.define("tab-button", TabButton);
-customElements.define("tab-panel", TabPanel);
-
-export { TabGroup, TabGroup as default };
+export { TabGroup as default };
 //# sourceMappingURL=tab-group.esm.js.map