APIinterfaces.
Every prop interface used across origam components. Fully documented with definitions, properties, extends chains and cross-references to the components that use them.
994 interfaces across 155 categories
BROWSE BY CATEGORY
All interfaces.
Action & Command
IClipboardEmits
interfaceEmits for <OrigamClipboard>. Two events: copy (success, carries the payload string) and error (failure, carries the thrown Error when the clipboard API is denied or unavailable).
IClipboardProps
interfaceProps for <OrigamClipboard> — a chrome-less copy-to-clipboard wrapper. Owns the copy pipeline (navigator.clipboard.writeText + execCommand fallback) and the auto-resetting copied flag. The built-in trigger is a single button; consumers can pass a #default scoped slot for full control.
IClipboardScopedSlotBindings
interfaceBindings exposed via the #default scoped slot of <OrigamClipboard>. Consumers use these to wire any custom trigger (button, icon, span, widget) to the copy pipeline without re-implementing the timing/feedback logic.
IClipboardSlots
interfaceSlot signatures for <OrigamClipboard>. The default slot receives copy/copied/error bindings for a fully custom trigger. The feedback slot replaces the success indicator shown after a successful copy.
Alert
Animation & Transition
ITransitionComponentProps
interfaceMinimal transition surface mixed into overlay and floating components. Accepts a transition name string, a full TTransitionProps object, or false/true to disable/use the component default.
ITransitionProps
interfaceCore transition configuration shared by all origam transition wrappers. Controls the Vue transition name, mode, group mode, leave behavior, and origin for transform-based animations.
ITransitionWindowProps
interfaceTransition props extended with an optional window context reference. Used by window/tab/step components so the transition direction can adapt based on the active index provided via IWindowProvide.
ITranslateScaleProps
interfaceExtends ITransitionProps with a target reference used by the translate-scale transition. The target anchors the transform-origin so the element scales from the activator position rather than its own center.
Audio
Behaviour
IRippleHtmlElementRipple
interfaceInternal state bag stored on a DOM element's _ripple property by the v-ripple directive. Tracks whether the ripple is enabled, centered, circular, and manages the show-timer commit callback.
IRippleOptions
interfaceOptions passed to the v-ripple directive when an object value is used. Controls the visual behaviour of the ripple wave: extra class, centred start, and forced circular shape.
IRippleProps
interfaceComponent prop surface for the ripple effect. Extended by interactive components (Btn, Chip, Card, ListItem…) to opt in to the v-ripple ink-wave animation on pointer interaction.
IStateEffectConfig
interfaceShared shape for state-aware visual overrides (hover, active). When passed as an object to the hover or active prop, its keys override the corresponding resting props only while the state is engaged.
Blockquote
BottomNav
Bracket
IBracketCompetitorEmits
interfaceIBracketCompetitorSlots
interfaceIBracketConnectorSlot
interfaceIBracketEmits
interfaceIBracketMatchCompetitorSlot
interfaceIBracketMatchEmits
interfaceIBracketMatchSlots
interfaceIBracketRoundEmits
interfaceIBracketRoundMatchSlot
interfaceIBracketRoundSlots
interfaceIBracketRoundTitleSlot
interfaceIBracketSlots
interfaceIBracketSurfaceInput
interface
Breadcrumb
Calendar
ICalendarAgendaEntry
interfaceICalendarEmits
interfaceEmit signatures fired by OrigamCalendar — covers v-model sync (view, currentDate), user interaction (event-click, date-click, range-select, create-event-request) and navigation signals (view-change, navigate).
ICalendarEventSlotBindings
interfaceSlot bindings injected into the #event slot of OrigamCalendar — one set per visible event. Provides the IEvent payload plus temporal context flags (isPast, isToday).
ICalendarHeaderSlotBindings
interfaceSlot bindings injected into the #header slot of OrigamCalendar for a full toolbar replacement. Exposes view state, navigation guards and imperative callbacks so the custom header drives the calendar without extra wiring.
ICalendarParsedRule
interfaceICalendarSlots
interfaceSlot signatures exposed by OrigamCalendar. The default toolbar can be replaced wholesale via #header, individual events via #event, day cells via #day, day column headers via #dayHeader, and empty-agenda state via #empty.
ICalendarTimeSlot
interfaceIDragMonthState
interfaceIDragSlotState
interfaceIEvent
interfacePublic event data shape consumed by OrigamCalendar and useCalendar. Supports single-day, multi-day, all-day and recurring events (RRULE subset: FREQ/INTERVAL/COUNT/UNTIL/BYDAY). start/end accept ISO-8601 strings, Date objects or epoch numbers.
Card
ICardEmits
interfaceEmit signatures fired by OrigamCard — inherited from IAdjacentEmits (prepend/append clicks), IActiveEmits (active state sync) and IHoverEmits (hover state sync).
ICardHeaderEmits
interfaceEmit signatures fired by OrigamCardHeader — clicks on the prepend and append adjacent slots, inherited from IAdjacentEmits.
ICardHeaderProps
interfaceProps for OrigamCardHeader — combines tag, commons, border, rounded, padding, margin, density and adjacent-slot surfaces, plus convenience title and subtitle text props.
ICardHeaderSlots
interfaceICardProps
interfaceFull prop surface for OrigamCard — extends the entire cross-cutting DS commons (tag, color, bgColor, border, density, dimension, elevation, loader, location, position, rounded, margin, padding, link, ripple, adjacent, active) plus card-specific props (disabled, flat, hover, image, link, subtitle, text, title, type).
ICardSlots
interfaceICardTextEmits
interfaceICardTextProps
interfaceProps for OrigamCardText — extends commons, tag, border, rounded, padding, margin and density, with an optional text convenience prop for slotless usage.
ICardTextSlots
interface
Carousel
ICarouselDelimiterItem
interfaceICarouselEmits
interfaceEmit signatures fired by OrigamCarousel — inherited from ICommonsComponentEmits (v-model on the active slide index).
ICarouselItemEmits
interfaceICarouselItemProps
interfaceProps for OrigamCarouselItem — extends IImgProps (src, alt, cover, aspect-ratio, eager) and IWindowItemProps (value, disabled, eager transition), plus a transition override.
ICarouselItemSlots
interfaceICarouselProps
interfaceProps for OrigamCarousel — extends IWindowProps (slide management), IColorProps, IBgColorProps, IDimensionProps, IHoverProps, IActiveProps, ICommonsComponentProps and ITagProps, with carousel-specific controls for auto-cycle, delimiter icons and progress bar.
ICarouselSlots
interface
Chart
IChartAnnotation
interfaceA single overlay annotation drawn on top of a cartesian chart SVG surface. Supports four kinds: arrow, label, circle and bracket. Positioned in data coordinates and projected to pixel space by the chart X/Y scales.
IChartAnnotationGeo
interfaceResolved SVG geometry for one chart annotation. Produced by computeAnnotationGeometry in chart.composable.ts and consumed directly by OrigamChartCartesian for rendering. Fields are gated per kind.
IChartAxisEmits
interfaceIChartAxisLabelSlot
interfaceIChartAxisProps
interfaceProps for OrigamChartAxis — the cartesian-only axes, grid and tick-labels block. Expects pre-computed tick arrays and plot corners from useChart and paints them. No data coupling.
IChartAxisSlots
interfaceIChartBaseEmits
interfaceEmit signatures shared across every per-type chart component (ChartBar, ChartLine, ChartPie, …). Covers data-point click, legend-entry click and legend visibility toggle.
IChartBaseProps
interfaceProps shared across every origam chart type — extends ICommonsComponentProps, IDimensionProps, IMarginProps, IPaddingProps, IRoundedProps, IElevationProps and IBgColorProps. Covers series data, legend, tooltip, animation, color scheme and aspect ratio.
IChartBaseSlots
interfaceSlot signatures shared across every per-type chart component. Covers tooltip body replacement, legend entry replacement, title block replacement and empty state.
IChartBoxPlotBox
interfaceInternal box descriptor produced by the OrigamChartBoxPlot geometry engine for each category slot. All coordinates are in SVG-space pixels. Consumed directly by the SVG renderer and exposed through the #tooltip slot.
IChartBoxPlotDatum
interfacePre-aggregated datum for OrigamChartBoxPlot — the consumer supplies all five-number-summary values (min, q1, median, q3, max) and optional outlier array directly. Use IChartBoxPlotRawDatum when raw samples should be aggregated by the component.
IChartBoxPlotProps
interfaceProps for OrigamChartBoxPlot — extends IChartBaseProps with box-plot-specific controls: category order, box width, whisker cap width, outlier visibility, axis/grid visibility, Y-axis range overrides and axis label formatters.
IChartBoxPlotRawDatum
interfaceRaw-samples datum for OrigamChartBoxPlot — the component derives the five-number summary via Tukey's method (linear interpolation) and detects outliers at the 1.5·IQR fence automatically. Use IChartBoxPlotDatum when the aggregation has already been done.
IChartBoxPlotSlots
interfaceSlot signatures exposed by <OrigamChartBoxPlot>. Extends IChartBaseSlots with an enriched tooltip slot that receives the full five-number summary and box geometry descriptor.
IChartBulletBullet
interfacePre-computed geometry descriptor for a single bullet in a bullet chart. Produced by the bullet layout engine inside OrigamChartBullet — contains resolved colours, slot coordinates, and the maximum axis value.
IChartBulletDatum
interfaceBullet data payload for a single series entry in a bullet chart. Combines the actual value, the target / goal value, and the qualitative range bands that form the background.
IChartBulletProps
interfaceProps for <OrigamChartBullet> — the bullet / KPI chart family. Each series entry renders one bullet combining range bands, an actual-value bar, and a target marker tick (Stephen Few design).
IChartBulletRange
interfaceOne qualitative range band in a bullet chart. Bands are rendered left-to-right (horizontal) or bottom-to-top (vertical) and stack to cover the domain [0, maxRange].
IChartBulletSlots
interfaceSlot signatures exposed by <OrigamChartBullet>. Extends IChartBaseSlots with an enriched tooltip slot that provides the full bullet geometry descriptor and a pre-computed delta percentage.
IChartCandlestickCandle
interfaceResolved per-candle descriptor produced by the geometry engine inside OrigamChartCandlestick. All numeric fields are expressed in SVG user-units; pre-computes change and direction so the template renders without arithmetic.
IChartCandlestickDatum
interfaceOne OHLC data point in a candlestick series. Supplies the date label plus the four price levels (open, high, low, close) for the period. A datum missing any of the four price fields is silently skipped by the chart.
IChartCandlestickProps
interfaceProps for <OrigamChartCandlestick> — the financial OHLC chart. Renders one candlestick per datum with a body between open/close and a wick from low to high. Extends IChartBaseProps (omitting categories).
IChartCandlestickSlots
interfaceSlot signatures exposed by <OrigamChartCandlestick>. Extends IChartBaseSlots with an enriched tooltip slot that receives the full OHLC datum plus pre-computed change and direction.
IChartCartesianEmits
interfaceEmits surfaced by <OrigamChartCartesian>. Extends IChartBaseEmits with drilldown navigation events (drill / drill-up) and zoom interaction events (zoom / reset-zoom).
IChartCartesianProps
interfaceProps for <OrigamChartCartesian> — the cartesian family component. Owns the X+Y plotting area and all cartesian topologies: line, area, bar, column, scatter, spline, stepped-line. Supports stacking, smoothing, drilldown, zoom, annotations, plot bands/lines, and a secondary Y axis.
IChartDrilldownDataset
interfaceA named sub-dataset associated with a drilldown level in a cartesian chart. The chart swaps its active series and categories with these values when the user clicks a point carrying a matching IChartDrilldownLink.
IChartDrilldownFrame
interfaceOne frame in the navigation stack maintained internally by the cartesian chart drilldown system. The root frame is pushed on mount; each drill-in pushes an additional frame; the Back button pops the top frame.
IChartDrilldownLink
interfaceReference attached to a data point that signals a drilldown is available. When the user clicks a point carrying this link, the chart looks up the matching IChartDrilldownDataset by id and re-renders with the sub-dataset.
IChartDrilldownProps
interfaceChart-level prop that wires up the drilldown feature on <OrigamChartCartesian> or <OrigamChartPolar>. Supplies the bank of sub-datasets and an optional Back button label for the breadcrumb navigation.
IChartEmits
interfaceEmits surfaced by <OrigamChart>. All payloads are plain serialisable data (no DOM refs) so callers can forward them to a store, websocket, or analytics layer without unwrapping.
IChartGaugeEmits
interfaceIChartGaugeGeometry
interfaceOutput of useChartGauge — geometry descriptors for the arc track, the indicator arc, and the label anchor points. All fields are pre-formatted so the SFC renders without computing anything itself.
IChartGaugeProps
interfaceProps for <OrigamChartGauge> — solid gauge (radial progress indicator). Renders a 270-degree track with a filled arc indicating the current value, an optional centre label, and optional min / max endpoint labels. Only the first datum of the first series is consumed.
IChartGaugeSlots
interfaceSlot signatures exposed by <OrigamChartGauge>. Extends IChartBaseSlots with three gauge-specific slots for the centre value label and the min / max arc endpoint labels.
IChartHeatmapCell
interfacePre-computed cell descriptor produced by the heatmap geometry engine. Contains every pre-computed value needed to render one <rect>, its label, and tooltip / accessibility content — the SFC renders without arithmetic.
IChartHeatmapDatum
interfaceSingle datum shape consumed from series[0].data in a heatmap chart. Each entry represents one cell in the grid, identified by its column key (x), row key (y), and a numeric value that drives the cell colour.
IChartHeatmapEmits
interfaceIChartHeatmapProps
interfaceProps for <OrigamChartHeatmap> — rectangular heatmap grid where each cell is coloured by its value relative to the dataset min/max. Extends IChartBaseProps.
IChartHeatmapSlots
interfaceSlot signatures exposed by <OrigamChartHeatmap>. Extends IChartBaseSlots with a custom tooltip slot for hovered cells.
IChartHoneycombPoint
interfacePayload passed to IChartPoint for a hovered / clicked honeycomb tile. Exposes x = gridX, y = gridY plus the tile name and value for downstream consumers.
IChartHoneycombProps
interfaceProps for <OrigamChartHoneycomb> — hexagonal tile-map where each tile is positioned by column (x) and row (y) index. Extends IChartBaseProps.
IChartHoneycombSlots
interfaceSlot signatures exposed by <OrigamChartHoneycomb>. Extends IChartBaseSlots with a tile-label slot that replaces the centred label inside each hexagonal tile.
IChartHoneycombTile
interfaceInternal tile descriptor produced by the honeycomb geometry engine. Contains every pre-computed value needed to render one <polygon>, its label, and tooltip / accessibility content.
IChartLegendEmits
interfaceEmits surfaced by <OrigamChartLegend>. The parent chart wires these into its own legend-click and series-toggle emits so consumers don't need to know about the extracted sub-component.
IChartLegendItem
interfaceAggregated legend entry — one per series. Pre-resolved colour so the legend renderer doesn't have to re-look-up the palette. Produced by useChart().legend.value.
IChartLegendProps
interfaceProps for <OrigamChartLegend> — the series-name + colour-swatch + visibility-toggle list that sits on one side of a chart. Pure renderer consuming pre-resolved IChartLegendItem[] from useChart().
IChartLegendSlots
interfaceSlot signatures exposed by <OrigamChartLegend>. Provides a legend-item slot so a consumer can replace one entry with a custom render (chip, icon, etc.).
IChartMapChoroplethDatum
interfaceA single choropleth data point keyed by ISO-3166-1 alpha-2 country code. The numeric value drives the colour interpolation between colorRange endpoints.
IChartMapCountry
interfaceInternal country descriptor produced by the map geometry engine. Holds the pre-resolved fill colour, ARIA metadata, and SVG path string for rendering a country shape.
IChartMapEmits
interfaceIChartMapProps
interfaceProps for <OrigamChartMap>. Supports two modes: choropleth (country shapes coloured by interpolated value) and flight-routes (curved arcs between pairs of country centroids). Extends IChartBaseProps.
IChartMapRoute
interfaceInternal route descriptor produced by the map geometry engine for flight-routes mode. Holds the pre-computed SVG Bezier path, stroke colour, endpoint circles, and country codes.
IChartMapRouteDatum
interfaceA single flight-route datum connecting two country centroids. Used in series[0].data when mode='flight-routes' on <OrigamChartMap>.
IChartMapSlots
interfaceSlot signatures exposed by <OrigamChartMap>. Extends IChartBaseSlots with tooltip and empty slots for full rendering control.
IChartParetoBar
interfacePre-computed bar descriptor produced by the Pareto geometry engine. Contains all pre-computed values needed to render one <rect> column, its label, and the cumulative percentage dot.
IChartParetoDatum
interfaceA single datum in the Pareto series — one category-value pair. The component auto-sorts descending by value before rendering. Used in series[0].data for <OrigamChartPareto>.
IChartParetoProps
interfaceProps for <OrigamChartPareto> — combines vertical columns sorted descending by value with a cumulative percentage line on a secondary right Y-axis. Typical uses: quality control, root-cause analysis, 80/20 rule. Extends IChartBaseProps.
IChartParetoSlots
interfaceSlot signatures exposed by <OrigamChartPareto>. Extends IChartBaseSlots with a rich tooltip slot that exposes the full bar descriptor including share and cumulative percentage.
IChartPath
interfaceOutput of useChart() — one path descriptor per series (or per data point for bar/column/scatter/pie). The component renders each entry inside a <g> according to kind.
IChartPictorialColumn
interfaceOne column descriptor produced by the pictorial geometry engine. Holds pre-computed positions for background and filled icon grids, enabling the <OrigamChartPictorial> template to render each isotype column.
IChartPictorialProps
interfaceProps for <OrigamChartPictorial> — the pictorial / isotype family. Each data value is represented as a column of repeated SVG icons; filled icons count = Math.round(value / iconsPerUnit). Extends IChartBaseProps with icon appearance, direction, and rendering mode.
IChartPictorialSlots
interfaceSlot signatures exposed by <OrigamChartPictorial>. Extends IChartBaseSlots with a tooltip slot that receives the hovered point, its series and the resolved category label, plus an empty slot rendered when the series array is empty.
IChartPlotBand
interfaceA coloured rectangular zone drawn behind (or above) chart data, spanning a numeric range along either the X or Y axis. Applicable to cartesian-family charts only — not for polar, radar or gauge.
IChartPlotLine
interfaceA single threshold line drawn at a fixed axis value, either horizontally (Y-axis) or vertically (X-axis). Applicable to cartesian-family charts only — not for polar, radar or gauge.
IChartPoint
interfaceHover / click payload bubbled by <OrigamChart> whenever a data point is interacted with. Fields are denormalised — the consumer does not need to re-look-up the series or resolve the colour from the palette.
IChartPolarBarProps
interfaceProps for <OrigamChartPolarBar> — the polar bar (nightingale-rose) family. A single series of N data points is rendered as N wedge-shaped arcs arranged radially. Commonly used for cyclical data (hours per day, monthly activity). Extends IChartBaseProps.
IChartPolarBarSlots
interfaceSlot signatures exposed by <OrigamChartPolarBar>. Extends IChartBaseSlots with an enriched tooltip slot that also receives the pre-computed percentage string for the hovered wedge.
IChartPolarBarWedge
interfaceSingle wedge descriptor produced by the polar-bar geometry engine. Exposes the pre-computed SVG <path d="…"> for the arc, label anchor position, and all data needed to render accessibility text and tooltip content.
IChartPolarEmits
interfaceEmits surfaced by <OrigamChartPolar>. Extends IChartBaseEmits with drilldown events — fired when the user navigates into a sub-dataset or navigates back one level.
IChartPolarProps
interfaceProps for <OrigamChartPolar> — handles pie and donut visualisations. No axes, no grid, no tick labels. Extends IChartBaseProps with polar-specific options including donut hole size, drilldown configuration, and axis formatters.
IChartProps
interfaceProps accepted by <OrigamChart> — the universal chart component supporting eight visualisation primitives (line, area, bar, column, scatter, pie, donut, radar, gauge). The type prop selects the path generator inside useChart. Extends ICommonsComponentProps, IDimensionProps, IMarginProps, IPaddingProps, IRoundedProps, IElevationProps, IBgColorProps.
IChartPyramidProps
interfaceProps for <OrigamChartPyramid> — the pyramid / funnel family. A single series of N data points is rendered as N horizontal trapezoids stacked vertically. type="funnel" = widest at top (conversion funnel); type="pyramid" = widest at bottom. Extends IChartBaseProps.
IChartPyramidSlice
interfaceSingle slice descriptor produced by the pyramid geometry engine. Exposes the pre-computed SVG <path d="…"> for the trapezoid, the label anchor position, and all data needed to render accessibility text and tooltip content.
IChartPyramidSlots
interfaceSlot signatures exposed by <OrigamChartPyramid>. Extends IChartBaseSlots with a slice-label slot that replaces the label rendered on or beside each slice, receiving the category name, raw value, formatted value, resolved colour, index and visibility.
IChartRadarProps
interfaceProps for <OrigamChartRadar> — the radar / spider chart. Tightly-typed wrapper around <OrigamChart type="radar"> with only the options relevant to radar charts. No type prop is exposed — the family is fixed to the radar geometry. Extends IChartBaseProps.
IChartRangeSelector
interfaceConfiguration for the optional band-style range-selector toolbar rendered above <OrigamChartCartesian>. When enabled, displays a set of buttons that let the user select a visible time window over the full dataset.
IChartRangeSelectorButton
interfaceA single button in the range-selector toolbar. Exactly one of count or fraction must be provided: count = number of categories from the right edge to show; fraction = fraction of the full category range to show (0..1).
IChartRangeSelectorEmits
interfaceIChartRangeSelectorProps
interfaceIChartRangeSelectorSlots
interfaceIChartRoving
interfaceIChartSankeyDatum
interfaceA single flow datum in the Sankey series. from and to are node name strings — nodes are inferred automatically from the full set of unique names. value must be >= 0. An optional color override accepts a TIntent token or raw CSS colour.
IChartSankeyLink
interfaceInternal link descriptor for each IChartSankeyDatum after Sankey layout. Carries the rendered SVG cubic Bezier path d attribute, visual metadata and resolved colour. Produced by the Sankey layout engine — not intended for direct consumer use.
IChartSankeyNode
interfaceInternal node descriptor produced by the Sankey layout engine. All coordinates are in SVG-user-unit space. Nodes are inferred from the union of all from and to strings in IChartSankeyDatum; column is assigned by topological depth (Kahn's algorithm).
IChartSankeyProps
interfaceProps for <OrigamChartSankey>. The component consumes series[0] only — each item in series[0].data must conform to IChartSankeyDatum ({ from, to, value }). Nodes are inferred automatically; columns are assigned by topological depth. Extends IChartBaseProps.
IChartSankeySlots
interfaceSlot signatures exposed by <OrigamChartSankey>. Extends IChartBaseSlots with a node-label slot that replaces the label rendered beside each node, receiving the node name, value, formatted value, resolved colour and column index.
IChartTooltipEmits
interfaceIChartTreemapRect
interfaceIChartTreemapTile
interfaceInternal tile descriptor produced by the treemap layout engine. All coordinates are in SVG-user-unit space (the fixed 600 × 400 viewport). Consumed by the template to render a single <rect> + optional inline label.
IChartVariwideColumn
interfacePre-computed column descriptor produced by the variwide geometry engine. Consumed by the template to render a single <rect> with variable width encoding a secondary metric.
IChartVariwideDatum
interfaceA single datum in the variwide series. Encodes two dimensions simultaneously: value → bar height (primary metric, maps to Y axis) and width → bar width (secondary metric, proportional share of plot width).
IChartVariwideProps
interfaceProps for <OrigamChartVariwide>. A variwide chart encodes two metrics per category: height for the primary value (Y axis) and width for the secondary value (proportional share of the plot width). Typical uses: GDP × population, revenue × market share, response time × request count.
IChartVariwideSlots
interfaceSlot signatures exposed by <OrigamChartVariwide>. Extends IChartBaseSlots with a richer tooltip slot that receives both the primary value and the secondary (width) encoding so consumers can format them freely.
IChartWordCloudDatum
interfaceA single processed word datum used by the word-cloud layout engine. Computed from IChartSeries.data entries after sorting and font-size mapping.
IChartWordCloudProps
interfaceProps for <OrigamChartWordCloud>. Reads series[0]; each datum must be a { text, value, color? } object. Controls font sizes, rotation strategy, font family/weight, and optional value formatters.
IChartWordCloudWord
interfaceInternal word descriptor after geometry placement. Extends IChartWordCloudDatum with layout coordinates (SVG center position, rotation, bounding box) used for rendering and collision detection.
CodeGroup
Color
IColorHsvEmits
interfaceShared emit shape for ColorPicker sub-components (Canvas, Edit, Preview, Swatches) that push HSVA colour changes up through the same channel.
IColorModeEmits
interfaceShared emit shape for ColorPicker sub-components that flip between colour input modes (RGB / HSL / HSV / HEX).
IColorPickerCanvasEmits
interfaceEmits fired by OrigamColorPickerCanvas — drag and click interactions push HSVA colour updates up through the shared IColorHsvEmits channel.
IColorPickerCanvasProps
interfaceProps for OrigamColorPickerCanvas — the 2-D saturation/brightness gradient surface that the user drags to pick a colour.
IColorPickerEditEmits
interfaceEmits fired by OrigamColorPickerEdit — text-field edits push HSVA updates and mode switches up through the shared channels.
IColorPickerEditProps
interfaceProps for OrigamColorPickerEdit — the text-input row that lets users type colour values in a chosen mode (RGB, HSL, HSV, HEX) and switch between modes.
IColorPickerEmits
interfaceEmits fired by OrigamColorPicker — v-model on the resolved colour plus the active input mode.
IColorPickerMode
interfaceDescriptor for a single colour input mode (RGB, HSL, HSV, HEX) — holds the input field config, bi-directional HSVA conversion functions and the list of editable channel inputs.
IColorPickerPreviewEmits
interfaceEmits fired by OrigamColorPickerPreview — the alpha slider pushes HSVA updates through the shared IColorHsvEmits channel.
IColorPickerPreviewProps
interfaceProps for OrigamColorPickerPreview — the hue/alpha slider strip that shows a preview swatch and lets the user adjust transparency.
IColorPickerProps
interfaceProps for OrigamColorPicker — a full-featured HSVA colour picker that composes Canvas, Preview, Edit and Swatches sub-components with optional sections controlled via hide* / show* flags.
IColorPickerSwatchesEmits
interfaceEmits fired by OrigamColorPickerSwatches — clicking a swatch tile pushes the colour up through the shared HSVA channel.
IColorPickerSwatchesProps
interfaceProps for OrigamColorPickerSwatches — the grid of colour swatch tiles displayed below the picker controls.
Color & Intent
IBgColorProps
interfaceBackground-only color contract — extended by components that own a surface (Btn, Card, Badge, Alert…). Kept orthogonal to IColorProps so a component can opt into one axis independently.
IColorProps
interfaceForeground-only color contract — extended by components whose only colour concern is the text/icon (color).
IGradient
interfaceStructured gradient descriptor — one of the three accepted formats for color/bgColor/textColor props. Supports linear, radial and conic types; short form (from/to/via) or full form (stops array).
IGradientStop
interfaceSingle stop in a multi-stop gradient — pairs a color (TIntent alias or raw CSS color) with a percentage position in the [0..100] range.
ColorPicker
ColorPickerField
CommandPalette
Commons
IAccentColorProps
interfaceIActionVariantProps
interfaceIAttachProps
interfaceIBackdropProps
interfaceIContrastScheduled
interfaceIControlLoaderProps
interfaceIInputVariantProps
interfaceIInstalledTheme
interfaceILazySlots
interfaceILoaderSlots
interfaceIMessageProps
interfaceINuxtAwareApp
interfaceIOpacityProps
interfaceIOrigamNuxtProvide
interfaceIResolvedLoader
interfaceISemanticTree
interfaceISsrStyleCollector
interfaceISsrStyleEntry
interfaceIStateFlagOptions
interfaceIStateFlagReturn
interfaceIThemeVars
interfaceITouchStoredEntry
interfaceITransitionHostProps
interfaceITypographyProps
interfaceIVueI18nGlobalLike
interfaceIVueI18nLike
interface
Component Context
ITimelineContext
interfaceContext object provided by OrigamTimeline to its nested OrigamTimelineItem children via inject. Carries the parent layout direction and shared visual props without requiring explicit prop forwarding.
ITreeviewProvide
interfaceContext object provided by OrigamTreeview to all descendant OrigamTreeviewNode components via Vue inject. Exposes reactive state accessors and mutation handlers without prop-drilling.
Component Emits
IDataTableEmits
interfaceEmits contract for <OrigamDataTable> — pagination, sorting, grouping, expansion, selection and the v-model:options aggregate event.
IMediaScrubberEmits
interfaceEmits for <OrigamMediaScrubber> — live value updates during drag/keyboard/click, a commit event on pointer release, drag lifecycle events, and a hover position channel.
IMenuEmits
interfaceEmits fired by <OrigamMenu> — extends ICommonsComponentEmits (v-model on open state) and adds a contextmenu event forwarded so parents can intercept the native right-click and show their own context menu instead.
INumberFieldEmits
interfaceEmits fired by <OrigamNumberField> — extends IFieldEmits + IInputEmits and adds control interaction events (click, mousedown, clear) and dedicated increment/decrement value notifications.
ISlideGroupEmits
interfaceEmits contract for <OrigamSlideGroup> — extends ICommonsComponentEmits (update:modelValue for the active slide index).
ISliderFieldEmits
interfaceEmits contract for <OrigamSliderField> — v-model value updates, focus/blur lifecycle, and drag start/end events.
ISubmitEventPromise
interfaceSpecial emit payload for <OrigamForm> submit events — a hybrid of SubmitEvent and Promise<IFormValidationResult> that lets handlers await the form validation result inline.
ITooltipEmits
interfaceEmits fired by <OrigamTooltip>. Extends ICommonsComponentEmits — inherits the standard component event surface including v-model open-state binding.
IVideoEmits
interfaceEmits surfaced by OrigamVideo. The event names mirror the native DOM events one-to-one so consumers can move between the wrapper and a vanilla <video> without re-wiring listeners. Extends IMediaPlayerEmits with video-specific events (fullscreen, pip, skip, quality-change, download).
IVirtualScrollItemEmits
interfaceEmits fired by OrigamVirtualScrollItem. The resize-observed height is forwarded to the parent virtual scroller so it can update its intrinsic-size cache.
Component Props
IAlertProps
interfaceFull props contract for <OrigamAlert> — closable banner with optional icon, title, text, v-model visibility and the full design surface (color, border, spacing, elevation, position).
IAppBarProps
interfaceProps for <OrigamAppBar> — a docked layout item that extends IToolbarProps (minus width/minWidth/maxWidth/floating) and ILayoutItemProps (minus absolute), plus scroll-driven behaviour and block-axis placement.
IAppProps
interfaceProps for <OrigamApp> — thin application-shell wrapper over OrigamLayout, exposing only color, bgColor, fullHeight and overlaps. Intentionally omits the full design surface (border, rounded, elevation, spacing) that belongs on OrigamLayout directly.
IAudioPlayerMethods
interfaceImperative methods returned by useAudioPlayer (Audio namespace). Extends the media-agnostic IMediaPlayerMethods baseline. Kept as a distinct symbol so audio-specific commands can be added without churn on consumer types.
IAudioPlayerState
interfaceReactive state surface returned by useAudioPlayer (Audio namespace). Extends the media-agnostic IMediaPlayerState baseline. Future audio-specific extensions (waveform analysis, frequency bins) have a home here without breaking existing imports.
IAudioProps
interfaceFull props contract for <OrigamAudio> — composes useAudioPlayer with OrigamMediaController to paint an opinionated audio card (cover + title/artist + transport bar). Exposes variant, cover, playlist, loop mode, shuffle, waveform, playback rates and the full design surface.
IAudioSource
interfaceA single <source> entry when the consumer passes multiple audio URLs (typically one mp3 + one ogg so the browser picks whichever codec it can decode). Mirrors IVideoSource minus video-specific fields.
IAudioTrack
interfaceDescriptor for a single track in an <OrigamAudio> playlist. The src field is mandatory; title, artist, album and cover are optional metadata surfaced on the player chrome when the track becomes active.
IAvatarGroupProps
interfaceFull props contract for <OrigamAvatarGroup> — stacked / inline row of avatars with overflow management, expand-on-hover/click, and the full design surface (color, border, elevation, spacing, density, size, rounded).
IAvatarProps
interfaceFull props contract for <OrigamAvatar> — renders an image, icon or text inside a circular (or rounded) container. Exposes the full design surface (color, border, elevation, spacing, density, size, rounded) plus interactive hover and active state props.
IBadgeProps
interfaceFull props contract for <OrigamBadge> — a floating status indicator anchored to a child element. Supports numeric content, dot mode, floating/inline placement, offset, v-model visibility, and the full color/border/rounded/elevation/transition design surface.
IBlockquoteProps
interfaceFull props contract for <OrigamBlockquote> — typographic citation component built on <blockquote>. Exposes five visual variants, author/source attribution, locale-aware decorative quote marks, horizontal alignment, and the full design surface (color, border, spacing, elevation, rounded).
IBottomNavProps
interfaceProps contract for <OrigamBottomNav> — a fixed navigation bar with item buttons, supporting grow mode, placement position, transition, and the full cross-cutting surface (color, bgColor, border, elevation, margin, dimension, density, rounded, layout, group, hover, active).
IBracketCompetitorProps
interfaceProps for <OrigamBracketCompetitor> — a single competitor row. Carries the full cross-cutting surface (color, bgColor, rounded, elevation, border, density, dimension, padding, margin) so a standalone row behaves like any other origam component.
IBracketMatchProps
interfaceProps for <OrigamBracketMatch> — a single match card rendered inside <OrigamBracket>. Carries the full cross-cutting surface and can be rendered standalone on a match-details page.
IBracketProps
interfaceProps for <OrigamBracket> — a tournament tree renderer supporting single-elimination, double-elimination and round-robin layouts. Purely presentational: accepts immutable rounds and emits interaction events.
IBracketRoundProps
interfaceProps for <OrigamBracketRound> — a single round column/row. Exported so consumers can render a round standalone inside a custom layout.
IBreadcrumbDividerProps
interfaceProps for <OrigamBreadcrumbDivider> — the separator rendered between breadcrumb items. Accepts a string character or an icon name, with full color, size, density, padding and margin surface.
IBreadcrumbItemProps
interfaceProps for <OrigamBreadcrumbItem> — a single item in the breadcrumb trail. Supports link navigation, adjacent icons (prepend/append), hover, active and disabled states, and the full cross-cutting surface.
IBreadcrumbProps
interfaceProps for <OrigamBreadcrumb> — the navigation trail container. Supports declarative items array, custom divider, disabled state, and the full cross-cutting surface (color, bgColor, border, elevation, density, rounded, padding, margin).
IBtnGroupProps
interfaceProps for <OrigamBtnGroup> — a container that groups related buttons with a shared visual surface (border, elevation, density, color, bgColor, rounded, margin, padding). Supports a divided mode that draws separators between children.
IBtnProps
interfaceProps for <OrigamBtn> — the primary action component. Supports all visual surfaces (color, bgColor, border, elevation, rounded, size, density, dimension, padding, margin), link navigation, ripple, loader, position, location, group membership, adjacent icons, status, hover, and variant.
IBtnToggleProps
interfaceProps for <OrigamBtnToggle> — a grouped toggle control built on BtnGroup. Adds group selection management (IGroupProps) on top of the full BtnGroup visual surface.
ICalendarComponentProps
interfaceProps for <OrigamCalendar> — a full-featured calendar with month/week/day/agenda views, event management, drag-select, recurring event expansion, locale support, and the full origam cross-cutting surface.
IContainerProps
interfaceProps for <OrigamContainer> — a structural page-level wrapper. Deliberately excludes color and rounded props (those belong on Sheet/Card/Alert). Exposes fluid and fullscreen toggles plus the standard dimension, padding, margin and border surfaces.
IContextualMenuProps
interfaceProps for <OrigamContextualMenu> — a right-click / long-press floating menu. Inherits the full IMenuProps surface (activator, positioning, transitions, dimensions) and the commons component contract.
ICounterProps
interfaceFull props contract for <OrigamCounter> — a numeric badge that clamps to a max value, with the full design surface (color, border, spacing, elevation, density, rounded, transition).
IDataListProps
interfaceFull props contract for <OrigamDataList> — a versatile list component that supports two layout modes: "avatar" (classic dl stack) and "kv" (PDF-aligned key/value table), with the full design surface.
IDataTableColumnProps
interfaceProps for a single column cell in <OrigamDataTable> — alignment, sticky offset, nowrap, plus dimension and padding from the shared Commons interfaces.
IDataTableExpandProps
interfaceProps controlling row expansion in <OrigamDataTable> — whether rows expand on click, whether the expand column is shown, and the list of currently expanded row keys.
IDataTableFooterProps
interfaceFull props contract for <OrigamDataTableFooter> — pagination icons, per-page options, accessible page labels, and the full color/padding/alignment design surface.
IDataTableGroupHeaderRowProps
interfaceProps for the group header row component in <OrigamDataTable> — carries the group item, its resolved internal item, column definitions, and handlers for expand/select/group-toggle interactions.
IDataTableGroupProps
interfaceProps controlling row grouping in <OrigamDataTable> — accepts an array of sort-item descriptors that define which columns to group by.
IDataTableHeaderCellProps
interfaceProps for the header cell wrapper component in <OrigamDataTable> — the full headers matrix plus the shared IHeaderCellProps and IColorProps surfaces.
IDataTableHeaderProps
interfaceTop-level header configuration props accepted by <OrigamDataTable> — the array of column header definitions and the initial items array used to infer column keys.
IDataTableHeadersCellProps
interfaceProps for the headers cell component (single <th>) in <OrigamDataTable> — the full two-dimensional headers matrix plus the shared ICommonsComponentProps, IColorProps, and IHeaderCellProps surfaces.
IDataTableItemSlot
interfaceSlot scope injected into every row-level slot of <OrigamDataTable> — exposes the raw item, its index, resolved columns, and the expand/select helpers.
IDataTableItemsProps
interfaceConfigures the items data source of <OrigamDataTable> — the items array, the key extractor, the selectability resolver and per-row/cell prop factories.
IDataTablePaginationProps
interfaceControls the page and items-per-page props for paginated data tables — the minimal binding surface for server-side or client-side pagination.
IDataTableProps
interfaceComplete props contract for <OrigamDataTable> — composes all DataTable sub-interfaces (items, sort, select, paginate, expand, group, headers, footer, filters) plus table-wide visibility flags and a global search string.
IDataTableProvideExpanded
interfaceInternal provide/inject contract for row expansion state in <OrigamDataTable> — exposes the expanded set and helpers for child components (expand row, virtual row, footer) to query and toggle expansion.
IDataTableProvideGroup
interfaceInternal provide/inject contract for row-grouping state in <OrigamDataTable> — exposes the groupBy axis, the open/closed set of group nodes and helpers to toggle, extract and query groups.
IDataTableProvidePagination
interfaceInternal provide/inject contract for pagination state in <OrigamDataTable> — exposes the page cursors, the total page count and navigation helpers consumed by footer and slot children.
IDataTableProvideSelection
interfaceInternal provide/inject contract for row-selection state in <OrigamDataTable> — exposes selection helpers and computed flags consumed by checkboxes, header select-all and slot children.
IDataTableProvideSort
interfaceInternal provide/inject contract for column-sort state in <OrigamDataTable> — exposes the current sortBy array and helpers used by column headers to query and toggle sort order.
IDataTableRowEmits
interfaceEmits contract for <OrigamDataTableRow> — fires row-level expand and select events carrying the affected item and the new boolean state.
IDataTableRowProps
interfaceProps contract for <OrigamDataTableRow> — receives the resolved internal item and optional per-cell prop factory; extends ICommonsComponentProps and IDisplayProps.
IDataTableRowsProps
interfaceProps contract for the internal <OrigamDataTableRows> body renderer — receives the full list of items/groups, empty-state text and per-row/cell prop factories.
IDataTableSelectProps
interfaceProps that enable and configure row selection in <OrigamDataTable> — controls the checkbox column visibility, the selection strategy, the v-model array and the equality comparator.
IDataTableSelectStrategy
interfaceStrategy object that controls how rows are selected in a DataTable — defines whether a select-all checkbox is shown and implements the select / selectAll / allSelected algorithms.
IDataTableSelectableItem
interfaceMinimal shape that every selectable row must satisfy — carries the resolved selection key and an optional flag to opt the row out of selection.
IDataTableSlotProps
interfaceFull slot scope injected into top-level slots (#default, #body, #footer…) of <OrigamDataTable> — aggregates pagination, sort, selection, expansion, grouping state and all toggle helpers.
IDataTableSortItem
interfaceA single sort descriptor in the sortBy array — pairs a column key with an optional sort direction. Used by both the sort props and the provide/inject sort contract.
IDataTitleProps
interfaceProps contract for <OrigamDataTitle> — a labeled data-list heading with full color, density and spacing support. Extends the adjacent-content, density, margin, padding, color and bg-color surfaces.
IMasonryProps
interfaceProps for <OrigamMasonry> — Pinterest-style masonry layout with CSS-first grid-template-rows:masonry implementation gated on browser support and a JS ResizeObserver fallback.
IMediaControllerProps
interfaceProps for <OrigamMediaController> — the universal media-controls shell consumed by <OrigamVideo> and <OrigamAudio>. Purely presentational: it receives state and methods from the parent and emits intents back. Audio-specific controls (loop, shuffle, prev/next) are opt-in so video consumers see zero regression.
IMediaPlayerMethods
interfaceImperative methods returned by useMediaPlayer. Media-agnostic subset — every method maps 1:1 to the standard HTMLMediaElement API. Video-specific commands (toggleFullscreen, togglePip) live in IVideoPlayerMethods.
IMediaPlayerState
interfaceReactive state surface returned by useMediaPlayer — the media-agnostic base shared between useVideoPlayer and useAudioPlayer. All fields are Vue Refs so they are directly bindable in templates.
IMediaScrubberProps
interfaceProps for <OrigamMediaScrubber> — a headless, media-agnostic value-on-a-track widget. Stateless: the parent controls modelValue and listens to update:modelValue, change, drag*, and hover events. Used for the timeline and the volume slider.
IMediaVolumeControlProps
interfaceProps for <OrigamMediaVolumeControl> — the mute/unmute button and the YouTube-style vertical scrubber tooltip. Owns the off/low/medium/high icon swap and the resolvedVolume collapse when muted. Does not own the media-side mutations.
IMenuProps
interfaceProps for <OrigamMenu> — a floating overlay combining the full surface of IOverlayProps, IListProps, and IListItemProps, plus an optional id to link the activator via aria-controls.
IMessagesProps
interfaceProps for <OrigamMessages> — a validation messages renderer used internally by form fields to display one or more inline error, warning or hint messages with animated transitions.
INumberFieldProps
interfaceProps for <OrigamNumberField> — a numeric input with increment/decrement controls, precision formatting, min/max clamping, and hold-repeat support. Extends the full field and input surface plus variant styling.
ISheetProps
interfaceFull props contract for <OrigamSheet> — a bottom/side sheet with optional swipe-to-expand gesture, discrete snap-points, and the full design surface (color, border, spacing, elevation, position).
ISkeletonProps
interfaceProps contract for <OrigamSkeleton> — a loading-state placeholder with configurable shape (variant, width, height, rounded), color, and animation (pulse).
ISlideGroupProps
interfaceProps contract for <OrigamSlideGroup> — a horizontally/vertically scrollable group with optional prev/next arrow navigation, active-slide centering, and the full design surface (border, padding, margin, rounded).
ISliderFieldProps
interfaceFull props contract for <OrigamSliderField> — a range input with three visual variants (field, timer, audio), optional waveform peaks, range mode, tick marks, hover tooltip, and the full design surface.
ISliderFieldTrackProps
interfaceProps contract for the track sub-component of <OrigamSliderField> — rail fill range, tick configuration, orientation hints, and the visual surface (color, size, rounded).
ISnackbarGroupProps
interfaceProps contract for <OrigamSnackbarGroup> — a multi-toast container that orchestrates a queue of OrigamSnackbar instances driven through the useSnackbarGroup({ id }) composable.
ISnackbarItemProps
interfaceProps contract for <OrigamSnackbarItem> — the pure visual layer of a single toast notification. Owns intent theming, icon/title/message layout, action buttons, dismiss button, and ARIA semantics.
ISnackbarProps
interfaceFull props contract for <OrigamSnackbar> — a positioned notification surface with auto-dismiss timer, optional progress bar, multi-line and vertical layout modes, and the full design surface (color, border, elevation, spacing).
ISpacerProps
interfaceProps contract for <OrigamSpacer> — a flex/grid spacer that grows to fill available space. Extends ICommonsComponentProps and ITagProps only; no additional own props.
IStepperItemProps
interfaceProps contract for <OrigamStepperItem> — an individual step inside OrigamStepper. Receives its index from the parent and exposes individual overrides for title, subtitle, icon, status, and clickability.
IStepperProps
interfaceFull props contract for <OrigamStepper> — a multi-step flow with horizontal or vertical orientation, clickable navigation, connector lines, and the full design surface (color, size, elevation, spacing).
ITimelineItemProps
interfaceProps contract for <OrigamTimelineItem>. Carries the per-item visual and layout configuration including title, subtitle, icon, intent, and layout context inherited from the parent OrigamTimeline.
ITimelineProps
interfaceFull props contract for <OrigamTimeline>. Supports vertical and horizontal orientations, data-driven rendering via items, side alignment, and the full color/size/density surface.
ITitleProps
interfaceProps contract for <OrigamTitle>. Semantic heading component with configurable HTML tag, text shorthand, and the full color/bgColor/density/spacing/border surface.
IToolbarProps
interfaceFull props contract for <OrigamToolbar>. Horizontal action bar with collapse, flat, floating, and sticky modes, plus the full color/border/elevation/spacing surface.
ITooltipProps
interfaceFull props contract for <OrigamTooltip>. Floating text label anchored to an activator element, with configurable positioning, transition, scroll strategy, lazy rendering, and the full color/dimension surface.
ITreeviewNodeProps
interfaceProps contract for <OrigamTreeviewNode>. Internal component rendering a single tree node. Receives the full ITreeviewNode data object plus its nesting depth for indentation.
ITreeviewProps
interfaceFull props contract for <OrigamTreeview>. Hierarchical tree with multi/single selection, expansion control, line guides, lazy-expand support, and the full color/bgColor/size/density surface.
IUseMediaPlayerOptions
interfaceOptions accepted by useMediaPlayer. The composable is media-agnostic — mediaRef accepts any HTMLMediaElement (audio OR video).
IVideoProps
interfaceProps for OrigamVideo. Extends the standard DS visual interfaces (color, dimension, rounded, border, margin, padding, elevation) with media-specific controls: src, poster, tracks, autoplay, loop, aspect-ratio, fullscreen, PIP, skip, quality switching, and download.
IVirtualScrollItemProps
interfaceProps for OrigamVirtualScrollItem. Extends ICommonsComponentProps with a single renderless flag to strip the wrapper element when the consumer manages its own DOM node.
IVirtualScrollProps
interfaceProps for OrigamVirtualScroll. Extends ICommonsComponentProps, IDimensionProps, and IVirtualProps with an items array and a renderless flag for custom DOM rendering.
IWatermarkProps
interfaceProps for OrigamWatermark — a repeating diagonal overlay used to mark a sub-tree as CONFIDENTIAL / DRAFT / personalised by recipient. The component renders an absolutely-positioned layer over its #default slot using a SVG data-URL as background-image.
Component Slots
IConfirmWrapperSlots
interfaceSlot contract for <OrigamConfirmWrapper> — exposes the primary input slot, the confirmation input slot, a header slot, title/messages/message/details helpers and the full adjacent-slots surface.
IDataTableGroupHeaderSlot
interfaceSlot props injected into the #group-header slot of <OrigamDataTable> — extends IDataTableItemBase with the group item, column list, and group-open/select/expand handlers.
IDataTableHeaderCellColumnSlot
interfaceSlot props injected into per-column header cell slots of <OrigamDataTable> — provides the column definition plus sort helpers (isSorted, toggleSort, getSortIcon) and selection helpers (selectAll, someSelected, allSelected).
IDataTableItemBaseSlot
interfaceSlot props for row-level slots in <OrigamDataTable> — extends IDataTableItemBase with the flat columns array, used by #item and #expanded-item slots.
IDataTableItemKey
interfaceSlot props for per-cell slots in <OrigamDataTable> (e.g. #item.{key}) — extends IDataTableItemBase with the resolved cell value and the column definition.
IMediaScrubberSlots
interfaceScoped slots exposed by <OrigamMediaScrubber>. Currently only a tooltip slot that overrides the default hover-tooltip body.
IMessagesSlots
interfaceScoped slots exposed by <OrigamMessages>. The default slot receives each individual message string so consumers can customise its rendering (e.g. add an icon, apply markup, link to a help article).
ITextareaFieldSlots
interfaceSlot signatures for <OrigamTextareaField>. Extends field and input slots with a counter slot, a field override slot, and rich-mode toolbar replacement slots.
ITextareaToolbarSlotProps
interfacePublic payload exposed by the #toolbar slot of OrigamTextareaField. Consumers can render a fully custom toolbar while still reusing the core formatting machinery.
IVideoScopedSlotBindings
interfaceBindings passed to the #controls scoped slot of OrigamVideo. The default toolbar is built on top of the exact same surface, so a consumer who replaces the slot has access to the full state machine without re-implementing event listeners.
IVideoSlots
interfaceSlot signatures for OrigamVideo. Four slots let consumers replace the entire controls toolbar, the poster overlay, the loading overlay, and the error overlay.
Components
IExpansionPanelProps
interfaceFull prop surface for a single expansion-panel item — combines density, color, border, padding, margin, elevation, rounded, group membership, header/content sub-interfaces, lazy loading, loader state, active and hover.
IExpansionPanelsProps
interfaceProps for the expansion-panels container — controls layout (flat, accordion, popout, inset), icon overrides, and inherits color, density, border, rounded, elevation, lazy and active surfaces.
Composable Options
ISheetSwipeOptions
interfaceOptions bag passed to useSheetSwipe() — the bottom-sheet drag gesture composable. Wires reactive refs for the sheet element, the drag handle, snap-points, and behavioural flags.
IUseCalendarOptions
interfaceOptions consumed by the useCalendar composable. All fields are thunks (getter functions) so the composable stays reactive without owning the prop reference directly.
IUseChartGaugeOptions
interfaceStrict options consumed by useChartGauge. All getters are thunks so the composable can be reactively driven by props, a store, or computed sources without re-instantiation.
IUseChartOptions
interfaceStrict, defaulted options consumed by useChart. All fields are getter thunks so the composable remains reactive without owning the prop reference. Drives path computation for all eight chart primitives.
IUseClipboardOptions
interfaceOptions accepted by useClipboard. Controls the duration the `copied` flag stays true after a successful write.
IUseInlineEditOptions
interfaceOptions accepted by useInlineEdit. Controls validation rules, trim behaviour, and lifecycle callbacks for the edit-in-place state machine.
IUseNumberFormatOptions
interfaceOptions accepted by useNumberFormat. Mirrors the public props of OrigamNumberFormat minus the wiring concerns (tag, class, style), forwarded directly to Intl.NumberFormat.
IUseOrigamAudioPlayerOptions
interfaceOptions accepted by the Audio-namespace useAudioPlayer composable. Named distinctly from the legacy IUseAudioPlayerOptions in the Sound namespace so both can coexist in the public barrel.
IUseQrCodeOptions
interfaceLower-level options accepted by useQrCode. Unlike IQrCodeProps, the composable does not speak the canonical DS contracts — it only owns the raw SVG string. The wrapper component is responsible for mapping color/bgColor/rounded down to the primitive foreground/background/cornerRadius keys here.
IUseTextareaRichOptions
interfaceReturned shape of the useTextareaRich composable. Components consume the public surface (refs + handlers) to render the contenteditable editor and bind the toolbar.
IUseVideoPlayerOptions
interfaceOptions accepted by useVideoPlayer. Extends the media-agnostic IUseMediaPlayerOptions shape (minus mediaRef) and adds a videoRef so the composable can be wired from outside an OrigamVideo host.
IUseWatermarkOptions
interfaceOptions accepted by useWatermark. Mirrors the public props of OrigamWatermark minus the wrapper concerns (tag, class, style).
Composable Returns
IUseCodeReturn
interfacePublic surface of the useCode composable. Lazily instantiates a shiki highlighter on first call and reuses it across every OrigamCode instance for the lifetime of the page.
IVideoPlayerMethods
interfaceImperative methods returned by useVideoPlayer. Extends the media-shared baseline IMediaPlayerMethods with video-specific commands: toggleFullscreen, togglePip, and related enter/exit variants.
IVideoPlayerState
interfaceReactive state surface returned by useVideoPlayer. Extends the media-shared IMediaPlayerState baseline with video-specific reactive refs: fullscreen and pip.
ContextualMenu
Data & Items
IBlueprint
interfaceGlobal configuration preset — extends IOrigamOptions (minus the blueprint key itself) to allow passing a pre-built config object to createOrigam().
ICalendarProps
interfaceProps for calendar grid components — controls the visible month/year, selected dates, allowed-dates predicate, min/max bounds, weekday layout and adjacent-month visibility.
Data & Models
IBoxPlotStats
interfaceFive-number summary and outlier list produced by the computeQuartiles utility — exported so consumers can type the return value without importing the utility directly.
IBracketCompetitor
interfaceA single competitor or team in a bracket match — intentionally generic (no sport/e-sport-specific distinction). Consumers can stash any extra payload under metadata.
IBracketMatch
interfaceA single match between two competitors. competitorA/B are nullable so the bracket can render "TBD" placeholders. scoreA/B accept string for non-numeric markers. nextMatchId lets OrigamBracket draw connectors automatically.
IBracketMatchAdvantage
interfaceHead-start carried into a match by one competitor — the classic double-elimination Grand Final advantage, where the Winner Bracket champion starts already up by one round/set.
IBracketRound
interfaceA round (column in horizontal mode, row in vertical mode) of the tournament tree. Title is required — OrigamBracket renders it above/beside the matches list. The side property is only meaningful for double-elimination.
Data & State
IGroupItem
interfaceInternal registration record for a single item inside a group — carries the numeric id assigned by the group provider, a reactive value ref and a reactive disabled ref.
INestedProps
interfaceSelection and open-state contract for tree-like and nested list components — governs item selection strategy, expand/collapse strategy, current selection and opened nodes.
IOptions
interfaceGeneric label/value pair shape used across Select, RadioGroup, ChipGroup, BtnToggle and any component that needs a typed option list. The value is `T | undefined` so consumers can model an explicit "no value" row.
Data Display
IChipEmits
interfaceEmits for <OrigamChip>. Composes ICommonsComponentEmits, IClickEmits (generic click), IClickCloseEmits (close button), IAdjacentEmits (prepend/append icon clicks) and IGroupEmits (group membership changes).
IChipGroupEmits
interfaceEmits for <OrigamChipGroup>. Extends ICommonsComponentEmits — the group selection changes are propagated via the IGroupProps v-model (update:modelValue) inherited from the shared group composable.
IChipGroupProps
interfaceProps for <OrigamChipGroup>. A container that manages selection state across its child <OrigamChip> elements. Supports single and multiple selection, horizontal scrolling (slide group), column wrapping and filter mode.
IChipProps
interfaceProps for <OrigamChip>. A compact interactive element used for tags, filters, selections and actions. Supports close button, drag, filter mode, link navigation, group membership and full visual customisation.
ICodeProps
interfaceProps for OrigamCode — a shiki-powered code block with line numbers, line highlighting, copy button, compact pill mode and theme awareness.
IDataItem
interfaceShape of a single item when <OrigamDataList> runs in its default "avatar" mode — a title descriptor (IDataTitleProps) and an array or keyed map of text rows (IDataTextProps), both optional, plus all IAdjacentProps for prepend/append slots.
IDataListKVItem
interfaceShape of a single key/value row when <OrigamDataList> runs in mode="kv". The key is the visible label in the <dt> cell; the value fills the <dd> cell as plain text, a VNode, or an IDataListKVItemValueComponent descriptor.
IDataListKVItemValueComponent
interfaceDynamic-component descriptor for a KV row value. Used when a consumer wants the value cell of <OrigamDataList mode="kv"> to render a registered Origam component (chip, avatar, link…) without writing a slot.
IDataTableGroup
interfaceInternal representation of a group node in a grouped <OrigamDataTable>. Carries the group key, value, nesting depth, and the flattened list of child items or nested sub-groups.
IDataTableGroupableItem
interfaceMinimal discriminated-union marker for a data row node in a grouped DataTable tree. Carries a type="item" literal to distinguish row nodes from IDataTableGroup group nodes.
IDataTableHeader
interfaceDefinition of a single column header in <OrigamDataTable> — key, value accessor, title, alignment, fixed pinning, width/minWidth/maxWidth, sorting callbacks, filter function, mobile visibility, and nested children for multi-row headers.
IDataTableItemBase
interfaceBase shape shared by all row slot contexts in <OrigamDataTable> — provides the row index, raw item, its resolved internal item, and handlers for expand and select.
IDataTextProps
interfaceProps for a data-list text cell — combines layout (adjacent, density, margin, padding) with color surfaces to render a labelled text value inside a data list.
IHeaderCellProps
interfaceShared props for DataTable header cells — controls sort behavior, sticky positioning, and sort direction icons.
IInternalDataTableHeader
interfaceNormalised header descriptor used internally by <OrigamDataTable> after the raw IDataTableHeader array has been processed. Extends IDataTableHeader (omitting key, value, children) with resolved types and layout hints.
IInternalItem
interfaceBase record used by the list and select internals to wrap a raw data item with its resolved value. All item-based components normalise consumer data to this shape before rendering.
IInternalListItem
interfaceNormalised list item record extending IInternalItem with a resolved title, arbitrary props bag, and optional nested children. This is the shape every item-based list component works with internally.
IInternalListItemChildren
interfaceExtension of IInternalListItem that carries an optional type discriminator. Used for heterogeneous lists where items can be regular entries, subheaders, or dividers.
IItemGroupEmits
interfaceEmit contract for <OrigamItemGroup> — inherits the v-model update events from ICommonsComponentEmits so the active item set can be two-way bound.
IItemGroupItemProps
interfaceProps for <OrigamItem> — a single registered member inside an <OrigamItemGroup>. Named IItemGroupItemProps to avoid collision with IItemProps from the List area. The tag prop is shadowed locally to ensure runtime registration.
IItemGroupProps
interfaceProps for <OrigamItemGroup> — the renderless selection container. Provides multi-select or single-select semantics without any visual chrome. The tag prop is shadowed locally to ensure Vue 3 runtime prop registration.
IItemProps
interfaceData source props shared by list and select components. Defines how raw items array is normalised — which keys to use for title, value, children, and additional props.
IKbdProps
interfaceProps for <OrigamKbd> — renders keyboard shortcuts as styled <kbd> elements. Supports single key labels, composed shortcut combinations, and visual variants.
IListActivatorProps
interfaceProps for the internal list group activator component. Provides the basic commons and tag surface — the activator is the clickable header that toggles a list group open or closed.
IListEmits
interfaceEmit contract for <OrigamList> — covers selection and open-state propagation plus user-driven click events on items and groups.
IListGroupEmits
interfaceEmit contract for <OrigamListGroup> — fires when the user clicks the activator chrome, allowing parent components to toggle the open state.
IListGroupProps
interfaceProps for <OrigamListGroup> — a collapsible group inside a list. Supports expand/collapse icons, title, value binding, fluid mode, and the full color, spacing, border, rounded, adjacent and hover surfaces.
IListItemChildren
interfaceData contract describing a flat items array together with an optional returnObject flag. Used by slots that expose item lists from <OrigamList> to nested child components.
IListItemEmits
interfaceEmit contract for <OrigamListItem> — inherits the generic click event from IClickEmits and the prepend/append slot click events from IAdjacentEmits.
IListItemProps
interfaceProps for <OrigamListItem> — a single item row inside a list. Covers activation state, disabled state, link navigation, density, dimension, elevation, multiline lines, and the full adjacent (prepend/append) surface.
IListProps
interfaceProps for <OrigamList> — the primary list container. Accepts a data-driven items array or manual list item children. Supports expand/collapse icons, nested items via INestedProps, density, elevation, dimension, and the full color/spacing/border/rounded surface.
IListSubheader
interfaceProps for <OrigamListSubheader> — a non-interactive section header rendered inside a list. Supports inset alignment, sticky positioning, an optional title, and the full color, spacing, border, and rounded surface.
IQrCodeLogo
interfaceOptional logo overlay rendered at the centre of an OrigamQrCode. The overlay is painted on top of the matrix — error-correction compensates for covered modules up to the configured level.
IQrCodeOptions
interfacePer-matrix overrides applied inside the SVG (modules + quiet zone) independently of the wrapper-level props. Pass via the qrCodeProps prop on <OrigamQrCode>.
IQrCodeProps
interfaceFull props contract for <OrigamQrCode> — SSR-safe SVG QR code renderer. Extends all common DS surface contracts plus QR-specific controls for value, error correction level, quiet zone, overlays and accessibility.
IQrCodeSlots
interfaceSlots contract for <OrigamQrCode>. The center slot replaces the default icon/image overlay. When provided, both icon and image props are ignored.
IResolvedCalendarOptions
interfaceResolved, fully-defaulted option object produced by the useCalendar composable after normalising ICalendarComponentProps. Every field is non-optional at this layer — the composable guarantees a concrete value for each, so downstream rendering logic never has to guard against undefined.
ITableProps
interfaceProps for <OrigamTable> — a styled semantic <table> wrapper. Supports border, rounded, elevation, padding, margin, hover, dimension and density contracts, plus fixed header/footer, caption and ARIA row count.
ITextMaskProps
interfaceProps for <OrigamTextMask> — a typographic "window" component that paints text as a transparent fill over an animated background (background-clip: text). Accepts gradient objects, raw CSS gradient strings, preset names or image URLs.
Data Models
ITimelineEntry
interfaceShape of a single timeline data item. Passed via the items prop of OrigamTimeline to render each dot, its optional icon, title, subtitle, and description automatically.
ITreeviewNode
interfaceShape of a single node in the treeview data tree. Supports recursive nesting via the children array, optional icon, custom size, disabled state, and expandability control.
Data Shapes
ISnackbarGroupItem
interfaceMaterialised item held inside the snackbar stack store. Extends ISnackbarGroupItemOptions with auto-generated id and createdAt timestamp — used internally by useSnackbarGroup and OrigamSnackbarGroup.
ISnackbarGroupItemAction
interfaceAction button descriptor attached to a snackbar stack item. Rendered as a button inside the toast — clicking it invokes handler and by default dismisses the item.
ISnackbarGroupItemOptions
interfaceOptions accepted by useSnackbarGroup().notify(opts) — every field is optional except that the resulting item must surface either a title, a message, or both to the user.
ISrcObject
interfaceStructured image source descriptor for <OrigamImg>. Allows passing src, srcset, lazySrc, aspectRatio and alt as a single object to the src prop instead of individual attributes.
IStepperItem
interfaceDescriptor for a single step inside <OrigamStepper>. Used in the items prop array to define the title, optional subtitle, icon, and initial status of each step.
IVideoSource
interfaceA single <source> entry when the consumer passes multiple media URLs to OrigamVideo (typically one mp4 + one webm so the browser picks whichever codec it can decode). Supports optional quality labelling for the in-player quality switcher.
IVideoTrack
interfaceA single <track> declaration attached to the <video> element. Mirrors the HTML attributes of the native element 1:1 so consumers do not have to learn a new shape. The component renders one <track> per item.
Data Table
IDataTableHeadersCellMobileEmits
interfaceEmits contract for the mobile header cell of a data table — extends IAdjacentEmits with a clear-button click event.
IDataTableHeadersCellMobileProps
interfaceProps for the mobile-only merged header cell of a data table, grouping all visible columns into a single collapsible cell with an optional colspan.
IDataTableHeadersProps
interfaceProps contract for the DataTable headers row — extends ICommonsComponentProps, IColorProps, IDisplayProps, ILoaderProps, and IHeaderCellProps to control appearance, sorting icons, stickiness and loading state of the header area.
IDataTableHeadersSlotProps
interfaceSlot props injected into the DataTable headers slot — provides column definitions, sort state, selection state, and helpers to toggle sort, select-all, and retrieve the sort icon.
IDataTableItem
interfaceInternal representation of a single data-table row — extends IInternalItem, IDataTableGroupableItem, and IDataTableSelectableItem with a unique key, row index, and a pre-computed column values map.
IDataTableSortProps
interfaceProps controlling the sort state of a data table — active sort keys, a custom comparator, multi-column sort, and the mustSort constraint.
Data Visualisation
IChartScales
interfacePair of pixel-mapping functions produced by useChart from the data range and viewBox size. Pure functions — safe to call from computed refs. x maps a value or category index to an SVG horizontal coordinate; y maps a numeric value to an SVG vertical coordinate.
IChartSecondaryYAxis
interfaceConfiguration object for the secondary (right-hand) Y axis on a cartesian chart. When passed to secondaryYAxis on OrigamChartCartesian, series with yAxis: 1 are projected against this scale. Omit to use the primary left axis only.
IChartSeries
interfaceA single data series rendered by OrigamChart. The data field accepts either a flat number array (values aligned to categories by index) or an object array of IChartSeriesPoint for explicit x/y coordinates — required for scatter and sparse data.
IChartSeriesPoint
interfaceObject form of a single data point inside IChartSeries.data. Required for scatter charts where the X axis is not a simple categories[index]. The optional z field turns the point into a bubble by scaling its dot radius.
IChartSlots
interfaceSlot signatures for the universal OrigamChart component. Replace the default tooltip card, a legend entry, the title block, or the empty state without losing the rest of the chart chrome.
IChartSparklineEmits
interfaceEmits surfaced by OrigamChartSparkline. Single event — point-click — fired on mouse click or keyboard activation on a data point, providing the IChartPoint payload and the originating DOM event.
IChartSparklineKind
interfaceInternal marker descriptor for a highlighted circle rendered on the sparkline SVG. Used by the min / max / last indicator rendering logic inside OrigamChartSparkline.
IChartSparklineProps
interfaceProps for OrigamChartSparkline — the tiny inline-chart family. Sparklines are compact data visualisations for embedding in table cells, KPI cards and dashboards. They have no axes, no legend, no grid by default. Extends IChartBaseProps omitting series, showLegend, legendPosition and colorScheme.
IChartSparklineSlots
interfaceSlot signatures exposed by OrigamChartSparkline. Two optional slots: tooltip to replace the default hover body, and empty to render when the series carries no data.
IChartStreamgraphProps
interfaceProps for OrigamChartStreamgraph. Multiple series are rendered as continuous flowing ribbons stacked over time on the X axis. The baseline offset algorithm is controlled by offsetMode: wiggle (canonical streamgraph), silhouette, expand, or zero.
IChartStreamgraphRibbon
interfacePre-computed ribbon descriptor produced by the streamgraph geometry engine for a single series at a single render pass. Contains the resolved SVG path, colour and raw values for tooltip display.
IChartStreamgraphSlots
interfaceSlot signatures exposed by OrigamChartStreamgraph. Extends IChartBaseSlots with a custom tooltip slot that receives all visible series values at the hovered X position for multi-series breakdown rendering.
IChartSunburstDatum
interfaceA single datum node in the sunburst tree. Internal nodes may omit value — it will be auto-computed as the sum of direct children. The children array forms the next ring outward in the chart.
IChartSunburstNode
interfaceFully-resolved node produced by the sunburst geometry engine. Every field is definite — defaults and inherited values have been applied. Contains SVG arc coordinates, resolved colour and the label rendering mode decision.
IChartSunburstProps
interfaceProps for OrigamChartSunburst — the hierarchical ring chart. Extends IChartBaseProps (omitting categories). Series data must be Array<IChartSunburstDatum> carrying a nested tree. Controls inner-radius hole size, ring padding, arc label rendering and value formatting.
IChartSunburstSlots
interfaceSlot signatures exposed by OrigamChartSunburst. Extends IChartBaseSlots with a richer tooltip slot that also receives the hovered IChartSunburstNode and its full ancestor path string.
IChartTick
interfaceA single tick rendered along a chart axis. position is the SVG pixel coordinate, label the already-formatted string to display, and value the original data value before formatting.
IChartTooltipProps
interfaceProps for OrigamChartTooltip — the floating card that follows the cursor and shows the current data point. Extracted from the legacy OrigamChart so every chart family can share the same rendering and slot API. Position is driven by x/y pixel coordinates; no Popper.js dependency.
IChartTooltipSlots
interfaceSlot signatures exposed by OrigamChartTooltip. The default slot replaces the entire tooltip body so consumers can render any chip, icon or formatted currency they need.
IChartTreemapDatum
interfaceA single data item for the treemap series. Consumed from series[0].data — each item becomes one tile sized proportionally to its value. The optional color overrides the palette entry for that specific tile. children is reserved for future nested drilldown support and is ignored in v1.
IChartTreemapProps
interfaceProps for OrigamChartTreemap. Consumes series[0] only — each item in series[0].data becomes one tile sized proportionally to its value. v1 renders a flat single-level treemap; nested children are accepted for forward compatibility but not rendered. Extends IChartBaseProps.
IChartTreemapSlots
interfaceSlot signatures exposed by OrigamChartTreemap. Extends IChartBaseSlots with a tile-label slot that replaces the inline name + value text inside each tile, receiving the full tile descriptor for complete customisation.
DataList
DataTable
IDataTableColumnCellEmits
interfaceIDataTableColumnCellSlots
interfaceIDataTableFooterEmits
interfaceIDataTableFooterSlots
interfaceIDataTableGroupHeaderRowEmits
interfaceIDataTableGroupHeaderRowGroupSlot
interfaceIDataTableGroupHeaderRowSelectSlot
interfaceIDataTableGroupHeaderRowSlots
interfaceIDataTableHeaderCellEmits
interfaceIDataTableHeaderCellSlots
interfaceIDataTableHeadersCellEmits
interfaceIDataTableHeadersCellMobileChipSlot
interfaceIDataTableHeadersCellMobileSlots
interfaceIDataTableHeadersCellSlots
interfaceIDataTableHeadersEmits
interfaceIDataTableHeadersSlots
interfaceIDataTableRowSlots
interfaceIDataTableRowsEmits
interfaceIDataTableRowsSlots
interfaceIDataTableSlots
interface
Date & Time
IDateAdapter
interfaceFull date-manipulation adapter contract. Implement this interface to plug any date library (date-fns, Luxon, Day.js, native Date) into Origam date components.
IDateInstance
interfaceAdapter instance shape — extends TInternalAdapter with an optional locale property. Returned by the adapter constructor and used internally by Origam date composables.
IDateOptions
interfacePlugin-level date configuration passed to createOrigam({ date: … }). Specifies the adapter class or instance, optional format overrides, and locale maps.
IDay
interfaceData shape for a single day cell in the Calendar grid. Carries display strings, boolean flags for all calendar states (selected, disabled, adjacent, etc.) and the raw adapter date value.
Date Picker
IDatePickerHeaderProps
interfaceProps for the DatePicker header row — shows the current month/year label and handles the click that switches between month and year views. Extends ICommonsComponentProps, IColorProps, IAdjacentProps and IDensityProps.
IDatePickerMonthProps
interfaceProps for the month-grid view of the DatePicker — renders the days of a given month with optional week numbers, multi-select, range selection and animated transitions. Extends ICommonsComponentProps, IColorProps and ICalendarProps.
IDatePickerMonthsEmits
interfaceEmits contract for the months-grid panel of the DatePicker — fires update:month when the user clicks a month tile to switch the active month.
IDatePickerMonthsProps
interfaceProps for the months-grid panel that lets the user pick a month — displays a 4x3 grid of month tiles, optionally bounded by min/max. Extends ICommonsComponentProps, IColorProps and IDimensionProps.
IDatePickerProps
interfaceFull props surface for OrigamDatePicker — aggregates color, border, elevation, spacing, picker controls, month/months/years and header sub-interfaces into the top-level component contract. Supports single, multiple and range v-model values.
IDatePickerYearsEmits
interfaceEmits contract for the years-grid panel of the DatePicker — fires update:year when the user clicks a year tile to switch the active year.
IDatePickerYearsProps
interfaceProps for the years-grid panel that lets the user pick a year — displays a scrollable list of year tiles, optionally bounded by min/max. Extends ICommonsComponentProps, IColorProps and IDimensionProps.
DatePicker
IDatePickerControlsEmits
interfaceEmits fired by `<OrigamDatePickerControls>` — clicks on the five toolbar buttons (year / month / prev / next / text label). `event` is optional: the click handlers call `emits('click:prev')` etc. without forwarding the originating MouseEvent.
IDatePickerControlsProps
interfaceIDatePickerControlsSlots
interfaceIDatePickerEmits
interfaceEmits fired by `<OrigamDatePicker>` — main v-model + the three navigation channels (month / year / viewMode) the controls and tables push up.
IDatePickerHeaderEmits
interfaceEmits fired by `<OrigamDatePickerHeader>` — click on the header text. `event` is optional: the handler calls `emits('click')` without forwarding the originating MouseEvent.
IDatePickerHeaderSlot
interfaceIDatePickerHeaderSlots
interfaceIDatePickerMonthDaySlot
interfaceIDatePickerMonthEmits
interfaceIDatePickerMonthSlots
interfaceIDatePickerMonthsButtonProps
interfaceIDatePickerMonthsItem
interfaceIDatePickerMonthsSlot
interfaceIDatePickerMonthsSlots
interfaceIDatePickerSlots
interfaceIDatePickerYearsButtonProps
interfaceIDatePickerYearsItem
interfaceIDatePickerYearsSlot
interfaceIDatePickerYearsSlots
interface
DatePickerField
DefaultsProvider
Directives
IClickOutsideBindingArgs
interfaceObject-form argument for the v-click-outside directive. Allows fine-grained control: conditional close logic and a list of elements to treat as "inside".
IClickOutsideDirectiveBinding
interfaceTyped DirectiveBinding for v-click-outside. The value accepts either a bare handler function or the full IClickOutsideBindingArgs object.
IRippleDirectiveBinding
interfaceTyped directive binding for `v-ripple` — extends Vue's DirectiveBinding with a narrowed `value` (boolean or `{ class }` object) and typed `modifiers` for center, circle and stop behaviours.
IRippleElement
interfaceIndividual ripple DOM element — extends Element with an optional `dataset` typed as `IRippleElementDataset`, giving typed access to the `isHiding` and `activated` data attributes written by the ripple animation engine.
IRippleElementDataset
interfaceTyped `dataset` shape on a ripple wave element — two string flags written by the animation engine to track whether the wave is currently fading out and whether it has been activated.
IRippleHtmlElement
interfaceAugmented HTMLElement that carries the `_ripple` private state bag written by `v-ripple`. All fields are optional so the interface can be safely cast from any HTMLElement and read without null-guard noise.
Directives & Utilities
IHotkeyOptions
interfaceConfiguration options for the useHotkey composable and the v-hotkey directive — controls the listened event type, whether inputs are excluded and sequence timing.
IHoverDirectiveBinding
interfaceTyped directive binding for v-hover — extends Vue's DirectiveBinding with a typed value (boolean or config object) and the directive modifiers.
IHoverDirectiveConfig
interfaceObject configuration accepted by v-hover — specifies which CSS class to toggle and optional mouseenter/mouseleave handlers.
IHoverHtmlElement
interfaceHTMLElement augmented with a private _hover property that stores the v-hover directive's runtime state on the DOM node.
IHoverHtmlElementHover
interfaceInternal state object stored by the v-hover directive on the DOM element — holds the enabled flag, active class, touch detection and event handlers.
IHoverOptions
interfaceRuntime options resolved by the v-hover directive after merging the binding value — holds the final CSS class to toggle on the element.
IIntersectDirectiveBinding
interfaceTyped directive binding for v-intersect — extends Vue's DirectiveBinding with a typed value (handler or handler+options) and once/quiet modifiers.
IIntersectHtmlElement
interfaceHTMLElement augmented with a private _observe property that the v-intersect directive uses to store its per-observer runtime state on the DOM node.
IIntersectHtmlElementObserve
interfaceIndex signature map stored on an element by the v-intersect directive — each key is an observer id and the value holds the corresponding IntersectionObserver instance and its options.
Disclosure
IExpansionPanelContentProps
interfaceProps for the collapsible body of OrigamExpansionPanel. Controls the rendered content, lazy mounting, loader state and all visual surface properties (color, border, padding, rounded …).
IExpansionPanelEmits
interfaceEmits contract for OrigamExpansionPanel — inherits IGroupEmits which carries the group membership lifecycle events (click, update:modelValue) used by the accordion group coordination layer.
IExpansionPanelHeaderEmits
interfaceEmits contract for OrigamExpansionPanelHeader — inherits IAdjacentEmits which carries click events from the prepend and append icon slots.
IExpansionPanelHeaderProps
interfaceProps for the clickable header row of OrigamExpansionPanel. Controls the expand/collapse icons, focusability, static mode, readonly state, title text and all visual surface properties.
Display & Responsive
IDisplayInstance
interfaceReactive display service — the object returned by useDisplay(). Exposes reactive breakpoint flags, current viewport dimensions, platform detection and an update() method for manual refresh.
IDisplayOptions
interfaceConfiguration bag for the useDisplay() plugin — sets the global mobile breakpoint and the named breakpoint thresholds at install time.
IDisplayPlatform
interfacePlatform detection snapshot — a set of boolean flags that identify the current runtime environment (OS, browser, form factor). Exposed as `platform` on the IDisplayInstance reactive object.
IDisplayProps
interfaceDisplay contract — lets a component declare its own mobile breakpoint, overriding the global one injected by useDisplay().
Drawer
Events & Emits
IActiveEmits
interfaceEmit contract for components that propagate their active state — fires update:active whenever the active state changes.
IAdjacentEmits
interfaceClick events emitted when the user clicks the outer prepend or append slots of a component.
IAdjacentInnerEmits
interfaceClick events for icons rendered INSIDE the input chrome — clear button, password toggle and similar inner-surface actions.
IAlertEmits
interfaceEmits contract for <OrigamAlert> — extends the shared component emits with close-button and hover propagation.
IAppBarEmits
interfaceEmits contract for <OrigamAppBar> — extends the shared component emits contract with no additional events.
IAppEmits
interfaceEmits contract for <OrigamApp> — delegates entirely to the shared component emits; no additional events are fired by the application shell.
IAudioEmits
interfaceEmits surfaced by <OrigamAudio>. Event names mirror native DOM audio events one-to-one, plus v-model bindings for playbackRate, currentTrackIndex, loopMode and shuffle.
IAudioPlayerEmits
interfaceEmit signatures recommended for audio host components using useAudioPlayer. Extends the media-agnostic IMediaPlayerEmits baseline — the composable itself does not emit; this interface is for the host SFC defineEmits contract.
IAvatarEmits
interfaceEmits contract for <OrigamAvatar> — active state propagation and hover state propagation.
IAvatarGroupEmits
interfaceEmits contract for <OrigamAvatarGroup> — propagates active and hover state from the underlying avatars.
IBottomNavEmits
interfaceEmit contract for <OrigamBottomNav> — propagates active-state and hover-state changes through the shared Commons, IActiveEmits and IHoverEmits contracts.
IBreadcrumbItemEmits
interfaceEmit contract for <OrigamBreadcrumbItem> — click events on prepend/append adjacent slots, inherited from IAdjacentEmits.
IBtnEmits
interfaceEmit contract for <OrigamBtn> — click events on prepend/append adjacent slots and group-membership lifecycle events.
IBtnToggleEmits
interfaceEmit contract for <OrigamBtnToggle> — v-model on the active toggle index, inherited from ICommonsComponentEmits.
IClickCloseEmits
interfaceclick:close emit contract — fires when the user dismisses a closeable surface such as an Alert or Snackbar.
IClickEmits
interfaceGeneric click emit contract — bubbles the native MouseEvent from any interactive surface.
IClickLabelEmits
interfaceEmit contract fired when the user clicks the associated <label> element rather than the input chrome itself. Used by selection controls (Radio, Switch, Checkbox).
IClickOutsideEmits
interfaceEmit contract fired when a pointer-down event lands outside the component root. Used by overlay-based surfaces (Dialog, Drawer, Overlay).
ICommonsComponentEmits
interfaceDefault v-model emit shape shared by every input-style component. Provides the standard update:modelValue event.
IDialogConfirmationEmits
interfaceEmit contract for the confirmation dialog — fires validate when the user confirms and cancel when the user dismisses.
IDrawerEmits
interfaceEmit contract for <OrigamDrawer> — fires update:rail when the rail collapsed state changes.
IExpansionPanelsEmits
interfaceEmit contract for the expansion-panels container — extends ICommonsComponentEmits to propagate v-model and lifecycle events.
IFieldEmits
interfaceAggregate emit contract for OrigamField — bundles focus events, commons component events, adjacent-inner slot events, and the active-state lifecycle so consumers can defineEmits<IFieldEmits>() without repeating each signature.
IFileFieldDragNDropItemEmits
interfaceEmit contract for the drag-and-drop file item — fires click:remove when the user removes a file from the drop zone.
IFileFieldEmits
interfaceEmit contract for OrigamFileField — extends IFieldEmits and IInputEmits with file-specific events: control clicks, remove, download, drop and max-size error.
IFileFieldListItemEmits
interfaceEmit contract for the list-style file item card — fires click:remove when the user removes a file.
IFocusEmits
interfaceEmit signature for components that propagate focus state changes. Declares the `update:focused` event required by v-model:focused.
IFormEmits
interfaceEmit contract for OrigamForm — fires submit when the form is submitted (after validation) and reset when it is reset.
IGroupEmits
interfaceEmit signature for components that participate in a selectable group — declares the `group:selected` event used to propagate selection state to the group provider.
IHoverEmits
interfaceEmit signature for components that propagate their hover state — emits update:hover with a boolean whenever the pointer enters or leaves.
IImgEmits
interfaceEmit contract for OrigamImg — mirrors the native <img> lifecycle: loadstart fires before the network request, load when fully decoded, error when the browser gives up.
IIndeterminateEmits
interfaceEmit signature for three-state controls — emits update:indeterminate with a boolean to enable v-model:indeterminate two-way binding on Switch, Checkbox and similar components.
IInfiniteScrollEmits
interfaceEmit contract for OrigamInfiniteScroll — the load event fires when the sentinel enters the viewport; the handler must call done() with ok, empty, or error to signal the result.
IInfiniteScrollIntersectEmits
interfaceEmit contract for the lower-level OrigamInfiniteScrollIntersect sentinel — bubbles IntersectionObserver entries as an intersect event carrying the visibility state and scroll side.
IInlineEditEmits
interfaceEmit contract for OrigamInlineEdit — covers the v-model echo, edit/cancel/confirm lifecycle events, and validation error reporting.
IInputEmits
interfaceAggregate emit contract for OrigamInput — combines the commons v-model echo, outer prepend/append click events (IAdjacentEmits), and focus state events (IFocusEmits).
ILazyEmits
interfaceEmits contract for OrigamLazy — extends ICommonsComponentEmits. The v-model update fires when the IntersectionObserver flips visibility.
IMediaControllerEmits
interfaceEmits surfaced by <OrigamMediaController>. The shell calls methods.* directly for the basic ops (toggle play, seek, set volume, set rate, toggle mute, request cast) — those do not bubble. These emits are the ones the parent must handle because the Controller does not own enough context.
IMediaPlayerEmits
interfaceShared media event signatures. Composables themselves do NOT emit — consumers wire their own emits from the state refs. This interface is kept for documentation and for components that want to surface the same shape on their public emit contract.
IMediaVolumeControlEmits
interfaceEmits surfaced by <OrigamMediaVolumeControl>. The atom does NOT call methods.* directly; the parent owns the media-side mutations. update:muted is fired on mute/unmute toggle, update:volume on scrubber drag.
ISwitchEmits
interfaceEmit contract for <OrigamSwitch> — aggregates commons component events, focus lifecycle, indeterminate three-state changes and label click.
ISwitchTrackEmits
interfaceEmit contract for <OrigamSwitchTrack> — extends commons component emits with a native click event forwarded from the track rail.
ITabPanelsEmits
interfaceEmit contract for <OrigamTabPanels> — mirrors the parent tablist v-model via ICommonsComponentEmits (update:modelValue).
ITabsEmits
interfaceEmit contract for <OrigamTabs> — inherits update:modelValue from ICommonsComponentEmits to sync the active tab value with v-model.
ITextFieldEmits
interfaceEmit contract for <OrigamTextField> — aggregates field and input lifecycle events, control click/mousedown events, and mask-specific validity and completion signals.
ITextareaFieldEmits
interfaceEmit contract for <OrigamTextareaField> — aggregates field and input lifecycle events plus height update (auto-grow), control click/mousedown, and rich-text format command events.
ExpensionPanel
Feedback & Status
IEmptyStateProps
interfaceProps for OrigamEmptyState — the placeholder shown when a list, table or collection has nothing to display. Five built-in visual presets (no-data, no-results, error, offline, locked) bundle icon and intent; both can be overridden.
IEmptyStateSlots
interfaceSlot contract for OrigamEmptyState. All slots are optional. The default slot replaces the entire built-in layout; targeted slots (icon, title, description, actions) swap individual pieces.
ILoaderProps
interfaceLoading-state contract — extends common, tag and color props with a polymorphic loading flag and an accessible loading text.
IProgressCircularProps
interfaceProps contract for <OrigamProgressCircular>. Extends IProgressTypeProps and ISizeProps with a rotate prop to control the starting angle of the arc.
IProgressLinearProps
interfaceProps contract for <OrigamProgressLinear>. Extends IProgressTypeProps, IRoundedProps and ILocationProps with buffer value, clickable track, reverse direction and stream mode.
IProgressProps
interfaceUnified props contract for <OrigamProgress> — the polymorphic wrapper that renders either a linear or circular indicator depending on the type prop. Extends both IProgressLinearProps and IProgressCircularProps.
IProgressTypeProps
interfaceBase props shared by all progress variants (linear and circular). Carries value, indeterminate mode, thickness, active flag, absolute positioning, max value, striped mode and an accessible label.
IStatusProps
interfaceStatus indicator props — extends IIconProps with a semantic status level (success, warning, danger, info) and a position for the status icon badge.
Form & Input
ICheckboxBtnEmits
interfaceEmits for <OrigamCheckboxBtn>. Extends ICommonsComponentEmits, IFocusEmits and ISelectionControlEmits with an indeterminate-sync event fired when the indeterminate state changes.
ICheckboxBtnProps
interfaceProps for <OrigamCheckboxBtn>. Extends ISelectionControlProps with indeterminate state support — the third visual state between checked and unchecked.
ICheckboxBtnSlots
interfaceSlot signatures for <OrigamCheckboxBtn>. Extends ICommonsComponentSlots with a label slot and an input slot that exposes the underlying props, icon and color state for full customisation.
ICheckboxEmits
interfaceEmits for <OrigamCheckbox>. Composes ICommonsComponentEmits, IFocusEmits (focus/blur) and ISelectionControlEmits (update:modelValue and update:indeterminate).
ICheckboxProps
interfaceProps for <OrigamCheckbox> — the full-featured form checkbox combining ICheckboxBtnProps with IInputProps (validation, messages, label) and all visual surface interfaces (color, border, elevation, density, spacing, rounded).
ICheckboxSlots
interfaceSlot signatures for <OrigamCheckbox>. Provides a default slot for full layout control, a label slot for rich label content, and an input slot for replacing the checkbox visual itself.
IColorPickerFieldProps
interfaceProps for OrigamColorPickerField — a text-field that opens an inline ColorPicker menu, inheriting the full field + input pipeline (validation, density, adjacent, transition).
IConfirmWrapperEmits
interfaceEmits fired by OrigamConfirmWrapper — extends the standard component and focus emit shapes, plus a dedicated update:confirm event to keep the confirmation field value in sync.
IConfirmWrapperProps
interfaceFull props contract for <OrigamConfirmWrapper> — a "type-it-twice" form helper that pairs a primary input with a confirmation input and lights up only when both values match. Inherits layout, color, density, rounded, elevation, variant and focus mixins.
IControlProps
interfaceMinimal prop shape for standalone icon-button controls (clear, visibility-toggle, counter actions). Requires an icon, a class string, and an accessible aria-label.
IFieldProps
interfaceFull prop surface for OrigamField — controls label, prefix/suffix, error state, disabled/dirty/required flags, and inherits color, density, variant, rounded, elevation, size, loader, focus and adjacent-inner surfaces.
IFieldValidationResult
interfaceValidation result for a single field — carries the field id and the list of error messages produced by its validation rules.
IFileFieldDragNDropItemProps
interfaceProps for the individual drag-and-drop file card rendered inside the FileField dropzone — exposes the file object, its index, upload progress, icon overrides, and disabled/readonly/showSize flags.
IFileFieldListItemProps
interfaceProps for the list-style file item card rendered inside FileField — mirrors IFileFieldDragNDropItemProps with the same file, index, progress, icon overrides and showSize options.
IFileFieldProps
interfaceFull prop surface for OrigamFileField — controls multiple selection, display mode (list/chips/counter), dropzone mode, upload progress, size display, custom icons and inherits the full IFieldProps and IInputProps surfaces.
IFormField
interfaceInternal registration record for a field inside an OrigamForm — carries the field id, validation/reset methods, the component instance, and the current valid/error state.
IFormProps
interfaceProps for OrigamForm — controls disabled/readonly state, validation timing (validateOn), fast-fail behaviour, error messages, hints, scroll-to-error, and the overall validity v-model.
IFormProvide
interfaceProvide/inject contract exposed by OrigamForm to its descendant fields — lets fields register/unregister themselves and report validation state back to the parent form.
IFormValidationResult
interfaceResult of a full form validation — carries an overall valid flag and the per-field error details via IFieldValidationResult.
IInlineEditProps
interfaceProps contract for OrigamInlineEdit — the edit-in-place component. Controls validation rules, auto-focus, select-on-focus, confirm/cancel triggers, multiline mode, and built-in action buttons.
IInputProps
interfaceProps contract for OrigamInput — the foundational input wrapper. Aggregates density, spacing, rounding, color, border, elevation, dimension, direction, validation, adjacent-slot, and size surfaces.
IInputSlots
interfaceSlot signatures for <OrigamInput>. The default slot exposes the input control identity and state so downstream components can wire up their native element with the right ARIA and event handlers.
ILabelEmits
interfaceEmit contract for <OrigamLabel> — exposes a single click event so parent form field components can react to label clicks (e.g. focus the associated input).
ILabelProps
interfaceProps for <OrigamLabel> — the accessible label component used by form fields. Supports floating labels, required indicators, custom tag, and the full color, border, rounded, spacing surface.
ILabelSlots
interfaceSlot contract for <OrigamLabel> — inherits the default slot from ICommonsComponentSlots so consumers can replace the label text content with arbitrary markup.
IPasswordFieldEmits
interfaceEmits contract for <OrigamPasswordField>. Extends IFieldEmits and IInputEmits with a control click event, a control mousedown event and a strength-level update event.
IPasswordFieldProps
interfaceProps contract for <OrigamPasswordField>. Extends ITextFieldProps with show/hide toggle icons, strength bar, configurable requirements checklist and a minimal mode that strips all adornments.
IPasswordFieldSlots
interfaceSlots contract for <OrigamPasswordField>. Extends IFieldSlots and IInputSlots (minus default) with an info slot for the requirements popup body, a counter slot and a field slot to replace the native input.
IPasswordRequirement
interfaceDescriptor for one rule shown in the requirements checklist or tile grid of <OrigamPasswordField>. The test() predicate is evaluated reactively against the current password value.
IPasswordStrength
interfaceResult returned by computeStrength() and consumed by <OrigamPasswordField> to drive the strength bar UI. Carries a numeric score (0..4) and a semantic level identifier.
IPickerProps
interfaceProps contract for <OrigamPicker>. Extends ISheetProps, IBgColorProps and IPickerTitleProps with layout flags for landscape orientation and optional header visibility.
IPickerTitleProps
interfaceProps contract for <OrigamPickerTitle>. Extends common component, tag, color and bgColor contracts with a title string prop for the picker header.
IRadioBtnEmits
interfaceEmits contract for <OrigamRadioBtn>. Extends ICommonsComponentEmits, IFocusEmits and IClickLabelEmits. Same surface as the full <OrigamRadio> emit contract.
IRadioBtnProps
interfaceProps contract for <OrigamRadioBtn> — the inner clickable dot/control of a radio input. Extends ICommonsComponentProps and ISelectionControlProps.
IRadioEmits
interfaceEmits contract for <OrigamRadio> — v-model, focus events and label click. Extends ICommonsComponentEmits, IFocusEmits and IClickLabelEmits.
IRadioGroupProps
interfaceProps contract for <OrigamRadioGroup> — wraps a set of radio inputs as a single controlled group. Inherits component, spacing, border, elevation and input contracts, plus optional partial radio and selection-control-group props.
IRadioProps
interfaceFull prop surface for <OrigamRadio>. Merges the input contract (IInputProps), radio-button specifics (IRadioBtnProps), density, spacing, rounding, color, border, elevation, and active/hover state into a single interface.
IRatingFieldEmits
interfaceEmit signature for <OrigamRatingField>. Extends ICommonsComponentEmits to inherit the standard v-model and lifecycle emits; the rating value update is handled via the modelValue emit from the commons contract.
IRatingFieldItemEmits
interfaceEmit signature for <OrigamRatingFieldItem>. Extends IClickEmits with mouseenter/mouseleave so the parent RatingField can drive the half-rating hover preview from pointer movement over individual star items.
IRatingFieldItemProps
interfaceProps for a single star/icon cell inside <OrigamRatingField>. Declares the item-level state (value, filled, hovered, checked) alongside the full visual surface (color, size, density, rounded, border, elevation, padding, margin).
IRatingFieldProps
interfaceProps for <OrigamRatingField>. Extends the input contract (IInputProps), ripple effect (IRippleProps), tag polymorphism (ITagProps), and label (ILabelProps) with rating-specific props such as icon customisation, half-increments, hover preview, and per-item aria labels.
IResolvedMaskConfig
interfaceNormalised mask configuration returned by resolveMaskConfig after accepting a raw string pattern, a preset key, or an IMaskOptions object as input. At this layer the pattern is always a raw template string and every field is guaranteed non-optional.
IRichToolbarEmits
interfaceEmit signature for the internal <OrigamRichToolbar> sub-component of OrigamTextareaField. Surfaces a single "format" event carrying the command id and an optional value (URL for link insertion) so the textarea can apply the formatting to its content model.
IRichToolbarProps
interfaceProps for the internal <OrigamRichToolbar> sub-component of OrigamTextareaField. Kept package-private so the API can evolve without breaking external consumers. Exposes the command list, current active-format state, optional position, and disabled flag.
ISelectEmits
interfaceEmit signature for <OrigamSelect>. Extends the commons, focus, adjacent, and adjacent-inner emit contracts with three select-specific events: click:control (pointer click on the control surface), mousedown:control (mousedown before the dropdown opens), and update:menu (v-model:menu synchronisation).
ISelectProps
interfaceFull prop surface for <OrigamSelect>. Aggregates the text-field base, density, adjacent slots, field chrome, input contract, spacing, border, rounded, elevation, item list configuration, transitions, filters, and lazy loading, then adds select-specific behaviour: chips, multiple selection, menu control, autocomplete, and search.
ISelectionControlEmits
interfaceEmit signature for <OrigamSelectionControl> (the base for Checkbox, Switch, and Radio). Extends ICommonsComponentEmits with a single click:label event fired when the user clicks the label text rather than the control itself.
ISelectionControlGroupEmits
interfaceEmit signature for <OrigamSelectionControlGroup>. Extends ICommonsComponentEmits, inheriting the standard v-model (update:modelValue) and lifecycle emits. No group-specific events are declared beyond the commons contract.
ISelectionControlGroupProps
interfaceProps for <OrigamSelectionControlGroup>, the container that manages a group of checkboxes, radios, or switch controls. Extends commons, color, density, and ripple surfaces with group-specific props: input type, inline layout, icons, multiple selection, name grouping, readonly/disabled state, and a custom value comparator.
ISelectionControlGroupSlots
interfaceSlot signatures for <OrigamSelectionControlGroup>. Exposes a default slot for fully custom rendering of all items, an item slot for per-item customisation, and an open index signature to allow arbitrary named slots to be forwarded from parent components.
ISelectionControlProps
interfaceProps for <OrigamSelectionControl>, the base component shared by Checkbox, Switch, and Radio. Extends commons, a partial of the group props (excluding items), color, bgColor, active/hover state, and density, then adds individual control-level bindings: label, trueValue, falseValue, value, and required.
ISelectionControlSlots
interfaceSlot signatures for <OrigamSelectionControl>. Three slots give full control over the rendering: default replaces the entire control surface, label replaces the label text, and input replaces the underlying native input element.
ISelectionGroupContext
interfaceProvide/inject context passed from SelectionControlGroup to each child SelectionControl. Exposes the shared reactive modelValue, a forceUpdate trigger for when the parent needs to re-evaluate all children, and an onForceUpdate registration hook for children to subscribe.
Form & Validation
IValidationFieldResult
interfaceResult object for a single validated field — pairs the field identifier with the list of error messages produced by failed rules.
IValidationProps
interfaceComplete validation surface for form-control components — extends IFocusProps with rules, error state, error messages, disabled/readonly flags, label and the validateOn trigger.
Forms & Inputs
ISwitchProps
interfaceFull prop surface for <OrigamSwitch> — extends selection-control, input, color, border, elevation, density, margin/padding, rounded and active/hover contracts, with three switch-specific facets: indeterminate, inset and flat.
ISwitchTrackProps
interfaceProps for <OrigamSwitchTrack> — the rounded rail behind the thumb. Owns the visual surface (bgColor = rail, color = foreground/thumb intent) and exposes inset, error, disabled and readonly states.
ITextFieldProps
interfaceFull prop surface for <OrigamTextField> — extends field, input, color, density, padding/margin, border, rounded and elevation contracts, with autofocus, counter, placeholder, input type and mask support.
ITextareaFieldProps
interfaceFull prop surface for <OrigamTextareaField> — extends field, input, color, density, adjacent-inner, padding/margin, border, rounded and elevation contracts. Adds auto-grow, rows, counter, prefix/suffix, rich mode and toolbar configuration.
Grids
Group & Selection
IGroupItemProps
interfaceProps for an individual item inside a selectable group — its value, disabled state and optional selected class override.
IGroupItemProvide
interfaceRuntime injection provided by each item component to its descendants — exposes identity, selection state, toggle and a back-reference to the parent group.
IGroupProps
interfaceProps for a selectable group container — controls the v-model, multiplicity, mandatory selection and the selected-class propagated to items.
IGroupProvide
interfaceRuntime injection provided by a group component to all its item descendants — exposes registration, selection control, navigation and the full item list.
Icon
Icons
IIconAliases
interfaceIndex-signature map from alias name to icon value, used to register custom icon aliases in the Origam icon configuration.
IIconComponentProps
interfaceFull props surface for OrigamIcon — extends the base IIconProps with color, background color, size, padding, margin, border, dimension, rounded, and a disabled flag.
IIconProps
interfaceMinimal icon prop surface shared across all Origam components that display an icon — a single optional icon prop accepting any TIcon value.
IIconSet
interfaceDescriptor for a custom Origam icon set — holds the Vue component that the icon renderer will mount when this set is active.
InfiniteScroll
Interaction & State
IFocusProps
interfaceFocus contract — a single `focused` prop that lets the parent control or observe the focus state of a component that manages keyboard focus internally.
IHoverProps
interfaceProp contract for components that expose a controllable hover state — accepts a boolean to force-enable hover or an IHoverState object for per-property overrides while hovered.
Internal
ISample
interfaceInternal data-point shape used by the velocity composable. A sample records a timestamp (t) and a distance (d) to compute pointer velocity for inertia-scroll calculations.
IStackProvide
interfaceVue provide/inject contract shared by the overlay-stack composable. Allows child overlays to register themselves with a parent stack so z-index ordering is managed globally rather than per-component.
Internationalisation
ILocaleI18n
interfacePair of the raw vue-i18n I18n instance and its useI18n composable — injected by createLocale() and consumed by the locale adapter.
ILocaleInstance
interfaceRuntime locale adapter contract — provides reactive locale state, a translate function (t), a number formatter (n) and a scoped child adapter factory.
ILocaleMessages
interfaceRecursive message map type — each value is either a translated string or a nested ILocaleMessages object.
ILocaleOptions
interfaceConfiguration options for the built-in Origam locale adapter — passed to createLocale() when not using a third-party i18n library.
ItemGroup
Layout
IColProps
interfaceProps for OrigamCol — a responsive grid column that accepts breakpoint spans (cols/sm/md/lg/xl/xxl), column offsets, order, color and spacing.
IDividerProps
interfaceProps for OrigamDivider — a thin horizontal or vertical separator. Supports inset, custom length and thickness on top of color, background-color, margin and direction.
IDrawerProps
interfaceProps for OrigamDrawer — the side navigation panel. Covers permanent, temporary, rail and expand-on-hover modes, layout reservation (push), viewport positioning (clipped), resize/route watchers and all visual surface props.
IGridLineSpec
interfaceObject syntax for a CSS grid line specification used by OrigamGridItem — express column/row placement with start, end, or span without writing raw CSS grid syntax.
IGridProps
interfaceProps contract for OrigamGrid — a declarative CSS Grid container. Covers track templates (columns/rows), gap, areas, auto-flow, alignment, and all standard visual surfaces (color, border, elevation, dimension).
IInfiniteScrollIntersectProps
interfaceProps for the low-level OrigamInfiniteScrollIntersect sentinel element — configures the IntersectionObserver root, scroll side, and margin.
IInfiniteScrollProps
interfaceProps contract for OrigamInfiniteScroll — configures scroll side, intersection mode, empty/load-more text labels, root margin, and visual surfaces.
ILayoutEmits
interfaceIResponsiveProps
interfaceProps for <OrigamResponsive>. Merges dimension, commons, padding, margin, border, and rounded surfaces with three responsive-specific props: aspectRatio (locks the intrinsic ratio), contentClass (targets the inner wrapper), and inline (switches the outer element between block and inline-block).
IRowProps
interfaceProps for <OrigamRow>, the grid row container. Extends commons, tag, padding, margin, border, color, density, align, and justify surfaces with two row-specific props: gutters (column/row gap shorthand) and direction (flex-direction override).
ISystemBarProps
interfaceProps for <OrigamSystemBar> — a thin status strip at the top of the viewport (OS-style). Participates in layout, supports color, elevation, border, dimension and rounded facets, plus a window mode that reduces height.
Layout & Sizing
IAdjacentInnerProps
interfaceProps for icons and avatars rendered INSIDE the input chrome (prepend-inner, append-inner) plus the clearable icon and its toggle.
IAdjacentProps
interfaceProps for icons and avatars placed OUTSIDE the component chrome (prepend, append) — used by buttons, list items, cards and similar surface components.
IAlignProps
interfaceResponsive alignment contract — sets the cross-axis alignment (align-items / justify-content) at each breakpoint independently.
IBox
interfaceBounding-box snapshot — the shape returned by useResizeObserver and intersection utilities, describing an element's position and dimensions in the viewport.
IDensityProps
interfaceDensity contract — controls vertical compactness of components that support multiple sizes (default, comfortable, compact). Consumed by useDensity().
IDimensionProps
interfaceSizing contract — height/width plus their min/max bounds, consumed via useDimension().dimensionStyles.
IDirectionProps
interfaceDirection contract — exposes a single `direction` prop (horizontal / vertical) consumed by layout-aware components such as Tabs, Divider, InfiniteScroll and SlideGroup.
IGridItemProps
interfaceProps for OrigamGridItem — controls CSS Grid placement via column, row and area (object or shorthand string syntax), plus per-item alignSelf and justifySelf overrides.
IInternalDisplayOptions
interfaceResolved, non-optional display configuration used internally by the display composable after applying defaults — both mobileBreakpoint and thresholds are guaranteed to be present.
IJustifyProps
interfaceResponsive justify-content contract — one breakpoint-aware prop per viewport tier, consumed by grid/row components.
ILayer
interfaceBounding-box record used by the layout system to track occupied space on each side of the main area.
ILayerItem
interfaceExtends ILayer with identity, size and position metadata — represents a single registered layout item (AppBar, Drawer, BottomNav …) inside ILayoutProvide.
ILayoutItemProps
interfaceProps for components that register themselves as layout items (AppBar, Drawer, BottomNav …) inside an OrigamLayout.
ILayoutProps
interfaceFull prop surface for OrigamLayout — combines common, dimension, spacing, shape, color and border contracts with layout-specific config.
ILayoutProvide
interfaceInternal provide/inject contract exposed by OrigamLayout to its registered layout items — do not use directly in application code.
ILazyComponentProps
interfaceProps for OrigamLazy — extends the common, dimension, tag and transition contracts with IntersectionObserver options and a v-model visibility toggle.
ILazyProps
interfaceMinimal eager-load contract shared by components that support deferred rendering — a single boolean to bypass lazy behaviour.
ILocationProps
interfaceMinimal anchor contract — a single `location` prop that determines where a floating or anchored element is positioned relative to its target.
ILocationStrategyData
interfaceRuntime data bag passed to a location strategy function — gives access to the floating content element, the anchor target and the active state so the strategy can compute and apply the correct position.
ILocationStrategyProps
interfaceFull positioning contract for floating elements — extends IDimensionProps with strategy selection, anchor/origin pair, pixel offset and viewport margin. Consumed by Menu, Select, Tooltip and any component using the connected or static location strategies.
IMainProps
interfaceProps for <OrigamMain> — the primary content area in the application layout. Registers itself with the layout system to respect AppBar/Drawer offsets, and exposes the full color, spacing, border, rounded, dimension, and elevation surface.
IMarginProps
interfaceMargin spacing contract — all four sides plus logical block/inline shorthands. Values map to the DS spacing scale when a number or scale key is passed, or accept any CSS length string.
IPaddingProps
interfacePadding spacing contract — all four sides plus logical block/inline shorthands. Values map to the DS spacing scale when a number or scale key is passed, or accept any CSS length string.
IPositionProps
interfaceCSS position contract — the positioning scheme plus numeric/string inset values for each side. Consumed by fixed or sticky surfaces such as app bars, FABs and snackbars.
ISizeProps
interfaceNamed-size contract for icon-sized and token-driven components. Accepts a TSize variant name (x-small, small, default, large, x-large) or a raw number resolved to pixels.
ISticky
interfaceReturn shape of the useSticky composable. Exposes the root element ref, a reactive flag indicating whether the component is currently stuck, and the computed CSS styles for the layout item slot.
Layout & Structure
IWatermarkSlots
interfaceSlot signatures for <OrigamWatermark> — defines the default slot that wraps the content rendered beneath the diagonal overlay.
IWindowItemProps
interfaceProps contract for <OrigamWindowItem> — a single slide in a Window carousel. Supports lazy loading, group selection, and per-item transition overrides.
IWindowProps
interfaceProps contract for <OrigamWindow> — a swipeable, keyboard-navigable carousel container. Combines visual theming, directional control, navigation arrows, touch handling and group selection.
List
Locale & RTL
IRtlInstance
interfaceRuntime RTL context returned by the locale composable. Exposes whether the current locale renders right-to-left and the per-locale RTL override map.
IRtlOptions
interfaceInstall-time RTL configuration merged into the locale options of createOrigam(). Maps locale codes to a boolean indicating whether that locale is right-to-left.
IRtlProps
interfacePer-instance RTL override prop. Extended by container components that need to force a right-to-left text direction independently of the global locale setting.
Main
Mask
IMaskApplyResult
interfaceOutput shape of applyMask — masked is the formatted display string with literals interleaved; unmasked is the raw user-provided characters (consumer slots only); complete signals that all consumer tokens are filled.
IMaskOptions
interfaceConfiguration object accepted by useMask and the OrigamTextField mask prop in its long form. Defines the pattern template, an optional secondary validator, and a required flag.
IMaskToken
interfaceToken emitted by the pattern parser. kind describes what character class the token accepts; consumer flags whether the token slots a user character (#, A, *) or is a literal kept verbatim.
IUseMaskReturn
interface
Masonry
Media
IConfigMenuItem
interfaceIImgProps
interfaceProps contract for OrigamImg — covers source, lazy loading, responsive sizes, gradient overlays, cross-origin policy, and transition configuration.
IMediaVolumeControlSlots
interfaceIUseAudioProps
interfaceProps for the low-level useAudio composable — wires a frequency analyser and a play-on-flag mechanism. Renamed from IAudioProps to avoid collision with the OrigamAudio component interface.
Menu
Messages
Motion & Parallax
IParallaxLayerRegistry
interfaceInternal layer descriptor registered into the parent OrigamParallax via provide/inject. The parent reads speed, offsetX and offsetY to compute the per-frame transform, then applies it to the shared target HTMLElement.
IParallaxProps
interfaceFull props contract for <OrigamParallax>. Extends common component, color, spacing, border, dimension and audio contracts, plus parallax-specific controls for easing, speed, direction, event type and threshold.
IParallaxProvide
interfaceProvide context exposed by OrigamParallax to its OrigamParallaxElement children via Vue inject. Carries reactive refs for audio data, pointer event position, movement state, easing and container shape.
Navigation
ICommand
interfaceA single command/action exposed by OrigamCommandPalette — holds the stable id, label, optional description, icon, keyboard shortcut hint, group, extra search keywords and the perform handler.
ICommandPaletteEmits
interfaceEmits fired by OrigamCommandPalette — open/close state, selected command, and search query text.
ICommandPaletteProps
interfaceProps for OrigamCommandPalette — a global ⌘K command palette that fuzzy-searches registered commands, supports custom hotkeys, grouping, async loading and slot customisation.
ICommandPaletteSlotProps
interfaceScoped slot data injected into the #item slot of OrigamCommandPalette — provides the ICommand data and a boolean indicating whether the row is currently highlighted.
ICommandPaletteSlots
interfaceSlot contract of OrigamCommandPalette — provides three override points: a scoped #item slot per result row, a #empty slot for the no-results state, and a #footer slot below the list.
ILink
interfaceInternal return type of useLink — wraps vue-router's useLink return value with Origam-specific computed flags and a resolved href ref.
ILinkProps
interfaceNavigation props shared by any component that can act as a link — resolves to an anchor when href or to is set, button otherwise.
ITabPanelProps
interfaceProps for <OrigamTabPanel> — a single content panel paired with a tab. Uses group-item registration (value matching a sibling <OrigamTab>) and lazy mounting via ILazyProps.
ITabPanelsProps
interfaceProps for <OrigamTabPanels> — the content area mirroring the tablist selection. Supports direction, group registration, transition name and horizontal swipe navigation.
ITabProps
interfaceProps for <OrigamTab> — a single registered tab inside an <OrigamTabs> tablist. Supports optional leading icon and trailing appendIcon. ARIA wiring (role=tab, aria-selected, tabindex) is computed automatically.
ITabsProps
interfaceProps for <OrigamTabs> — a stateful tablist container. Supports variant (default/pills/underline), direction, density, rounded, color, group registration, fixed-width distribution and centered layout.
IUseLink
interfaceReturn type of the useLink composable — extends vue-router's useLink return (minus the raw href) with two additional computed flags: isLink and isClickable.
Navigation & Scroll
IGoToInstance
interfaceInternal service instance for useGoTo() — carries the reactive RTL flag and the resolved options used for smooth-scroll calculations.
IGoToOptions
interfaceConfiguration object for the useGoTo() smooth-scroll service — controls container, duration, offset, easing and named easing patterns.
IGoToOptionsPatterns
interfaceNamed easing function registry for the useGoTo() service — an open record where each key is an easing name and the value is a timing function mapping progress t ∈ [0,1] to an output value.
NumberField
NumberFormat
INumberFormatEmits
interfaceINumberFormatProps
interfaceProps for `<OrigamNumberFormat>` — pure-display i18n number renderer powered by `Intl.NumberFormat` (zero external dep). The component owns NO state: it transforms `value` through the resolved `Intl` instance and emits the result into a `<tag>` element (default `<span>`). Consumers who want to override the rendering granularly use the scoped `#default` slot which exposes `{ formatted, parts, value }`.
INumberFormatScopedSlotBindings
interfaceBindings exposed by the scoped `#default` slot. Consumers use these to highlight specific parts of the formatted output (currency symbol, decimal separator, …) without re-running `Intl.NumberFormat` themselves.
INumberFormatSlots
interfaceSlot signatures for `<OrigamNumberFormat>`.
Nuxt
IOrigamNuxtModuleOptions
interfaceOptions passed by a consumer in `nuxt.config.ts` under the `origam` key. All fields are optional — the module applies sensible defaults (see `DEFAULTS` in `src/nuxt/module.ts`). Themes are installed as runtime OBJECTS (ADR-004): the module passes the `themes` array straight through to the runtime config and on to `createOrigam` in the plugins, which inject each as a name×mode scoped `--origam-*` block. The theme-invariant `primitive` + `utilities` sheets are still loaded as CSS. Two orthogonal axes are resolved SSR-side to avoid FOUC: the brand `theme` (cookie) and the color `mode` (cookie + `Sec-CH-Prefers-Color-Scheme` hint). ADR-004 (Implemented): the DS ships exactly ONE neutral identity (the origam baseline). Brand themes live in the consuming app (e.g. the marketing package) and are passed here as `IOrigamTheme[]` objects authored in semantic JSON — the DS no longer resolves preset names or ships brand token sheets.
IOrigamNuxtRuntimeConfig
interfaceShape of the public runtime config exposed by the module on `useRuntimeConfig().public.origam`. The plugins read this at boot to install the theme objects, resolve the active theme/mode, and configure the cookies.
Overlay
IDialogConfirmationProps
interfaceProps for OrigamDialogConfirmation — a pre-wired dialog that shows Confirm and (optionally) Cancel buttons. Extends IDialogProps with a single cancellable flag that shows or hides the Cancel action.
IDialogEmits
interfaceEmits contract for OrigamDialog — extends the standard component emits and outside-click bubbling, and adds the isRead lifecycle hook that fires the first time the dialog body becomes fully visible (consent / ToS pattern).
IDialogProps
interfaceProps for OrigamDialog — the full-featured modal dialog. Extends overlay, card and status interfaces and adds fullscreen, focus retention, scroll-lock and size controls.
IOverlayEmits
interfaceEmits fired by `<OrigamOverlay>` — v-model on the open state, outside click, transition lifecycle hooks, and keyboard bubble.
IOverlayProps
interfaceIOverlayScrimEmits
interfaceEmits fired by `<OrigamOverlayScrim>` — click + pointer hover events surface to the parent overlay (so it can close on backdrop click or pause its auto-close timer while the pointer is over the scrim).
IOverlayScrimProps
interfaceIOverlayScrimSlots
interfaceIOverlaySlots
interface
Overlay & Feedback
IScrimProps
interfaceMinimal prop mixin that adds a backdrop/scrim control to overlay components. A boolean true shows the default semi-transparent backdrop; a string value is treated as a CSS color override for the scrim surface.
ISheetEmits
interfaceEmit signature for <OrigamSheet>. Two events drive the v-model surface: update:snap fires whenever a gesture or programmatic snapTo() call settles on a new snap-point id, and update:open fires on the closed/non-closed boundary so the parent stays in sync when the user dismisses via swipe-down.
Pagination
Parallax
IParallaxElementCicle
interfaceIParallaxElementEmits
interfaceIParallaxElementMovement
interfaceIParallaxElementProps
interfaceIParallaxElementSlots
interfaceIParallaxElementTypeProps
interfaceIParallaxEmits
interfaceIParallaxLayerEmits
interfaceIParallaxLayerProps
interfaceIParallaxLayerProvide
interfaceProvide context exposed by the enriched OrigamParallax to its `<OrigamParallaxLayer>` children. Distinct from the legacy `IParallaxProvide` consumed by `<OrigamParallaxElement>` (kept separate to avoid coupling the two APIs).
IParallaxLayerSlots
interfaceIParallaxSlots
interfaceIUseParallaxRuntimeOptions
interface
Picker
Plugin & Configuration
IOrigamOptions
interfaceRoot configuration bag passed to `createOrigam()`. Covers component aliases, icon adapter, display breakpoints, SSR, navigation, date adapter, locale/RTL, a11y contrast guard and runtime theme injection.
IOrigamPluginOptions
interfaceOptions bag for the Origam Nuxt / Vite plugin — controls how components and directives are auto-imported into the consuming application.
IOrigamPluginOptionsObject
interfaceFine-grained auto-import filter — an array of component or directive keys to exclude from automatic registration, allowing tree-shaking of unused Origam exports.
Progress
Provide / Inject
IStepperProvide
interfaceInjection contract provided by <OrigamStepper> to its OrigamStepperItem children. Exposes the active step ref, orientation, clickability flag, and inherited color for child coordination.
ITabPanelsProvide
interfaceContext provided by <OrigamTabPanels> to descendant panels — exposes the active transition name and the reversed-direction flag so each panel can animate correctly without re-declaring props.
Scroll
IScrollArguments
interfaceArguments bag passed into scroll-behaviour handler functions. Provides a reactive ref indicating whether the target element can currently scroll, allowing behaviours to guard against no-op updates.
IScrollProps
interfaceScroll-aware behaviour props for AppBar and similar layout components. Declares the scroll target, threshold and a space-separated list of behaviours (hide, collapse, elevate, fade-image, inverted).
IScrollStrategyData
interfaceRuntime data bag passed to every TScrollStrategyFn. Gives the strategy access to the overlay root element, content element, positioning target, active state flag and the update-location callback to recompute floating position.
IScrollStrategyProps
interfaceOverlay scroll-strategy props. Extended by Overlay, Tooltip and related components to let consumers choose how the floating panel reacts when the page or its ancestor container scrolls.
Select
Sheet
Skeleton
SliderField
Slots
IAdjacentInnerSlots
interfaceSlot signatures for content rendered inside the input chrome — leading edge, trailing edge, and the clear action.
IAdjacentSlots
interfaceSlot signatures for outer prepend and append content — replaces the icon/avatar props with arbitrary markup.
IAudioScopedSlotBindings
interfaceBindings handed to the #controls scoped slot of <OrigamAudio>. State is exposed as plain unwrapped values (snapshot at render time) — Vue reactive re-invokes the slot on every meaningful change.
IAudioSlots
interfaceSlot signatures for <OrigamAudio>. Provides override points for the metadata strip, cover image, title, waveform canvas, transport controls, loading overlay and error overlay.
IBlockquoteSlots
interfaceSlot signatures for <OrigamBlockquote>. The default slot owns the citation body; author and source are optional overrides for custom rendering. When a slot is provided it wins over the matching prop.
ICalendarDaySlotBindings
interfaceBindings handed to the #day slot of <OrigamCalendar> — one object per cell in month view, providing the date and its contextual flags (today, past, outside month, weekend, disabled).
ICommonsComponentSlots
interfaceDefault slot signature shared by container components. Provides the optional default slot returning any renderable content.
IFieldDefaultSlotProps
interfaceShape of the slot props injected into the default slot of OrigamField — exposes the id, aria-describedby, active/focused state, ref and focus handlers so inner input elements can wire up correctly.
IFieldSlots
interfaceSlot signatures for OrigamField — default slot for the inner input element, plus label, floating label, prefix, suffix and loader slots.
IFileFieldDragNDropItemSlots
interfaceSlot contract for the drag-and-drop file card — exposes a single default slot for fully custom card content.
IFileFieldListItemSlots
interfaceSlot contract for the file-field list-item row — exposes a default slot to override the entire row content.
IFileFieldSlots
interfaceSlot signatures for OrigamFileField — extends IFieldSlots and IInputSlots with file-specific slots: counter, field, dropzone, item, chip and selection.
IFormSlots
interfaceSlot signatures for OrigamForm — extends ICommonsComponentSlots with messages, message, and actions slots for custom footer controls.
IInlineEditActionsSlotBindings
interfaceScoped slot bindings exposed by the #actions slot of OrigamInlineEdit — provides confirm/cancel callbacks and a pending flag for rendering custom action buttons.
IInlineEditDisplaySlotBindings
interfaceScoped slot bindings exposed by the #display slot of OrigamInlineEdit — provides the current value, an edit trigger, empty/placeholder state, and the disabled flag.
IInlineEditEditSlotBindings
interfaceScoped slot bindings exposed by the #edit slot of OrigamInlineEdit — gives full control over the input layout while delegating state-machine logic to the component.
IInlineEditSlots
interfaceSlot signatures for OrigamInlineEdit — three optional scoped slots: #display for the read affordance, #edit for the input layout, and #actions for confirm/cancel buttons.
IMediaControllerSlots
interfaceScoped slots exposed by <OrigamMediaController>. Consumers inject media-specific blocks: OrigamAudio injects header + waveform + footer; OrigamVideo injects captions/PiP/fullscreen through extraControlsRight.
ISwitchTrackSlots
interfaceSlot signatures for <OrigamSwitchTrack> — exposes track.true and track.false half-label slots plus an overlay slot for absolute-positioned decorations (e.g. a loading bar).
ISwitchTrackSlotsProps
interfaceSlot payload forwarded to the track.true, track.false and overlay slots of <OrigamSwitchTrack> — provides model (ON/OFF) and isValid so slot content can adapt contextually.
ITextFieldSlots
interfaceSlot signatures for <OrigamTextField> — extends field and input slots with a counter slot for custom counter markup and a field slot to fully replace the field surface.
ITextMaskSlots
interfaceSlot signatures for <OrigamTextMask> — a single default slot that accepts arbitrary markup (multiple lines, nested elements). The slot wins over the text prop when provided.
Snackbar
State & Interaction
IActivatorProps
interfaceContract for components that open/close a floating surface via an activator element — includes pointer, hover, focus and context-menu triggers plus open/close delays.
IActiveProps
interfaceControls the active/selected state of a component — accepts a boolean to force the state on, or an IActiveState object to override visual props (color, bgColor, border…) only while the state is engaged.
IAutocompleteProps
interfaceProps controlling the autocomplete / combobox behaviour — search text, delimiters, auto-select and clear-on-select.
ITextareaRichActiveState
interfaceReactive state describing which rich-text toolbar commands are currently active at the caret position. Used by the toolbar to render aria-pressed state and the visual active class.
IWindowEmits
interfaceEmits contract for <OrigamWindow> — inherits the v-model update and commons lifecycle events from ICommonsComponentEmits.
IWindowItemEmits
interfaceEmits contract for <OrigamWindowItem> — inherits group membership lifecycle events (selected/deselected) from IGroupEmits.
IWindowProvide
interfaceInternal provide contract injected by <OrigamWindow> into its WindowItem children — exposes the active transition name, slide count, height, direction and root ref for coordinated animations.
Stepper
Switch
SystemBar
Tabs
TextMask
TextareaField
Theme
IOrigamTheme
interfaceRuntime theme object ingested by `createOrigam({ themes })`. At install time the DS resolves it to a block of `--origam-*` CSS variables injected into `<head>`, scoped to `:root` (or `[data-theme="<name>"]` when `name` is set, optionally narrowed by `[data-mode]` when `mode` is set). ## A theme has exactly THREE authoring surfaces 1. **`vars`** — the design tokens (the normal path). Plain nested JSON keyed by token GROUP (`color` / `rounded` / `border` / `typo` / `shadow` / `spacing` / `motion`). No `--origam-*` prefixes, no DTCG ceremony: the DS walks each tree and derives the CSS-variable name from the leaf path, so a hand-written theme resolves to the EXACT same `--origam-*` names as the published token sheets. 2. **`cssVars`** — the escape hatch. A flat map of raw `--origam-*` custom properties, for the rare var that has no group slot in `vars`. 3. **`component`** — per-component DEFAULT PROPS (not CSS): `{ global, 'origam-btn', … }`. ```ts { name: 'sobre', mode: 'light', label: 'Sobre', vars: { color: { surface: { default: '#ffffff' }, text: { primary: '#171717', secondary: '#525252' }, action: { primary: { bg: '#7c3aed', fg: '#ffffff' } } }, rounded: { md: '10px', lg: '14px' }, typo: { family: { sans: 'Inter, sans-serif' } }, shadow: { md: '0 2px 8px rgba(0,0,0,.12)' } }, component: { 'origam-btn': { variant: 'flat', color: 'primary' } } } ``` A COLOR slot accepts any CSS color OR a gradient (a gradient is an ordinary color value). Everything is plain JSON so a Theme Builder export round-trips without loss.
IOrigamThemeSingletonState
interface
Theme & Defaults
IDefault
interfaceShape of the defaults map consumed by OrigamDefaultsProvider and the createOrigam theme component layer. Keys are "global" (applies to every component) or a component kebab-case name (e.g. "origam-btn"). Values are plain prop records.
IDefaultProviderProps
interfaceProps for OrigamDefaultsProvider — a structurally transparent wrapper that injects per-component prop defaults into a subtree. Supports disabled pass-through, reset/root scoping and fully scoped isolation.
IDefaultProviderSlots
interfaceSlot contract for OrigamDefaultsProvider. The component renders no visible chrome — its only slot is default, which carries the subtree that inherits the injected defaults.
Timeline
Tooltip
Touch & Gesture
ITouchData
interfaceTouch coordinate snapshot passed to every v-touch handler — records start, move, and end positions plus the X/Y offset deltas.
ITouchDirectiveBinding
interfaceVue directive binding for v-touch — extends Vue's DirectiveBinding (minus the value slot) with the typed ITouchValue payload.
ITouchHandlers
interfaceNamed callback map for the v-touch directive — one optional handler per lifecycle event (start, end, move) and per swipe direction (left, right, up, down).
ITouchStoredHandlers
interfaceInternal store of raw DOM event listeners attached by the v-touch directive — kept on the element so they can be correctly removed on directive unmount.
ITouchValue
interfaceThe binding value accepted by the v-touch directive — extends ITouchHandlers with optional parent-element delegation and addEventListener options.
Transition
Treeview
Utilities
ICommonsComponentProps
interfaceBase prop contract shared by most Origam components. Provides id, class, and style pass-through so consumers can always decorate the root element.
IConfigurableDocument
interfaceAllows injecting a custom document reference — useful for iframes, shadow DOM, or SSR environments where the global document may not be available.
IHTMLExpandElement
interfaceExtended HTMLElement interface used internally by the expand transition utilities — stores the initial style snapshot and the parent reference so the transition can be cleanly reversed.
IStyleTagOptions
interfaceOptions bag for the useStyleTag composable — controls media query, immediate injection, manual mode, and the DOM id of the injected <style> element.
Utilities & Internals
IFilterPropsOptions
interfaceGeneric utility interface — binds a props options descriptor to its extracted Props type and provides a filterProps() helper that strips props not belonging to a given sub-component. Used internally by useProps().
IResizeState
interfaceReturn shape of the `useResizeObserver` composable — a ref to the observed element and a deep-readonly ref to its most recent `DOMRectReadOnly` measurements.