APItypes.
Every TypeScript type and enum used across origam props. Fully documented with definitions, accepted values and cross-references to the components that use them.
515 types and enums across 113 categories
BROWSE BY CATEGORY
All types.
Alert
Animation & Motion
Animation & Transition
Badge
Blockquote
BottomNav
Bracket
TBracketBorder
typeTBracketBorderProps
typeTBracketColor
typeTBracketConnectorPath
typeTBracketDirection
typeTBracketDoubleSection
typeTBracketElevation
typeTBracketMatchStatus
typeTBracketRoundSide
typeTBracketRounded
typeTBracketRoundedProps
typeTOrigamBracket
typeTOrigamBracketCompetitor
typeTOrigamBracketMatch
typeTOrigamBracketRound
type
Calendar
Chart
TChartHoneycombColorMode
typeTChartHoneycombOrientation
typeTChartItem
typeTChartMapMode
typeTChartPictorialMode
typeTChartPolarKind
typeTChartPyramidKind
typeTChartRovingAction
typeTChartSankeyLinkSpec
typeTChartSparklineKind
typeTChartStreamgraphOffset
typeTChartSunburstLabelMode
typeTChartTreemapAlgorithm
typeTChartWordCloudRawDatum
typeTChartWordCloudRotation
typeTOrigamChart
typeTOrigamChartAxis
typeTOrigamChartBoxPlot
typeTOrigamChartBullet
typeTOrigamChartCandlestick
typeTOrigamChartCartesian
typeTOrigamChartGauge
typeTOrigamChartHeatmap
typeTOrigamChartHoneycomb
typeTOrigamChartLegend
typeTOrigamChartMap
typeTOrigamChartPareto
typeTOrigamChartPictorial
typeTOrigamChartPolar
typeTOrigamChartPolarBar
typeTOrigamChartPyramid
typeTOrigamChartRadar
typeTOrigamChartRangeSelector
typeTOrigamChartSankey
typeTOrigamChartSparkline
typeTOrigamChartStreamgraph
typeTOrigamChartSunburst
typeTOrigamChartTooltip
typeTOrigamChartTreemap
typeTOrigamChartVariwide
typeTOrigamChartWordCloud
typeTPathPoint
type
ClientOnly
Clipboard
Code
CodeGroup
Color & Intent
TColor
typeAccepted value for color/bgColor/textColor props — intent name, raw CSS color, gradient string or structured gradient object.
THSVA
typeStructured hue-saturation-value-alpha color object used internally by OrigamColorPicker as its canonical color model. All color format conversions (HEX, RGBA, HSLA) go through THSVA as the pivot.
TIntent
typeSemantic intent values: neutral, primary, secondary, ghost, success, warning, danger, info.
ColorPicker
ColorPickerField
CommandPalette
Commons
TActivatorTarget
typeTAdapter
typeTAlign
typeTAnchor
typeTAnyString
typeTAppendDefault
typeTAxis
typeTBackdropBlur
typeTBgFgRole
typeTBlockStartEnd
typeTBorderLogicalAxis
typeTBorderStyle
typeTBorderWidthKeyword
typeTBreakpoint
typeTCalendarStrategy
typeTClientPosition
typeTColorType
typeTControlLoaderConfig
typeTControlLoadingValue
typeTControlsSource
typeTCssFeatureName
typeTCssSupportMap
typeTCustomDateFormat
typeTDimensions
typeTDirectionBoth
typeTDisplayThresholds
typeTElementPoint
typeTElevation
typeTEventHandler
typeTEventListenerTarget
typeTEventProp
typeTFilterFunction
typeTFilterKeyFunctions
typeTFilterKeys
typeTFilterMatch
typeTFilterMode
typeTFn
typeTFocusLocation
typeTFontFamily
typeTFontSize
typeTFontWeight
typeTHSLA
typeTHex
typeTHoverEvent
typeTIfAny
typeTInferPropType
typeTInline
typeTInlineStartEnd
typeTInnerVal
typeTInstalledThemes
typeTInternalAdapter
typeTJustify
typeTKeyboardModifiers
typeTLAB
typeTLetterSpacing
typeTLineHeight
typeTLoaderConfig
typeTLoaderKind
typeTLocationStrategy
typeTLocationStrategyFn
typeTLogicalCorner
typeTLogicalSide
typeTMaybePick
typeTMergeDefault
typeTModeResolved
typeTNavMode
typeTNestedProvide
typeTNotAUnion
typeTObserveHandler
typeTOffset
typeTOmitPrefix
typeTOmitProps
typeTOpacity
typeTOpenSelectStrategyFn
typeTOpenStrategy
typeTOpenStrategyFn
typeTOpenStrategyFns
typeTOrigamPluginOptionsImport
typeTParsedAnchor
typeTPartialKeys
typeTPoint
typeTRGBA
typeTRippleEvent
typeTRoundedToken
typeTSSROptions
typeTScrollStrategyFn
typeTSelectStrategy
typeTSelectStrategyFn
typeTSelectStrategyTransformInFn
typeTSelectStrategyTransformOutFn
typeTSemanticLeaf
typeTSortDirection
typeTStartEnd
typeTStateEffectProps
typeTStateName
typeTStatusPosition
typeTStrategyOpen
typeTStrategySelect
typeTTemplateRef
typeTTextAlign
typeTTextTransform
typeTThemeResolved
typeTThemeVars
typeTTokenName
typeTTouchEvent
typeTTouchWrapper
typeTUnionToIntersection
typeTVModel
typeTValidationRule
typeTValidationRuleResult
typeTValueOf
typeTVariantInput
typeTVariantPresetRegistry
typeTVariantPresetTable
typeTVariantPresets
typeTViewportPoint
typeTWrapInArrayResult
typeTXYZ
type_TNotAUnion
type
ConfirmWrapper
ContextualMenu
Counter
Data & Selection
Data Display
TBracketVariant
typeTournament bracket topology: single-elimination tree, double-elimination with winners/losers brackets, or round-robin matrix.
TCardType
typeLayout variant for a Card used inside a collection: grid (fixed-size tiles) or list (full-width rows).
TChartCartesianKind
typeCartesian chart topology accepted by OrigamChartCartesian — a narrowed subset of TChartType covering only X/Y axis visualisations.
TChartLegendPosition
typeAnchor position of the legend block inside a chart — the plotting area shrinks or grows to accommodate the legend on the chosen side.
TChartSmoothing
typePath interpolation strategy for line, area and spline charts — controls how segments are drawn between consecutive data points.
TChartStacking
typeStacking strategy for bar, column and area charts — controls whether series are stacked by absolute values or normalised to 100 %.
TChartType
typeUnion of all visualisation primitives accepted by OrigamChart — selects the topology and path generator at runtime.
TCodeLang
typeSyntax-highlighting language identifiers supported by OrigamCode — a curated subset of shiki grammars bundled with the design system.
TColorModes
typeColour encoding mode for the OrigamChartHoneycomb component — selects whether cells are painted by category or by a continuous heatmap scale.
TIcon
typeAccepted value for any icon prop across the design system — a string glyph name, a multi-path SVG array, or a Vue component.
TKbdVariant
typeVisual style of the OrigamKbd keyboard key badge — filled, outlined, or tonal.
TReferrerPolicy
typeEnum-derived union of all standard Referrer-Policy header values accepted by the referrerpolicy prop on OrigamImg — controls what information is sent in the Referer header when the browser fetches the image.
TTextMaskAnimation
typeAnimation strategy applied to the background painted under the background-clip: text mask in OrigamTextMask. Every strategy respects prefers-reduced-motion.
TTimelineOrientation
typeLayout axis of the OrigamTimeline — vertical (top-to-bottom) or horizontal (left-to-right).
TTreeviewSelectMode
typeSelection cardinality of the OrigamTreeview — controls whether zero, one or many nodes can be selected at the same time.
TTreeviewSelectableNodes
typeWhich nodes in the OrigamTreeview can receive a selected state — only leaf nodes or every node in the tree.
DataTable
TDataTableCell
typeTDataTableCompareFunction
typeTDataTableHeaderCell
typeTDataTableHeaderColumnSlotName
typeTDataTableItemColumnSlotName
typeTDataTableRow
typeTDataTableRowSlotName
typeTDataTableRowsSlotName
typeTDataTableSelectStrategy
typeTOrigamDataTable
typeTOrigamDataTableColumnCell
typeTOrigamDataTableFooter
typeTOrigamDataTableGroupHeaderRow
typeTOrigamDataTableHeaderCell
typeTOrigamDataTableHeaders
typeTOrigamDataTableHeadersCell
typeTOrigamDataTableHeadersCellMobile
typeTOrigamDataTableRow
typeTOrigamDataTableRows
type
DatePicker
DatePickerField
DefaultsProvider
Divider
Drawer
EmptyState
ExpansionPanel
Feedback & Status
TSkeletonVariant
typeShape primitive for OrigamSkeleton loading placeholders — the bricks a component composes (inside an OrigamSkeletonGroup) to mimic its own anatomy.
TSnackbarGroupDirection
typeStacking direction for OrigamSnackbarGroup — controls whether new items are appended at the top or bottom of the visible list.
TSnackbarGroupLocation
typeViewport anchor location for OrigamSnackbarGroup — two-keyword strings describe a corner, single keywords describe an edge with horizontal centering.
Field
Form
Form & Input
TFile
typeModel-value type for <OrigamFileField>. Accepts a single File object, an array of File objects, or null when no file is selected.
TFileFieldDisplay
typeControls how a multi-file selection is rendered inside <OrigamFileField>.
TFileSize
typeControls whether and how file sizes are displayed in <OrigamFileField>. Accepts a boolean toggle or a numeric unit divisor (1000 for SI units, 1024 for binary units).
TSliderFieldVariant
typeVisual and behavioural variant of OrigamSliderField — full form-field chrome, bare video-scrubber, or waveform-backed audio scrubber.
TTextareaMode
typeRender mode for OrigamTextareaField — plain keeps the legacy textarea element while rich swaps it for a contenteditable surface with formatting support.
TTextareaOutput
typeOutput format of the rich-text textarea — controls how the editor DOM is serialised back into the v-model string.
TTextareaToolbarCommand
typeIdentifiers for every rich-text toolbar command — drives the toolbar contract, the format emit payload and the keyboard shortcut map.
TTextareaToolbarPosition
typeWhere the rich-text toolbar is rendered relative to the editable surface.
TValidateOn
typeControls when field-level validation rules are evaluated — on blur, on input, on form submit, or a lazy variant of each.
Grids
Icon
InfiniteScroll
Input
Interaction & State
TEmptyStatePreset
typeVisual presets for <OrigamEmptyState>. Each preset bundles a default icon and intent so consumers do not need to wire those by hand for the common cases.
TLoadingValue
typeLoading prop value — boolean (on/off), number (percentage), or structured loader config object.
TMode
typeDisplay mode for BottomNav: horizontal, vertical, or shift.
TStatus
typeFeedback status values: success, info, warning, error.
Kbd
Label
Layout
Layout & Sizing
TBottomNavPosition
typeHorizontal alignment of the bottom navigation bar when it does not span the full width.
TCols
typeColumn span value for OrigamCol — accepts a numeric 1–12 grid column count, "auto" (content-sized), or true (fill remaining space).
TDensity
typeVertical spacing density: default, compact, comfortable.
TDirection
typeAxis direction: horizontal or vertical.
TDisplayLevel
typeResponsive breakpoint threshold prop — accepts a named breakpoint key or a raw pixel width, below which the component switches to its mobile behaviour.
TEmptyStateAlign
typeHorizontal alignment of the icon, title, description and actions stack inside <OrigamEmptyState>.
TEmptyStateSize
typeVertical density of <OrigamEmptyState>. Drives icon size, title/description font sizes, gap and padding via per-size token overrides.
TFlexDirection
typeCSS flex-direction values accepted by <OrigamRow> and other flex containers. Drives the direction child items flow along the main axis.
TGridAutoFlow
typeClosed list of CSS grid-auto-flow values surfaced by OrigamGrid — controls how implicit tracks are filled when items overflow the explicit template.
TGridGapSize
typeNamed gap size tokens for OrigamGrid: xs, sm, md, lg, xl.
TGridPlaceContent
typeShorthand alignment for the full grid track set inside its container (align-content + justify-content) — mirrors the CSS Box Alignment matrix used by OrigamGrid.
TGridPlaceItems
typeShorthand alignment applied to every item within its grid cell (align-items + justify-items). baseline is excluded because it has no meaningful semantics when items span rows or columns.
TGridPlaceSelf
typePer-item override of cell alignment (align-self + justify-self) on a GridItem — same value set as TGridPlaceItems but applied to a single item rather than the entire grid.
TLines
typeNumber of lines of text a list item subtitle can occupy before being truncated — controls the vertical density of OrigamList and OrigamListItem.
TMasonryAlign
typeVertical alignment of items inside a masonry column — top (Pinterest-style, default) or center. Only observable in the JS fallback path; the CSS-native masonry path always aligns to top.
TPosition
typeCSS position value accepted by the position prop on many Origam components — maps directly to the CSS position property.
TSize
typeComponent size scale: x-small, small, default, large, x-large.
Lazy
List
Loader
Main
Masonry
Media
TAudioControls
typeControls rendering strategy for OrigamAudio — custom Origam UI or native browser controls.
TAudioLoopMode
typeTri-state loop strategy for OrigamAudio when a playlist is active.
TAudioVariant
typeVisual variant of OrigamAudio — expanded studio strip or compact transport dock.
TCoverPosition
typeSide of the audio surface where the album cover is painted relative to the controller and metadata column in OrigamAudio.
TCrossOrigin
typeCORS mode for cross-origin media requests — mirrors the native crossorigin attribute on <img>, <video> and <audio> elements.
TMediaScrubberOrientation
typeTOrigamMediaController
typeTOrigamMediaScrubber
typeTOrigamMediaVolumeControl
typeTQualityOption
typeTVideoControls
typeControls rendering strategy for OrigamVideo — custom Origam UI, native browser controls, or no controls at all.
Menu
Messages
Misc
Navigation
TBreadcrumbItem
typeShape of an item in the Breadcrumb items array — either a plain string label or a partial props object for full control.
TInfiniteScrollSide
typeWhich end(s) of the scroll container trigger the load event in OrigamInfiniteScroll — start, end, or both simultaneously.
TScrollStrategy
typeBehaviour of a floating element (Overlay, Dialog, Tooltip, Menu) when the user scrolls the page while it is open — none, close, block or reposition.
TStepperItemStatus
typeLifecycle status of a single step inside OrigamStepper — drives the step icon, colour and interactive affordances.
Navigation & Routing
NumberField
NumberFormat
OtpInputField
Pagination
Parallax
RatingField
Responsive
Select
SelectionControl
Shape & Appearance
TBlockquoteVariant
typeVisual typographic variants for OrigamBlockquote — five self-contained treatments from neutral to editorial.
TRounded
typeCorner-radius variant tokens — x-small through x-large plus shaped and shaped-invert.
TVariant
typeVisual surface variant for elevation-driven components: text, flat, elevated, tonal, outlined, plain, ghost.
Slide
SystemBar
Table
TextField
TextMask
ThemeProvider
Time & Calendar
TCalendarNavigate
typeNavigation direction for the calendar toolbar and the navigate event: move to the previous period, next period, or jump to today.
TCalendarTimeFormat
typeClock format for time labels in week, day, and agenda views: 24-hour (00:00–23:59) or 12-hour with AM/PM.
TCalendarView
typeCalendar display mode: month, week, day, or agenda.
TDateMode
typeDatePicker view mode: month (day grid), months (month selector), or years (year list).
Title
Tooltip
Transition
TOrigamExpandX
typeTOrigamExpandY
typeTOrigamFade
typeTOrigamReverseTranslatePicker
typeTOrigamScaleRotate
typeTOrigamSlideX
typeTOrigamSlideY
typeTOrigamSnack
typeTOrigamTransition
typeTOrigamTranslateBottom
typeTOrigamTranslatePicker
typeTOrigamTranslateScale
typeTOrigamWindowXReverseTranslate
typeTOrigamWindowXTranslate
typeTOrigamWindowYReverseTranslate
typeTOrigamWindowYTranslate
typeTTransitionProps
type