@mhmo91/schmancy 0.9.17 → 0.9.19

package/src/list/list-item.ts

@@ -6,7 +6,17 @@ import { css, html } from 'lit'
 import { customElement, property, queryAssignedElements } from 'lit/decorators.js'
 
 /**
+ * Single row in a schmancy-list — supports leading icon/avatar, main content, trailing actions. Clickable via click event, or used as a schmancy-menu-item's visual base.
+ *
  * @element schmancy-list-item
+ * @summary Prefer nesting inside schmancy-list for consistent spacing/surface. Use `href` to make the row a navigation target (renders as `<a>`), or a click handler for in-app actions.
+ * @example
+ * <schmancy-list-item href="/profile">
+ *   <schmancy-icon slot="leading">person</schmancy-icon>
+ *   Profile
+ *   <schmancy-icon slot="trailing">chevron_right</schmancy-icon>
+ * </schmancy-list-item>
+ * @platform li click - Styled `<li>` or `<a>` depending on `href`. Degrades to a plain list item if the tag never registers.
  * @slot leading - leading content
  * @slot trailing - trailing content
  * @slot - default content

package/src/list/list.ts

@@ -7,19 +7,18 @@ import { customElement, property } from 'lit/decorators.js'
 import { SchmancyListTypeContext } from './context'
 
 /**
- * `<schmancy-list>` component.
- *
- * A list component that wraps its content within a customizable surface.
- * It allows you to set the surface type and fill style, and can optionally
- * enable scrolling behavior by delegating the scroller attribute to the surface.
+ * Wrapped list container — holds schmancy-list-item children on a themed surface. Optionally scrollable.
  *
  * @element schmancy-list
- * @slot - The default slot for list items.
- *
+ * @summary Use for vertical lists of similarly-shaped items: settings entries, menu items, contact lists, notification lists. Pair with schmancy-list-item children.
  * @example
  * <schmancy-list surface="container" scroller>
- *   <schmancy-list-item>List Item 1</schmancy-list-item>
+ *   <schmancy-list-item>First</schmancy-list-item>
+ *   <schmancy-list-item>Second</schmancy-list-item>
+ *   <schmancy-list-item>Third</schmancy-list-item>
  * </schmancy-list>
+ * @platform ul - Styled list container. Degrades to a plain ul/div if the tag never registers.
+ * @slot - The default slot for list items.
  */
 @customElement('schmancy-list')
 export class List extends TailwindElement(css`

package/src/menu/menu-item.ts

@@ -3,6 +3,19 @@ import { css, html } from 'lit'
 import { customElement } from 'lit/decorators.js'
 import { $dialog } from '../dialog/dialog-service'
 
+/**
+ * Single item inside a schmancy-menu. Auto-dismisses the menu dialog on click — attach your action handler to `@click` and it just works.
+ *
+ * @element schmancy-menu-item
+ * @summary Always nested inside schmancy-menu. The click handler runs before the dialog closes, so `@click=${() => doThing()}` is the full pattern.
+ * @example
+ * <schmancy-menu-item @click=${() => archive()}>
+ *   <schmancy-icon slot="leading">archive</schmancy-icon>
+ *   Archive
+ * </schmancy-menu-item>
+ * @platform menuitem click - Wraps schmancy-list-item with auto-dismiss. Degrades to a styled `<button role="menuitem">` if the tag never registers.
+ * @slot - The item label and optional icons.
+ */
 @customElement('schmancy-menu-item')
 export default class SchmancyMenuItem extends $LitElement(css`
 	:host {

package/src/menu/menu.ts

@@ -4,31 +4,19 @@ import { customElement, query } from 'lit/decorators.js'
 import { $dialog } from '../dialog/dialog-service'
 
 /**
- * Menu Component
+ * Floating menu — a trigger button + a list of schmancy-menu-item children that open as a positioned dialog on click.
  *
- * CRITICAL: The dialog ONLY renders the raw menu items passed via the default slot.
- * NO <ul> wrapper, NO classes, NO additional markup in the dialog call.
- * The dialog service handles positioning and display - we just pass the pure content.
- *
- * @example Basic menu with auto-dismiss
- * ```typescript
+ * @element schmancy-menu
+ * @summary Use for dropdown menus attached to a button or icon — "More actions", "Account", row overflow menus in tables. Clicking a schmancy-menu-item inside auto-dismisses; custom components slotted inside must call `$dialog.dismiss()` themselves.
+ * @example
  * <schmancy-menu>
- *   <schmancy-button slot="trigger">Actions</schmancy-button>
- *   <schmancy-menu-item @click=${() => editItem()}>Edit</schmancy-menu-item>
- *   <schmancy-menu-item @click=${() => deleteItem()}>Delete</schmancy-menu-item>
+ *   <schmancy-icon-button slot="trigger" aria-label="Actions">
+ *     <schmancy-icon>more_vert</schmancy-icon>
+ *   </schmancy-icon-button>
+ *   <schmancy-menu-item @click=${() => edit()}>Edit</schmancy-menu-item>
+ *   <schmancy-menu-item @click=${() => remove()}>Delete</schmancy-menu-item>
  * </schmancy-menu>
- * ```
- * Note: Dialog auto-dismisses when schmancy-menu-item is clicked
- *
- * @example Custom component (manual dismiss)
- * ```typescript
- * <schmancy-menu>
- *   <schmancy-icon-button slot="trigger">settings</schmancy-icon-button>
- *   <my-settings-form @submit=${() => $dialog.dismiss()}></my-settings-form>
- * </schmancy-menu>
- * ```
- * Note: Custom components must call $dialog.dismiss() manually
- *
+ * @platform menu close - Trigger + floating listbox dialog. Degrades to a native `<select>` or inline list if the tag never registers.
  * @slot trigger - Button to open menu (new naming)
  * @slot button - Button to open menu (backward compatible)
  * @slot default - Menu items or any custom component to display in dialog

package/src/nav-drawer/appbar.ts

@@ -3,7 +3,18 @@ import { css, html } from 'lit'
 import { customElement } from 'lit/decorators.js'
 
 /**
+ * Top app bar region inside schmancy-nav-drawer — the horizontal strip above the content area that typically holds the page title, hamburger trigger, and contextual actions.
+ *
  * @element schmancy-nav-drawer-appbar
+ * @summary Always nested inside schmancy-nav-drawer. Holds the page-level title + top-right actions. On mobile, the drawer's hamburger button renders inside this region.
+ * @example
+ * <schmancy-nav-drawer-appbar>
+ *   <schmancy-typography type="title" token="lg">Dashboard</schmancy-typography>
+ *   <schmancy-icon-button slot="trailing" aria-label="Notifications">
+ *     <schmancy-icon>notifications</schmancy-icon>
+ *   </schmancy-icon-button>
+ * </schmancy-nav-drawer-appbar>
+ * @platform header - Styled horizontal bar. Degrades to a plain header element if the tag never registers.
  * @slot - The default slot
  */
 @customElement('schmancy-nav-drawer-appbar')

package/src/nav-drawer/content.ts

@@ -3,6 +3,17 @@ import { css, html } from 'lit'
 import { customElement } from 'lit/decorators.js'
 import { fromEvent, takeUntil } from 'rxjs'
 
+/**
+ * Main content region inside schmancy-nav-drawer — typically hosts the router outlet or the page's body content.
+ *
+ * @element schmancy-nav-drawer-content
+ * @summary Always nested inside schmancy-nav-drawer. Scrollable by default; propagates scroll events up so the drawer can collapse app-bar on scroll.
+ * @example
+ * <schmancy-nav-drawer-content>
+ *   <schmancy-area name="main"></schmancy-area>
+ * </schmancy-nav-drawer-content>
+ * @platform main scroll - Scrollable `<main>`. Degrades to a plain scrollable div if the tag never registers.
+ */
 @customElement('schmancy-nav-drawer-content')
 export class SchmancyNavigationDrawerContent extends $LitElement(css`
 	:host {

package/src/nav-drawer/drawer.ts

@@ -12,8 +12,23 @@ import {
 } from './context'
 
 /**
+ * Responsive navigation drawer — a left sidebar that becomes a hamburger-triggered modal overlay on narrow viewports. Composes schmancy-nav-drawer-navbar (the nav rail), schmancy-nav-drawer-appbar (the top bar), and schmancy-nav-drawer-content (the main region).
+ *
  * @element schmancy-nav-drawer
+ * @summary The app-shell layout primitive. Wrap your whole app in this when you want "persistent sidebar on desktop, drawer on mobile" behavior. Mode auto-switches at the breakpoint.
+ * @example
+ * <schmancy-nav-drawer>
+ *   <schmancy-nav-drawer-navbar>
+ *     <!-- nav items, typically schmancy-list-item links -->
+ *   </schmancy-nav-drawer-navbar>
+ *   <schmancy-nav-drawer-appbar>App title</schmancy-nav-drawer-appbar>
+ *   <schmancy-nav-drawer-content>
+ *     <!-- router outlet / page content -->
+ *   </schmancy-nav-drawer-content>
+ * </schmancy-nav-drawer>
+ * @platform div - Flex layout with viewport-width mode switching. Degrades to a stack of plain divs if the tag never registers.
  * @slot - The content slot
+ * @fires schmancy-drawer-state - When the drawer open/close state changes on mobile.
  */
 @customElement('schmancy-nav-drawer')
 export class SchmancyNavigationDrawer extends $LitElement(css`

package/src/nav-drawer/navbar.ts

@@ -16,6 +16,20 @@ const OVERLAY_ANIM_DURATION_OPEN = 200
 const OVERLAY_ANIM_DURATION_CLOSE = 150
 const NAV_ANIM_DURATION = 200
 
+/**
+ * Sidebar region inside schmancy-nav-drawer — the persistent-on-desktop / modal-on-mobile nav rail.
+ *
+ * @element schmancy-nav-drawer-navbar
+ * @summary Always nested inside schmancy-nav-drawer. On desktop: pinned left sidebar. On mobile: modal overlay triggered by the hamburger button in schmancy-nav-drawer-appbar.
+ * @example
+ * <schmancy-nav-drawer-navbar>
+ *   <schmancy-list>
+ *     <schmancy-list-item href="/dashboard">Dashboard</schmancy-list-item>
+ *     <schmancy-list-item href="/settings">Settings</schmancy-list-item>
+ *   </schmancy-list>
+ * </schmancy-nav-drawer-navbar>
+ * @platform nav - Sidebar `<nav>` with responsive open/close behavior. Degrades to a plain sidebar div if the tag never registers.
+ */
 @customElement('schmancy-nav-drawer-navbar')
 export class SchmancyNavigationDrawerSidebar extends $LitElement() {
 	// Consume context values. Renamed from "state" to "drawerState" to avoid confusion.

package/src/navigation-bar/navigation-bar-item.ts

@@ -7,12 +7,11 @@ import { BehaviorSubject, fromEvent, merge, timer } from 'rxjs'
 import { takeUntil, tap, filter } from 'rxjs/operators'
 
 /**
- * `<schmancy-navigation-bar-item>` component
- *
- * Individual navigation item for use within a navigation bar.
- * Represents a single destination with an icon and optional label following Material Design 3 specifications.
+ * Single destination inside schmancy-navigation-bar — an icon + optional label representing one primary app destination.
  *
  * @element schmancy-navigation-bar-item
+ * @summary Always nested inside schmancy-navigation-bar. Use `icon` attr for a Material Symbols glyph or slot=icon for custom content.
+ * @platform button click - Styled navigation target. Degrades to a plain `<button>` if the tag never registers.
  * @slot icon - Slot for custom icon content
  * @slot - Default slot for custom content
  *

package/src/navigation-bar/navigation-bar.ts

@@ -15,17 +15,11 @@ const NAV_BAR_HEIGHT = 80
 const MOBILE_BREAKPOINT = '(max-width: 767px)'
 
 /**
- * `<schmancy-navigation-bar>` component
- *
- * A horizontal navigation component following Material Design 3 specifications.
- * Navigation bars provide access to between 3-7 primary destinations.
- * Automatically hides in fullscreen mode when triggered via schmancyTheme.next({ fullscreen: true }).
- *
- * **IMPORTANT**: This component includes `z-10` by default (consistent with navigation-rail).
- * The consumer is responsible for positioning the navigation bar in their layout.
- * For typical bottom-fixed positioning, add: `class="fixed bottom-0 left-0 right-0"`.
+ * Bottom navigation bar — Material Design 3 horizontal nav for mobile primary destinations (3–7 items). Auto-hides in fullscreen mode.
  *
  * @element schmancy-navigation-bar
+ * @summary Use for mobile primary navigation (home, search, favorites, settings). For persistent desktop nav, prefer schmancy-navigation-rail or schmancy-nav-drawer. Consumer is responsible for fixed-bottom positioning via class.
+ * @platform nav - Styled horizontal nav with schmancy-navigation-bar-item children. Degrades to a plain flex container if the tag never registers.
  * @slot - Default slot for navigation bar items
  *
  * @fires navigation-change - When an item is selected

package/src/navigation-rail/navigation-rail-item.ts

@@ -13,15 +13,11 @@ export type NavigationRailItemClickEvent = CustomEvent<{
 }>
 
 /**
- * Material Design 3 Navigation Rail Item Component
- * @see https://m3.material.io/components/navigation-rail/overview
- *
- * `<schmancy-navigation-rail-item>` component
- *
- * Individual navigation item for use within a navigation rail.
- * Represents a single destination or action with an icon and optional label.
+ * Single destination inside schmancy-navigation-rail — vertically-stacked icon + optional label. @see https://m3.material.io/components/navigation-rail/overview
  *
  * @element schmancy-navigation-rail-item
+ * @summary Always nested inside schmancy-navigation-rail. Use `icon` attr for a Material Symbols glyph, or slot=icon for custom content. Supports a `badge` slot for notification dots / counts.
+ * @platform button click - Styled vertical navigation target. Degrades to a plain `<button>` if the tag never registers.
  * @slot icon - Slot for the navigation item icon (e.g., schmancy-icon)
  * @slot - Default slot for custom content
  * @slot badge - Custom badge content

package/src/navigation-rail/navigation-rail.ts

@@ -15,16 +15,20 @@ export type NavigationRailFabClickEvent = CustomEvent<void>
 export type LabelVisibility = 'all' | 'selected' | 'none'
 
 /**
- * Material Design 3 Navigation Rail Component
- * @see https://m3.material.io/components/navigation-rail/overview
- *
- * `<schmancy-navigation-rail>` component
- *
- * A Material Design 3 vertical navigation component positioned on the left side of an application.
- * Navigation rails provide access to between 3-7 primary destinations with a compact footprint.
- * Automatically hides in fullscreen mode when triggered via schmancyTheme.next({ fullscreen: true }).
+ * Vertical navigation rail — Material Design 3 compact left-side nav for desktop / tablet layouts with 3–7 primary destinations. Auto-hides in fullscreen mode. @see https://m3.material.io/components/navigation-rail/overview
  *
  * @element schmancy-navigation-rail
+ * @summary Use as the desktop counterpart of schmancy-navigation-bar: same destinations, different form factor. Prefer schmancy-nav-drawer when you also want a drawer + app-bar combo.
+ * @example
+ * <schmancy-navigation-rail activeIndex="0">
+ *   <schmancy-icon-button slot="fab" variant="filled">
+ *     <schmancy-icon>add</schmancy-icon>
+ *   </schmancy-icon-button>
+ *   <schmancy-navigation-rail-item icon="home" label="Home"></schmancy-navigation-rail-item>
+ *   <schmancy-navigation-rail-item icon="search" label="Search"></schmancy-navigation-rail-item>
+ *   <schmancy-navigation-rail-item icon="settings" label="Settings"></schmancy-navigation-rail-item>
+ * </schmancy-navigation-rail>
+ * @platform nav - Vertical styled nav. Degrades to a plain vertical flex container if the tag never registers.
  * @slot fab - Slot for a floating action button at the top
  * @slot menu - Slot for a menu icon or button below the FAB
  * @slot header - Custom header content slot

package/src/sheet/sheet.ts

@@ -7,6 +7,23 @@ import { on } from './hook'
 import { SchmancySheetPosition, sheet } from './sheet.service'
 import { BLACKBIRD_EASING, DURATION_ENTER, DURATION_EXIT, DURATION_BACKDROP, EASE_OUT, EASE_IN } from '../utils/animation'
 
+/**
+ * Side-docked or bottom-docked panel — a dialog variant that slides in from an edge. Driven imperatively by the `sheet` service; rarely instantiated directly.
+ *
+ * @element schmancy-sheet
+ * @summary Prefer `sheet.open({ component, position })` over placing this element declaratively — the service handles stacking, focus, close on outside-click, ESC, and router integration.
+ * @example
+ * import { sheet, SchmancySheetPosition } from '@mhmo91/schmancy'
+ * sheet.open({
+ *   component: new MyEditorElement(),
+ *   position: SchmancySheetPosition.Side,
+ *   title: 'Edit item',
+ * })
+ * @platform dialog close - Positioned-fixed panel with backdrop. Degrades to a `<dialog>` if the tag never registers — loses slide animation, keeps focus trap + dismiss.
+ * @attr position - `'side' | 'bottom'`. Which edge the sheet docks to.
+ * @attr open - Boolean; sheet is visible when true.
+ * @fires close - When the sheet is dismissed (backdrop click, close button, ESC).
+ */
 @customElement('schmancy-sheet')
 export default class SchmancySheet extends $LitElement(css`
 	:host {

package/src/typewriter/typewriter.ts

@@ -5,7 +5,20 @@ import hashContent from '@schmancy/utils/hashContent'
 import { intersection$ } from '@schmancy/utils/intersection'
 import { css, html, TemplateResult } from 'lit'
 import { customElement, property, query, queryAssignedElements, queryAssignedNodes } from 'lit/decorators.js'
-import TypeIt, { Options as TypeItOptions } from 'typeit'
+// TypeIt is loaded lazily on first render — see ADR 0014 in the parent
+// monorepo. The static import was replaced with a type-only import plus a
+// memoised dynamic loader so the ~15 KB gzipped vendor chunk stays out of
+// the agent bundle's first paint for pages that don't render a typewriter.
+import type { Options as TypeItOptions } from 'typeit'
+type TypeItCtor = typeof import('typeit').default
+type TypeItInstance = InstanceType<TypeItCtor>
+
+let typeItPromise: Promise<TypeItCtor> | null = null
+function loadTypeIt(): Promise<TypeItCtor> {
+	if (typeItPromise) return typeItPromise
+	typeItPromise = import('typeit').then(m => m.default)
+	return typeItPromise
+}
 
 @customElement('schmancy-typewriter')
 export class TypewriterElement extends $LitElement(css`
@@ -170,9 +183,11 @@ export class TypewriterElement extends $LitElement(css`
 	 */
 	@property({ type: Number }) cyclePause = 1500
 	/**
-	 * TypeIt instance.
+	 * TypeIt instance. Populated after `loadTypeIt()` resolves inside
+	 * `_startTyping()` — null until then, which is correct for a cold start
+	 * where the vendor chunk hasn't loaded yet.
 	 */
-	private typeItInstance: TypeIt | null = null
+	private typeItInstance: TypeItInstance | null = null
 
 	/**
 	 * Reference to the typewriter container.
@@ -202,8 +217,9 @@ export class TypewriterElement extends $LitElement(css`
 
 	/**
 	 * Initializes the TypeIt instance with the provided slotted content.
+	 * Async because TypeIt itself is lazy-loaded on first render.
 	 */
-	private _startTyping() {
+	private async _startTyping() {
 		// Destroy any existing TypeIt instance
 		this._destroyTypeIt()
 
@@ -246,6 +262,12 @@ export class TypewriterElement extends $LitElement(css`
 			},
 		}
 
+		// Load TypeIt lazily on first call (module-scope memoised promise).
+		const TypeIt = await loadTypeIt()
+		// Bail if we were disconnected during the load — avoids attaching to
+		// a detached host.
+		if (!this.isConnected) return
+
 		// Initialize TypeIt
 		this.typeItInstance = new TypeIt(this.typewriterContainer, typeItOptions)
 

package/types/src/breadcrumb/breadcrumb.d.ts

@@ -1,9 +1,16 @@
 declare const SchmancyBreadcrumb_base: import("@mixins/index").Constructor<CustomElementConstructor> & import("@mixins/index").Constructor<import("@mixins/index").ITailwindElementMixin> & import("@mixins/index").Constructor<import("lit").LitElement> & import("@mixins/index").Constructor<import("@mixins/index").IBaseMixin>;
 /**
- * Breadcrumb navigation container. Wraps a list of `schmancy-breadcrumb-item`
- * elements with the correct ARIA landmark and semantics.
+ * Breadcrumb trail — navigation history from root to current page. Renders schmancy-breadcrumb-item children with separators between.
  *
  * @element schmancy-breadcrumb
+ * @summary Use for deep hierarchical navigation (file explorer paths, e-commerce category chains, admin settings trees). Last item is styled as the current page automatically.
+ * @example
+ * <schmancy-breadcrumb separator="›">
+ *   <schmancy-breadcrumb-item href="/">Home</schmancy-breadcrumb-item>
+ *   <schmancy-breadcrumb-item href="/docs">Docs</schmancy-breadcrumb-item>
+ *   <schmancy-breadcrumb-item>Getting started</schmancy-breadcrumb-item>
+ * </schmancy-breadcrumb>
+ * @platform nav - Styled `<nav aria-label="Breadcrumb">`. Degrades to a plain nav if the tag never registers.
  * @slot - Default slot for `<schmancy-breadcrumb-item>` children.
  * @attr separator - Character or string rendered between items. Default `/`.
  * @csspart separator - The separator element.
@@ -16,10 +23,13 @@ export declare class SchmancyBreadcrumb extends SchmancyBreadcrumb_base {
 }
 declare const SchmancyBreadcrumbItem_base: import("@mixins/index").Constructor<CustomElementConstructor> & import("@mixins/index").Constructor<import("@mixins/index").ITailwindElementMixin> & import("@mixins/index").Constructor<import("lit").LitElement> & import("@mixins/index").Constructor<import("@mixins/index").IBaseMixin>;
 /**
- * Individual breadcrumb item. Renders as a link when `href` is provided,
- * otherwise as a plain span (represents the current page).
+ * Single segment in a schmancy-breadcrumb trail — a link when `href` is set, or a plain span (the current page) when omitted.
  *
  * @element schmancy-breadcrumb-item
+ * @summary Always nested inside schmancy-breadcrumb. Omit `href` on the current page — it gets aria-current="page" automatically.
+ * @example
+ * <schmancy-breadcrumb-item href="/products">Products</schmancy-breadcrumb-item>
+ * @platform a - Renders an `<a>` or `<span>` depending on href. Degrades to a plain anchor/span if the tag never registers.
  * @slot - Label content.
  * @attr href - If set, renders as an anchor.
  * @attr current - Marks as `aria-current="page"`.

package/types/src/dialog/dialog.component.d.ts

@@ -1,27 +1,27 @@
 declare const SchmancyDialog_base: import("@mixins/index").Constructor<import("./dialog-base.mixin").IDialogBaseMixin> & CustomElementConstructor & import("@mixins/index").Constructor<import("lit").LitElement> & import("@mixins/index").Constructor<import("@mixins/index").IBaseMixin>;
 /**
- * Unified dialog component that handles both content-only and confirm modes.
+ * Modal dialog — content-only (just a styled panel) or confirm mode (title + message + confirm/cancel buttons). Prefer the imperative `$dialog` service for most use cases; use the element directly only when you want a declaratively-positioned dialog.
  *
  * @element schmancy-dialog
+ * @summary Blocks interaction with the rest of the page until dismissed. For quick confirmations, prefer `$dialog.confirm({ ... })` over this element. For arbitrary dialog content driven imperatively, prefer `$dialog.component(MyComponent)`.
+ * @platform dialog close - Positioned overlay in light DOM. Degrades to a styled `<dialog>` if the tag never registers — loses custom animations but keeps focus trap + ESC close.
  * @slot default - Content slot for dialog body (used in content mode)
  * @slot content - Named slot for custom content in confirm mode
+ * @fires confirm - In confirm mode, when the confirm button is clicked.
+ * @fires cancel - In confirm mode, when the cancel button or ESC is activated.
  *
  * @example Content mode (no buttons):
- * ```html
  * <schmancy-dialog>
  *   <my-custom-content></my-custom-content>
  * </schmancy-dialog>
- * ```
  *
  * @example Confirm mode (with buttons):
- * ```html
  * <schmancy-dialog
- *   title="Confirm Action"
- *   message="Are you sure?"
- *   confirm-text="Yes"
- *   cancel-text="No"
+ *   title="Delete item?"
+ *   message="This action cannot be undone."
+ *   confirm-text="Delete"
+ *   cancel-text="Keep"
  * ></schmancy-dialog>
- * ```
  */
 export declare class SchmancyDialog extends SchmancyDialog_base {
     /**

package/types/src/dropdown/dropdown-component.d.ts

@@ -1,8 +1,20 @@
 declare const SchmancyDropdown_base: CustomElementConstructor & import("@mixins/index").Constructor<import("lit").LitElement> & import("@mixins/index").Constructor<import("@mixins/index").IBaseMixin>;
 /**
- * A dropdown component that displays content when triggered.
+ * Anchored floating dropdown — a generic "show this content relative to that trigger" primitive. Unlike schmancy-menu (which uses the dialog service and is list-shaped), dropdown is a low-level popover anchored with Floating UI. Use when you want a custom-shaped overlay tied to a specific trigger element without the menu semantics.
  *
  * @element schmancy-dropdown
+ * @summary Prefer schmancy-menu for action lists, schmancy-autocomplete for type-ahead, schmancy-tooltip for hover hints. Reach for schmancy-dropdown when none of those fit — custom filters, color pickers, inline forms anchored to a trigger.
+ * @example
+ * <schmancy-dropdown>
+ *   <schmancy-button slot="trigger">Filters</schmancy-button>
+ *   <schmancy-dropdown-content>
+ *     <schmancy-form>…</schmancy-form>
+ *   </schmancy-dropdown-content>
+ * </schmancy-dropdown>
+ * @platform div - Anchored via Floating UI (autoUpdate, flip, shift). Degrades to inline content if the tag never registers — loses positioning but content stays accessible.
+ * @attr open - Boolean; whether the dropdown is visible.
+ * @fires open - When the dropdown opens.
+ * @fires close - When the dropdown closes.
  * @slot trigger - The element that triggers the dropdown
  * @slot - Default slot for the dropdown content
  */

package/types/src/dropdown/dropdown-content.d.ts

@@ -1,11 +1,19 @@
 declare const SchmancyDropdownContent_base: import("@mixins/index").Constructor<CustomElementConstructor> & import("@mixins/index").Constructor<import("@mixins/index").ITailwindElementMixin> & import("@mixins/index").Constructor<import("lit").LitElement> & import("@mixins/index").Constructor<import("@mixins/index").IBaseMixin>;
 /**
- * Content container for the schmancy-dropdown component.
+ * Content panel for a schmancy-dropdown — a styled positioned surface. Always nested inside schmancy-dropdown and placed alongside the trigger slot.
  *
  * @element schmancy-dropdown-content
+ * @summary Nest this inside schmancy-dropdown (not in the trigger slot). Use the `content` CSS part to customize backgrounds / shadows / padding without shadow-root piercing.
+ * @example
+ * <schmancy-dropdown>
+ *   <schmancy-button slot="trigger">Open</schmancy-button>
+ *   <schmancy-dropdown-content>
+ *     Panel contents…
+ *   </schmancy-dropdown-content>
+ * </schmancy-dropdown>
+ * @platform div - Positioned panel with theme-aware styling. Degrades to an inline div if the tag never registers.
  * @slot - Default slot for dropdown content.
- * @csspart content - The inner wrapper element; style to override panel
- *   backgrounds, shadows, padding, or borders without shadow-root piercing.
+ * @csspart content - The inner wrapper element; style to override panel backgrounds, shadows, padding, or borders without shadow-root piercing.
  */
 export declare class SchmancyDropdownContent extends SchmancyDropdownContent_base {
     /**

package/types/src/list/list-item.d.ts

@@ -1,7 +1,17 @@
 import { TSurfaceColor } from '@schmancy/types/surface';
 declare const SchmancyListItem_base: import("@mixins/index").Constructor<CustomElementConstructor> & import("@mixins/index").Constructor<import("@mixins/index").ITailwindElementMixin> & import("@mixins/index").Constructor<import("lit").LitElement> & import("@mixins/index").Constructor<import("@mixins/index").IBaseMixin>;
 /**
+ * Single row in a schmancy-list — supports leading icon/avatar, main content, trailing actions. Clickable via click event, or used as a schmancy-menu-item's visual base.
+ *
  * @element schmancy-list-item
+ * @summary Prefer nesting inside schmancy-list for consistent spacing/surface. Use `href` to make the row a navigation target (renders as `<a>`), or a click handler for in-app actions.
+ * @example
+ * <schmancy-list-item href="/profile">
+ *   <schmancy-icon slot="leading">person</schmancy-icon>
+ *   Profile
+ *   <schmancy-icon slot="trailing">chevron_right</schmancy-icon>
+ * </schmancy-list-item>
+ * @platform li click - Styled `<li>` or `<a>` depending on `href`. Degrades to a plain list item if the tag never registers.
  * @slot leading - leading content
  * @slot trailing - trailing content
  * @slot - default content

package/types/src/list/list.d.ts

@@ -2,19 +2,18 @@ import { SchmancySurfaceFill } from '@schmancy/surface';
 import { TSurfaceColor } from '@schmancy/types/surface';
 declare const List_base: import("@mixins/index").Constructor<CustomElementConstructor> & import("@mixins/index").Constructor<import("@mixins/index").ITailwindElementMixin> & import("@mixins/index").Constructor<import("lit").LitElement> & import("@mixins/index").Constructor<import("@mixins/index").IBaseMixin>;
 /**
- * `<schmancy-list>` component.
- *
- * A list component that wraps its content within a customizable surface.
- * It allows you to set the surface type and fill style, and can optionally
- * enable scrolling behavior by delegating the scroller attribute to the surface.
+ * Wrapped list container — holds schmancy-list-item children on a themed surface. Optionally scrollable.
  *
  * @element schmancy-list
- * @slot - The default slot for list items.
- *
+ * @summary Use for vertical lists of similarly-shaped items: settings entries, menu items, contact lists, notification lists. Pair with schmancy-list-item children.
  * @example
  * <schmancy-list surface="container" scroller>
- *   <schmancy-list-item>List Item 1</schmancy-list-item>
+ *   <schmancy-list-item>First</schmancy-list-item>
+ *   <schmancy-list-item>Second</schmancy-list-item>
+ *   <schmancy-list-item>Third</schmancy-list-item>
  * </schmancy-list>
+ * @platform ul - Styled list container. Degrades to a plain ul/div if the tag never registers.
+ * @slot - The default slot for list items.
  */
 export declare class List extends List_base {
     /**

package/types/src/menu/menu-item.d.ts

@@ -1,4 +1,17 @@
 declare const SchmancyMenuItem_base: CustomElementConstructor & import("@mixins/index").Constructor<import("lit").LitElement> & import("@mixins/index").Constructor<import("@mixins/index").IBaseMixin>;
+/**
+ * Single item inside a schmancy-menu. Auto-dismisses the menu dialog on click — attach your action handler to `@click` and it just works.
+ *
+ * @element schmancy-menu-item
+ * @summary Always nested inside schmancy-menu. The click handler runs before the dialog closes, so `@click=${() => doThing()}` is the full pattern.
+ * @example
+ * <schmancy-menu-item @click=${() => archive()}>
+ *   <schmancy-icon slot="leading">archive</schmancy-icon>
+ *   Archive
+ * </schmancy-menu-item>
+ * @platform menuitem click - Wraps schmancy-list-item with auto-dismiss. Degrades to a styled `<button role="menuitem">` if the tag never registers.
+ * @slot - The item label and optional icons.
+ */
 export default class SchmancyMenuItem extends SchmancyMenuItem_base {
     protected render(): unknown;
 }

package/types/src/menu/menu.d.ts

@@ -1,30 +1,18 @@
 declare const SchmancyMenu_base: CustomElementConstructor & import("@mixins/index").Constructor<import("lit").LitElement> & import("@mixins/index").Constructor<import("@mixins/index").IBaseMixin>;
 /**
- * Menu Component
+ * Floating menu — a trigger button + a list of schmancy-menu-item children that open as a positioned dialog on click.
  *
- * CRITICAL: The dialog ONLY renders the raw menu items passed via the default slot.
- * NO <ul> wrapper, NO classes, NO additional markup in the dialog call.
- * The dialog service handles positioning and display - we just pass the pure content.
- *
- * @example Basic menu with auto-dismiss
- * ```typescript
+ * @element schmancy-menu
+ * @summary Use for dropdown menus attached to a button or icon — "More actions", "Account", row overflow menus in tables. Clicking a schmancy-menu-item inside auto-dismisses; custom components slotted inside must call `$dialog.dismiss()` themselves.
+ * @example
  * <schmancy-menu>
- *   <schmancy-button slot="trigger">Actions</schmancy-button>
- *   <schmancy-menu-item @click=${() => editItem()}>Edit</schmancy-menu-item>
- *   <schmancy-menu-item @click=${() => deleteItem()}>Delete</schmancy-menu-item>
+ *   <schmancy-icon-button slot="trigger" aria-label="Actions">
+ *     <schmancy-icon>more_vert</schmancy-icon>
+ *   </schmancy-icon-button>
+ *   <schmancy-menu-item @click=${() => edit()}>Edit</schmancy-menu-item>
+ *   <schmancy-menu-item @click=${() => remove()}>Delete</schmancy-menu-item>
  * </schmancy-menu>
- * ```
- * Note: Dialog auto-dismisses when schmancy-menu-item is clicked
- *
- * @example Custom component (manual dismiss)
- * ```typescript
- * <schmancy-menu>
- *   <schmancy-icon-button slot="trigger">settings</schmancy-icon-button>
- *   <my-settings-form @submit=${() => $dialog.dismiss()}></my-settings-form>
- * </schmancy-menu>
- * ```
- * Note: Custom components must call $dialog.dismiss() manually
- *
+ * @platform menu close - Trigger + floating listbox dialog. Degrades to a native `<select>` or inline list if the tag never registers.
  * @slot trigger - Button to open menu (new naming)
  * @slot button - Button to open menu (backward compatible)
  * @slot default - Menu items or any custom component to display in dialog

package/types/src/nav-drawer/appbar.d.ts

@@ -1,6 +1,17 @@
 declare const SchmancyDrawerAppbar_base: import("@mixins/index").Constructor<CustomElementConstructor> & import("@mixins/index").Constructor<import("@mixins/index").ITailwindElementMixin> & import("@mixins/index").Constructor<import("lit").LitElement> & import("@mixins/index").Constructor<import("@mixins/index").IBaseMixin>;
 /**
+ * Top app bar region inside schmancy-nav-drawer — the horizontal strip above the content area that typically holds the page title, hamburger trigger, and contextual actions.
+ *
  * @element schmancy-nav-drawer-appbar
+ * @summary Always nested inside schmancy-nav-drawer. Holds the page-level title + top-right actions. On mobile, the drawer's hamburger button renders inside this region.
+ * @example
+ * <schmancy-nav-drawer-appbar>
+ *   <schmancy-typography type="title" token="lg">Dashboard</schmancy-typography>
+ *   <schmancy-icon-button slot="trailing" aria-label="Notifications">
+ *     <schmancy-icon>notifications</schmancy-icon>
+ *   </schmancy-icon-button>
+ * </schmancy-nav-drawer-appbar>
+ * @platform header - Styled horizontal bar. Degrades to a plain header element if the tag never registers.
  * @slot - The default slot
  */
 export declare class SchmancyDrawerAppbar extends SchmancyDrawerAppbar_base {