Core API reference

88 public symbols generated from the TypeScript declarations of the library.

Directives

Name	Summary
DraggableDirective	Wraps native HTML5 Drag and Drop (dragstart/dragend/dragenter/dragleave/dragover/ drop).
DropZoneDirective
OverlayTriggerDirective	Mark a <ng-template inside your component as the overlay content.
SplitterContainerDirective
SplitterHandleDirective	The draggable/keyboard separator between two panels.
SplitterPanelDirective
ViewportMatchDirective	Structural/behavioral directive that exposes viewport breakpoint signals and applies CSS classes based on the default breakpoints.
VirtualScrollDirective	Virtual scroll directive that calculates which items should be rendered based on the viewport size and scroll position.

Services

Name	Summary
DirectionalityService	Root-level reactive source of truth for the document's text direction.
DragDropService
OverlayService
QzIdGenerator	Application-scoped generator for DOM ids.
SplitterService
ViewportService	Root-level service that tracks viewport dimensions and media-query matches using reactive signals.

Functions

Name	Summary
applyArrowAttributes	Mirrors arrow geometry onto a surface element so consumers can style an arrow in plain CSS: data-side, data-placement and --qz-arrow-x/--qz-arrow-y (px; remove…
calculateArrowGeometry	Computes the arrow position for a surface already positioned at surface.
calculatePosition
compareDomOrder
createDismissController
createFocusRestorer	Captures the currently focused element and returns a restorer for it.
createFocusTrap
createScrollLock
findByTypeahead
findRelativeItem	Next/previous enabled item relative to activeId.
firstItem
focusInitialElement
focusSafely
getElement
getFocusableElements
getLabel
getScrollParents
inlineEndKey	The arrow key that moves toward inline-end (the reading direction's end) for direction.
inlineStartKey	The arrow key that moves toward inline-start (the reading direction's beginning) for direction.
inlineToPhysical	Converts a logical inline position to the physical side it renders on for direction.
isDisabled
isFocusable	Whether element can receive programmatic focus (element.focus()) right now.
lastItem
oppositeDirection	The other direction.
physicalToInline	Converts a physical side back to the logical inline position it represents for direction.
placementSide
resolveDirection	Resolves the effective direction for an element by walking up to the nearest ancestor (including itself) that carries a dir attribute — the same resolution <ht…
resolveInlineArrowKey	Classifies a keyboard event's key as an inline-start/inline-end move for direction, or null when it's not a horizontal arrow key at all.
sortByDomOrder

Classes

Name	Summary
CollectionStore
OverlayRef

Interfaces

Name	Summary
CollectionConfig
CollectionItem
CollectionNavigationResult
DismissConfig
DismissController
DragDropConfig
DropZoneConfig
FocusRestorer
FocusTrap
OverlayArrowGeometry	Geometry for a consumer-rendered arrow.
OverlayArrowOptions
OverlayConfig
OverlayPosition
OverlayVirtualAnchor
QzDragEndInfo
QzDragInfo
QzDragOverInfo
QzDropInfo
ScrollLock
SplitterConfig
SplitterState
ViewportBreakpoints	Map of breakpoint names to pixel widths.
ViewportMatchResult	Result of matching all predefined breakpoints.
VirtualScrollConfig	Configuration object for virtual scroll.
VirtualScrollRow	Represents a single visible row in the virtual viewport.

Types

Name	Summary
CollectionFocusStrategy
CollectionOrientation
Direction	Text/layout direction.
DismissReason
InlineArrowKey	The two arrow keys that move along the horizontal/inline axis.
LogicalInlineDirection	A logical position along the inline (reading) axis.
OverlayAnchor
OverlayFlipAxis
OverlayPlacement
OverlaySide	A physical side of a rectangle.
PhysicalHorizontal	A physical horizontal side.
SplitterOrientation
ViewportBreakpoint	Predefined breakpoint names used by the ViewportService.

Constants

Name	Summary
DEFAULT_BREAKPOINTS	Default breakpoints following Tailwind conventions.
DEFAULT_COLLECTION_CONFIG
DEFAULT_OVERLAY_CONFIG
DEFAULT_SPLITTER_CONFIG
FOCUSABLE_SELECTOR