APIconstantes.
Chaque constante SCREAMING_SNAKE_CASE exportée par origam. Entièrement documentée avec ses définitions, ses valeurs et des références croisées vers les parties du DS qui les utilisent.
447 constantes réparties dans 67 catégories
PARCOURIR PAR CATÉGORIE
Toutes les constantes.
Audio
Blockquote
Calendar
Chart
CHART_ANIMATION_DURATION_DEFAULT
constCHART_ANNOTATION_ARROWHEAD_MIN_SIZE
constCHART_ANNOTATION_ARROWHEAD_PRECISION
constCHART_ANNOTATION_ARROWHEAD_SPREAD
constCHART_ANNOTATION_ARROWHEAD_WIDTH_FACTOR
constCHART_ANNOTATION_DEFAULT_DY
constCHART_ANNOTATION_DEFAULT_RADIUS
constCHART_ANNOTATION_DEFAULT_WIDTH
constCHART_ANNOTATION_LABEL_CHAR_WIDTH
constCHART_ANNOTATION_LABEL_HEIGHT
constCHART_ANNOTATION_LABEL_MIN_WIDTH
constCHART_ANNOTATION_LABEL_PADDING
constCHART_ASPECT_RATIO
constCHART_AXIS_LABEL_CHAR_WIDTH
constCHART_AXIS_LABEL_MIN_GAP
constCHART_BAR_SLOT_FILL_RATIO
constCHART_COLOR_FALLBACK
constCHART_DASH_ARRAY_DASHED
constCHART_DASH_ARRAY_DOTTED
constCHART_DASH_ARRAY_SOLID
constCHART_DEFAULT_PALETTE
constCHART_EPSILON
constCHART_GAUGE_DEFAULT_END_ANGLE
constCHART_GAUGE_DEFAULT_START_ANGLE
constCHART_GAUGE_DEFAULT_THICKNESS
constCHART_GAUGE_MIN_THICKNESS
constCHART_GAUGE_RADIUS_INSET
constCHART_GAUGE_RATIO_EPSILON
constCHART_GAUGE_SPAN_EPSILON
constCHART_NICE_STEP_LADDER
constCHART_PERCENT_MAX
constCHART_PERCENT_MIN
constCHART_PERCENT_TICK_STEP
constCHART_PIE_MIN_RADIUS
constCHART_PIE_RADIUS_INSET
constCHART_PLOT_BAND_DEFAULT_OPACITY
constCHART_PLOT_LINE_DEFAULT_WIDTH
constCHART_PLOT_LINE_LABEL_OFFSET
constCHART_PLOT_LINE_LABEL_TOP_OFFSET
constCHART_POINT_ATTR
constCHART_POINT_MARKER_RADIUS
constCHART_POINT_SELECTOR
constCHART_RADAR_MARKER_RADIUS
constCHART_RADAR_MIN_RADIUS
constCHART_RADAR_RADIUS_INSET
constCHART_ROVING_KEY_ACTIONS
constCHART_SCATTER_DEFAULT_RADIUS
constCHART_SCATTER_MAX_RADIUS
constCHART_SCATTER_MIN_RADIUS
constCHART_SERIES_ATTR
constCHART_SIZE_FALLBACK
constCHART_SLICE_LABEL_PREFIX
constCHART_SVG_ROLE
constCHART_TICK_LABEL_PRECISION_FACTOR
constCHART_ZOOM_MIN_VISIBLE_CATEGORIES
constCHART_ZOOM_RESET_GAP
constCHART_ZOOM_RESET_MIN_WIDTH
constCHART_ZOOM_RESET_PADDING_X
constCHART_ZOOM_WHEEL_STEP
constPICTORIAL_ICON_BEER_MUG
constSVG path d string for a beer mug shape, sized to fit a viewBox="0 0 24 24" coordinate system. Typical use case: beer consumption per capita demos in OrigamChartPictorial.
PICTORIAL_ICON_DOLLAR
constSVG path d string for a dollar / currency symbol shape, sized to fit a viewBox="0 0 24 24" coordinate system. Use it as the icon prop of OrigamChartPictorial for financial or revenue data series.
PICTORIAL_ICON_HEART
constSVG path d string for a heart / favourite shape, sized to fit a viewBox="0 0 24 24" coordinate system. Use it as the icon prop of OrigamChartPictorial for health or engagement data series.
PICTORIAL_ICON_HOUSE
constSVG path d string for a house / home shape, sized to fit a viewBox="0 0 24 24" coordinate system. Use it as the icon prop of OrigamChartPictorial for housing-related data series.
PICTORIAL_ICON_PERSON
constSVG path d string for a human silhouette shape, sized to fit a viewBox="0 0 24 24" coordinate system. Default icon for OrigamChartPictorial when no icon prop is provided.
PICTORIAL_ICON_STAR
constSVG path d string for a five-pointed star / rating shape, sized to fit a viewBox="0 0 24 24" coordinate system. Use it as the icon prop of OrigamChartPictorial for rating or performance data series.
Chart & Map
WORLD_GEOGRAPHIC_DATA
constMulti-polygon geographic data in WGS-84 (lng, lat) degrees. Keys are ISO-3166-1 alpha-2 codes; values are arrays of closed rings. Covers 58 countries with 1-2 decimal-place precision (~1-11 km accuracy). Source file: 1815 lines.
WORLD_MAP_PATHS
constSimplified Mercator-projected SVG path strings on a 1000 x 500 canvas. Keys are ISO-3166-1 alpha-2 country codes; values are SVG "d" attribute strings. Covers 31 countries across 6 regions.
Code
Color
CIELAB_FORWARD_TRANSFORM
constCIELAB forward transfer function f(t). Converts a linearised XYZ tristimulus value to the CIE L*a*b* cube-root compressed domain. Threshold determined by COLOR_DELTA (6÷29).
CIELAB_REVERSE_TRANSFORM
constCIELAB reverse transfer function f⁻¹(t). Converts a CIE L*a*b* cube-root-compressed value back to a linearised XYZ tristimulus. Threshold determined by COLOR_DELTA (6÷29).
COLOR_ACTIVE_MIX_PCT
constPercentage of black mixed into the rest-state background color to produce the active (pressed) state. Used as a math-fallback when the designer-tuned bgActive token is absent.
COLOR_DELTA
constCIE delta constant (6÷29 ≈ 0.2069) used as the threshold and scaling factor in CIELAB_FORWARD_TRANSFORM and CIELAB_REVERSE_TRANSFORM. Derived from the 6/29 ratio defined in the CIE 1976 standard.
COLOR_DELTA_Y_MIN
constMinimum luminance delta (Y) for APCA contrast math. Values below this threshold are clamped to avoid division-by-zero in the contrast-ratio pipeline.
COLOR_HOVER_MIX_PCT
constPercentage of black mixed into the rest-state background color to derive the hover surface. Used as math fallback when no designer-tuned bgHover token exists.
COLOR_INTENTS
constRuntime Set of every semantic intent recognised by useColorEffect and useColor. Keep in sync with TIntent — adding an intent there must also add the literal here so the isIntent type guard works at runtime.
COLOR_MAPPERS
constRecord of parser functions keyed by CSS color-function name (rgb, rgba, hsl, hsla, hsv, hsva). Each function converts its channel arguments into an RGBA object, normalising via HSLtoRGB or HSVtoRGB where needed.
COLOR_NULL
constDefault HSV color object used as the initial / empty state of OrigamColorPicker. Represents opaque black (h=0, s=0, v=0, a=1).
COLOR_PICKER_MODES
constRecord of IColorPickerMode descriptors keyed by format string. Each mode defines the input fields, channel constraints, and to/from conversion functions used by OrigamColorPicker to render and parse the selected color format.
COLOR_UTILITY_INTENTS
constSubset of COLOR_INTENTS for which a global utility class is shipped in origam-utilities.css. ghost is intentionally excluded because its transparent surface cannot be expressed by a single static utility class.
CSS_COLOR_REGEX
constRegular expression that matches CSS functional color notations such as rgb(), rgba(), hsl() and hsla(). Captures two named groups: fn (the function name) and values (the comma-separated channel arguments). Used by parseColor to dispatch to the right COLOR_MAPPERS entry.
CSS_NAMED_COLORS
constSet of the 148 CSS named colors plus the CSS-wide keywords (transparent, currentColor, inherit, initial, unset, revert). Used by isCssColor so consumers can pass color names like "red" or "transparent" directly without going through hex or rgb notation.
GCO
constGreen channel coefficient (0.7151522) used in the luminance formula of the APCA contrast algorithm. One of the three sRGB-to-luminance weights alongside RCO (0.2126729) and BCO (0.0721750).
Color & A11y
RCO
constRed channel luminance coefficient (0.2126729) in the sRGB-to-relative-luminance formula (WCAG 2.x). Used with GCO and BCO by color utilities to compute contrast ratios and APCA lightness.
REV_BG
constAPCA reverse (white-on-dark) background soft-clamp threshold (0.62). Applied in the APCA contrast algorithm when a dark background is paired with a light foreground to normalise the perceptual contrast score.
REV_TXT
constAPCA reverse (white-on-dark) text soft-clamp exponent (0.57). Applied in the APCA contrast algorithm to the light foreground luminance when computing contrast against a dark background.
Color & Contrast
BCO
constBlue channel luminance coefficient used in the WCAG relative-luminance formula (IEC 61966-2-1). Combined with RCO and GCO to compute perceptual luminance from linearised RGB values.
BLK_CLMP
constSoft-clamp factor applied to near-black values in the APCA contrast algorithm. Prevents the luminance of very dark colours from reaching absolute zero, which would produce infinite contrast ratios.
BLK_THRS
constBlack-clamp threshold used in the APCA contrast algorithm. Luminance values below this threshold are soft-clamped with BLK_CLMP to avoid division-by-zero and infinite-contrast artefacts.
LO_CON_OFFSET
constOffset applied to low-contrast APCA calculations to prevent clamping near zero. Part of the SAPC/APCA perceptual contrast algorithm used by useContrast.
LO_CON_THRESH
constThreshold below which an APCA contrast value is considered too low to be meaningful and is clamped to zero. Part of the SAPC/APCA perceptual contrast algorithm used by useContrast.
MAIN_TRC
constGamma exponent (Tone Response Curve) for the sRGB linearisation used in APCA contrast calculations. The value 2.4 is the IEC 61966-2-1 standard exponent for sRGB.
NORM_BG
constAPCA normalisation exponent for background luminance. Used in the SAPC/APCA perceptual contrast algorithm to scale the background term before computing the signed contrast difference.
NORM_TXT
constAPCA normalisation exponent for text luminance. Used in the SAPC/APCA perceptual contrast algorithm to scale the text-colour term before computing the signed contrast difference.
Color & Theming
SCALE_B_O_W
constAPCA contrast scaling factor applied when the text is dark on a white background (Black On White). Used by the APCA-based contrast utility in `color.util.ts`.
SCALE_W_O_B
constAPCA contrast scaling factor applied when the text is light on a dark background (White On Black). Used by the APCA-based contrast utility in `color.util.ts`.
SRGB_FORWARD_MATRIX
constXYZ-to-sRGB linear transformation matrix (3×3) used in the color pipeline to convert CIE XYZ tristimulus values to linear sRGB channel values before gamma expansion via SRGB_FORWARD_TRANSFORM.
SRGB_FORWARD_TRANSFORM
constsRGB gamma-expansion function (linear → sRGB encoded). Applies the IEC 61966-2-1 piecewise formula: values ≤ 0.0031308 are linearised as C × 12.92; values above use the power-curve branch 1.055 × C^(1/2.4) − 0.055.
SRGB_REVERSE_MATRIX
constsRGB-to-XYZ linear transformation matrix (3×3) used in the color pipeline to convert linear sRGB channel values to CIE XYZ tristimulus values. Paired with SRGB_REVERSE_TRANSFORM for the sRGB → XYZ direction.
SRGB_REVERSE_TRANSFORM
constsRGB gamma-compression function (sRGB encoded → linear). Applies the IEC 61966-2-1 piecewise decode: values ≤ 0.04045 are linearised as C / 12.92; values above use the power-curve branch ((C + 0.055) / 1.055)^2.4.
Commons
BACKDROP_BLUR_DEFAULT_RUNG
constBACKDROP_BLUR_RUNG_VARS
constBACKDROP_UTILITY_CLASS_PREFIX
constBORDER_KEYWORD_WIDTH
constBORDER_LOGICAL_AXIS_MAP
constBORDER_LOGICAL_SIDE_MAP
constBORDER_POSITION_MAP
constBORDER_PROP_KEYS
constCUSTOM_BOX_SHADOW_REGEX
constELEVATED_CLASS_SUFFIX
constELEVATION_BG_COLOR_DEPRECATION_WARNING
constELEVATION_LEGACY_BG_COLOR
constHOTKEY_NO_AUTO_CLEANUP_WARNING
constHOTKEY_SEQUENCE_TIMEOUT
constINTERNAL_COMPONENTS
constLAYOUT_CLASS
constLAYOUT_DEFAULT_OFFSET
constLAYOUT_FULL_HEIGHT_CLASS
constLAYOUT_ID_PREFIX
constLAYOUT_ITEM_HIDDEN_OFFSET
constLAYOUT_ITEM_ZINDEX_STEP
constLAYOUT_OVERLAP_SEPARATOR
constLAYOUT_POSITION_VARS
constLAYOUT_SCRIM_ZINDEX_OFFSET
constMACINTOSH_UA_TOKEN
constMARGIN_LOGICAL_AXIS_MAP
constMARGIN_LOGICAL_SIDE_MAP
constMARGIN_POSITION_MAP
constMATERIAL_ELEVATION_LADDER
constMATERIAL_ELEVATION_TOP_RUNG
constNAMED_RADIUS_TOKEN
constNAME_ATTR_TAGS
constNESTED_LAYOUT_ZINDEX_STEP
constOPACITY_FRACTION_CEILING
constOPACITY_PERCENT_SCALE
constOPACITY_RUNG_VARS
constOPACITY_UTILITY_CLASS_PREFIX
constORIGAM_SSR_STYLES_KEY
constPADDING_LOGICAL_AXIS_MAP
constPADDING_LOGICAL_SIDE_MAP
constPADDING_POSITION_MAP
constPREDIFINED_ROUNDED
constREDUCED_MOTION_ANIMATION_DURATION
constREDUCED_MOTION_QUERY
constROUNDED_CORNER_MAP
constROUNDED_LOGICAL_CORNER_MAP
constSHADOW_RUNG_FALLBACK
constSHADOW_TOKEN_PREFIX
constSHADOW_UTILITY_CLASS_PREFIX
constSPACING_SCALE_STEPS
constSSR_STYLE_TAG_PREFIX
constSTACK_Z_INDEX_STEP
constTELEPORT_TYPOGRAPHY_MEASURE_SELECTOR
constTELEPORT_TYPOGRAPHY_NEUTRAL_FONT_SIZE
constTOUCH_DRAG_THRESHOLD_PX
constTOUCH_EDGE_ZONE_PX
constTOUCH_FLING_VELOCITY_X
constTOUCH_FLING_VELOCITY_Y
constTOUCH_OPEN_DIRECTION_BY_POSITION
constTOUCH_SETTLE_PROGRESS
constUNSEEDED
constUTILITY_RADIUS_FALLBACK
constVARIANT_PRESETS
constVARIANT_PROP_KEY
constVIRTUAL_FALLBACK_ITEM_HEIGHT_PX
constVIRTUAL_SCROLL_DURATION_MS
constVIRTUAL_SCROLL_EASING
constVIRTUAL_SCROLL_SEQUENCE_MS
const
Component Internals
ORIGAM_BTN_TOGGLE_KEY
constSymbol-based Vue injection key used by OrigamBtnToggle to provide IGroupProvide to its OrigamBtn children. Created with Symbol.for('origam:btn-toggle') so the key is globally unique and stable across module copies.
ORIGAM_CHIP_GROUP_KEY
constSymbol-based Vue injection key used by OrigamChipGroup to provide group context to its OrigamChip children. Created with Symbol.for('origam:chip-group') so the key is globally unique and stable across module copies.
Components
BRACKET_DEFAULT_MATCH_WIDTH
constDefault match card width (in px) used by the OrigamBracket layout algorithm when computing connector paths in horizontal mode. Mirrors the token bracket.match.width.
BRACKET_DEFAULT_ROUND_GAP
constDefault horizontal gap (in px) between rounds in the OrigamBracket layout. Mirrors the token bracket.gap-round.
BRACKET_DEFAULT_WINNERS_LABEL
constDefault heading rendered above the winner-bracket tree in a double-elimination OrigamBracket layout. Override via the winnersLabel prop to localise.
BRACKET_MATCH_STATUSES
constClosed list of valid status values for IBracketMatch.status. Used to validate and iterate match states in OrigamBracket.
BRACKET_VARIANTS
constClosed list of valid variant values for OrigamBracket. Exposed so stories and consumers can iterate the matrix without duplicating string literals.
CHART_RANGE_SELECTOR_DEFAULT_BUTTONS
constDefault buttons shown in the OrigamChart range-selector toolbar when rangeSelector.enabled is true without a custom buttons array. Covers common time-series windows (1w, 1m, 3m, 6m, 1y, all).
CHART_Y_TICK_COUNT
constDefault number of Y-axis ticks drawn by OrigamChart. The composable snaps the data range to a nice multiple of this value — five rows fits most narrow chart heights without crowding.
CIRCUMFERENCE
constSVG circle circumference (2π × MAGIC_RADIUS) used by OrigamProgress circular mode to compute stroke-dasharray and stroke-dashoffset for the progress arc.
CODE_CACHE_MAX_ENTRIES
constMaximum entries kept by the per-singleton LRU cache in useCode. 64 is large enough for a page with dozens of small snippets while keeping memory under ~1 MB of pre-rendered HTML.
CODE_DARK_THEME
constShiki theme name used by useCode for dark mode. Maps to GitHub's dark theme — best contrast and nicest defaults. Override at the composable level for a different palette.
CODE_DEFAULTS
constDefault prop values used by OrigamCode. Centralised so stories, docs and tests all pull from the same constants and any future drift stays visible immediately.
CODE_LIGHT_THEME
constShiki theme name used by useCode for light mode. Maps to GitHub's light theme — best contrast and nicest defaults. Override at the composable level for a different palette.
COMMAND_PALETTE_DEFAULT_HOTKEY
constDefault global hotkey combinations for OrigamCommandPalette. Registers both ⌘+K (macOS) and Ctrl+K (Windows/Linux) so the palette works cross-platform without consumer branching.
COMMAND_PALETTE_DEFAULT_MAX_HEIGHT
constDefault maximum height in pixels of the OrigamCommandPalette result list. Constrains the scrollable area so the palette never takes over the full viewport height.
COMMAND_PALETTE_DEFAULT_WIDTH
constDefault width in pixels of the OrigamCommandPalette dialog. Sized to be wide enough for long command labels while staying comfortable on medium screens.
COMMAND_PALETTE_GLOBAL_ID
constDefault v-model name of the global command palette singleton registered by useCommand. Apps that render multiple palettes can override this key to isolate their instances.
DEFAULT_ACTION_HEADER
constDefault column descriptor for action columns in OrigamDataTable. Extends DEFAULT_HEADER with a fixed width of 48px — sized to fit a single icon button without occupying data space.
DEFAULT_HEADER
constMinimal column descriptor used as the base for OrigamDataTable column headers. Sets title to an empty string and sortable to false. Extended by DEFAULT_ACTION_HEADER which adds a fixed width.
Composables & Internals
EMPTY_NESTED
constNo-op implementation of TNestedProvide injected when a component is used outside a nested context (e.g. OrigamList without a parent OrigamList). Prevents undefined-access errors on the nested tree API.
EVENT_PROP
constGeneric factory that returns a Vue PropType descriptor accepting either a Function or an Array of functions, typed as TEventProp<T>. Used on components that need to expose a callback prop (e.g. onClick, onInput).
FORWARD_REFS
constUnique Symbol used as an injection key to forward template refs across component boundaries. Components that expose their internal refs to consumers inject under this key.
GLOBAL_STACK
constReactive array of [uid, zIndex] tuples tracking every active stacked surface (Dialog, Menu, Tooltip, Snackbar…). Used by useStack to compute z-index increments and ensure correct stacking order.
Data Display
BRACKET_DEFAULT_LOSERS_LABEL
constDefault heading rendered above the loser-bracket tree in a double-elimination layout. Override via the losersLabel prop (e.g. to localise). Kept as a literal in withDefaults, mirrored here for consumer reference.
BRACKET_DEFAULT_MATCH_GAP
constDefault vertical gap in pixels between sibling matches in the first round of an OrigamBracket. Subsequent rounds double the gap to produce the classic branching pattern. Mirrors the bracket.gap-round design token.
BRACKET_DEFAULT_MATCH_HEIGHT
constDefault match card height in pixels used by the OrigamBracket layout algorithm when computing SVG connector paths in horizontal mode. Mirrors the bracket.match.height design token; duplicated in code so the connector pure function stays free of DOM measurement.
ORIGAM_TREEVIEW_KEY
constVue injection key (Symbol) shared by OrigamTreeview (root provider) and nested OrigamTreeviewItem components to propagate selection mode, expand state, and item registration across arbitrary nesting depth.
DataTable
DATA_TABLE_DEFAULT_ITEMS_PER_PAGE
constDATA_TABLE_DEFAULT_PAGE
constDATA_TABLE_HEADER_SLOT_PREFIX
constDATA_TABLE_ITEMS_PER_PAGE_ALL
constDATA_TABLE_ITEM_SLOT_PREFIX
constDATA_TABLE_MIN_PAGE_COUNT
constDATA_TABLE_PAGINATION_MISSING_ERROR
constDATA_TABLE_RESERVED_HEADER_SLOT_NAMES
constDATA_TABLE_ROWS_SLOT_NAMES
const
Date & Time
DATE_2000_JUNARY_SUNDAY
constA fixed Date anchor set to Sunday 2 January 2000 (new Date(2000, 0, 2)). Used by date-picker and calendar components as a reference Sunday to compute the first day of week offset without depending on the runtime locale or a full-blown date library.
FIRST_DAY
constCLDR-derived map of ISO 3166-1 country/region codes to their locale-specific first day of the week (0 = Sunday, 1 = Monday, 5 = Friday, 6 = Saturday). Used by the date adapter to initialise calendar grids correctly. Contains ~90 entries.
REGEX_DATE_YYYY_MM_DD
constRegular expression that validates an ISO 8601 date string in YYYY-MM-DD format (years 1000–2999, months 1–12, days 1–31). Used by date utilities to guard against malformed inputs before parsing.
Environment Detection
SUPPORTS_INTERSECTION
constBoolean flag set at module load time: true when the code runs in a browser that exposes the IntersectionObserver API. Always false during SSR.
SUPPORTS_TOUCH
constBoolean flag set at module load time: true when the current environment supports touch events (ontouchstart present or maxTouchPoints > 0). Always false during SSR.
Events & Interaction
BUBBLING_EVENTS
constArray of all DOM event handler prop names that bubble. Used by OrigamInput-family components to forward only bubbling events to the inner native element, avoiding duplication on the root wrapper.
CLIPBOARD_DEFAULT_FEEDBACK_DURATION_MS
constDefault feedback window (ms) the "Copied!" pill stays visible after a successful useClipboard() write. Aligned on the Snackbar default so the visual rhythm stays consistent across the DS.
Feedback & Notifications
SNACKBAR_GROUP_DEFAULT_DURATION
constDefault auto-dismiss timeout in milliseconds (5000 ms = 5 s) applied to SnackbarGroup items when neither the stack nor the per-item options specify a duration. A per-item value of 0 makes the snackbar sticky.
SNACKBAR_GROUP_DEFAULT_ID
constDefault stack identifier used by `useSnackbarGroup` when the consumer does not pass an explicit id. Multiple independent stacks can coexist on a page — each is keyed by its own id in the composable's internal Map.
SNACKBAR_GROUP_DEFAULT_MAX
constDefault maximum number of snackbar items rendered concurrently in a SnackbarGroup. Excess items are evicted FIFO (oldest first) when new ones are pushed.
SNACKBAR_GROUP_DEFAULT_SPACING
constDefault CSS gap between stacked snackbar items in a SnackbarGroup. Applied as a CSS dimension string.
SNACKBAR_GROUP_DIRECTIONS
constClosed list of valid `direction` values for OrigamSnackbarGroup. Exposed so stories and consumers can iterate the matrix without duplicating string literals.
SNACKBAR_GROUP_LOCATIONS
constClosed list of valid `location` values for OrigamSnackbarGroup. Covers the eight placement zones available on the viewport edges and corners.
Feedback & Status
EMPTY_STATE_ALIGNS
constClosed list of valid `align` values for OrigamEmptyState. Exposed so stories and consumers can iterate the full alignment matrix without duplicating string literals.
EMPTY_STATE_PRESETS
constClosed list of valid `preset` values for OrigamEmptyState (no-data, no-results, error, offline, locked). Each preset maps to a default icon and semantic intent via EMPTY_STATE_PRESET_CONFIG.
EMPTY_STATE_PRESET_CONFIG
constPer-preset bundle mapping each TEmptyStatePreset to its default icon (MDI) and semantic intent. Consumers can override icon and iconColor at the prop level without leaving the preset system.
EMPTY_STATE_SIZES
constClosed list of valid `size` values for OrigamEmptyState (sm, md, lg). Controls icon and text scale to fit different container contexts.
Form & Input
ACTIVE_TEXT_FIELD_TYPE
constSubset of TextField types that render a browser-native picker overlay (color, file, time, date, datetime-local, week, month). Used internally to distinguish them from plain text inputs.
ALLOWED_ATTRIBUTES
constPer-tag attribute allowlist used by the rich Textarea HTML sanitiser. Only the declared attributes survive sanitisation; all others are stripped. Values are still validated against URL-scheme and class-prefix rules downstream.
ALLOWED_CLASS_PREFIX
constWhitelist prefix for class attributes that survive the rich Textarea HTML sanitiser. Only classes starting with this prefix are retained, preventing arbitrary class injection while allowing semantic rich-text classes.
ALLOWED_TAGS
constTags retained by the rich Textarea HTML sanitiser. Anything outside this allowlist is unwrapped (children preserved, parent tag dropped). Scripts and dangerous containers are instead fully removed via BLOCKED_TAGS.
ALLOWED_URL_SCHEMES
constURL schemes allowed on <a href> values in the rich Textarea sanitiser. Tested against the start of the trimmed, lower-cased href. Anything else (notably javascript:, data:, vbscript:) is stripped.
BLOCKED_TAGS
constTags whose entire subtree is removed (not just unwrapped) by the rich Textarea HTML sanitiser. Their inner text is also dropped. Mirrors the OWASP HTML Sanitizer "blocked content" list.
BUILT_IN_PATTERNS
constCurated mask presets map (name → { pattern, validator }). Covers common formats: French/US/international phone, IBAN, SIRET, credit card, ISO date, FR/US date, time, and postal codes.
BUILT_IN_PATTERN_KEYS
constSet of registered mask preset keys derived from BUILT_IN_PATTERNS. Used by resolveMaskConfig to discriminate a string key (preset) from a raw pattern string.
DEFAULT_PASSWORD_REQUIREMENTS
constDefault set of password strength rules used by OrigamPasswordField when `requirements: true` is passed without an explicit array. Each rule has an id, an English label, and a predicate function.
DEFAULT_TOOLBAR
constDefault ordered list of toolbar commands surfaced by OrigamTextarea when `mode="rich"` is set and no custom `toolbar` prop is provided. Order is meaningful — it drives the visual layout left-to-right.
INPUT_TEXT_FIELD_TYPE
constSubset of HTML input types that render as a standard text-style field in OrigamTextField (text, search, password, tel, url). Excludes picker types handled by ACTIVE_TEXT_FIELD_TYPE.
Form & Validation
REQUIREMENT_MIN_LENGTH
constFactory function that produces a password-strength requirement descriptor for a minimum character count. Returns key, human-readable message, icon glyph, and a parametric regex matching at least N characters.
REQUIREMENT_NUMBER
constPassword strength requirement descriptor asserting that the value contains at least one digit (0-9). Used by OrigamPasswordField to display and validate the numeric character rule.
REQUIREMENT_SPECIAL
constPassword strength requirement descriptor asserting that the value contains at least one special character (any non-alphanumeric, non-space character). Used by OrigamPasswordField to display and validate the symbol rule.
REQUIREMENT_TINY
constPassword strength requirement descriptor asserting that the value contains at least one lowercase letter (a-z). Used by OrigamPasswordField to display and validate the lowercase character rule.
REQUIREMENT_UPPERCASE
constPassword strength requirement descriptor asserting that the value contains at least one uppercase letter (A-Z). Used by OrigamPasswordField to display and validate the uppercase character rule.
Grids
Icons
MDI
constThe Material Design Icons icon set adapter for Origam. Implements IIconSet by rendering OrigamClassIcon with the mdi CSS class. Normalises bare icon names (magnify) and already-prefixed names (mdi-magnify) to always emit mdi-{name}. Pass this constant to the icons option when installing Origam.
MDI_ALIASES
constSemantic icon aliases for the MDI icon set. Spreads all MDI_ICONS enum values and adds named overrides (collapse, complete, cancel, close, delete, clear, success, info, warning, error, prev, next, checkboxOn/Off/Indeterminate, delimiter, sortAsc/Desc, expand, menu, subgroup, dropdown, radioOn/Off, edit, ratingEmpty/Full/Half, loading, first, last, unfold, file, plus, minus, calendar, eyeDropper, eyeOff, eyeOn). Pass alongside MDI to the icons.aliases option.
Injection Keys
ORIGAM_DATA_TABLE_EXPAND_KEY
constVue provide/inject symbol that exposes the row-expansion API (expand, isExpanded, toggleExpand, expanded set, expandOnClick flag) from OrigamDataTable to its internal row components.
ORIGAM_DATA_TABLE_GROUP_KEY
constVue provide/inject symbol that exposes the row-grouping API (opened set, toggleGroup, isGroupOpen, sortByWithGroups, groupBy, extractRows) from OrigamDataTable to its group-header subcomponents.
ORIGAM_DATA_TABLE_HEADERS_KEY
constVue provide/inject symbol that shares the resolved header matrix (headers — 2D array for multi-row headers, columns — flat array for body cells) from OrigamDataTable to its header and body subcomponents.
ORIGAM_DATA_TABLE_PAGINATION_KEY
constVue provide/inject symbol that shares the pagination state (page, itemsPerPage, startIndex, stopIndex, pageCount, itemsLength) and navigation helpers (prevPage, nextPage, setPage, setItemsPerPage) from OrigamDataTable to its footer component.
ORIGAM_DATA_TABLE_SELECT_KEY
constVue provide/inject symbol that exposes the full selection context returned by provideSelection() (selected set, toggleSelect, selectAll, isSelected, …) from OrigamDataTable to rows and the select-all checkbox header.
ORIGAM_DATA_TABLE_SHOW_SELECT_KEY
constVue provide/inject symbol that carries a reactive boolean ref indicating whether the selection checkbox column is currently visible in the data table.
ORIGAM_DATA_TABLE_SORT_KEY
constVue provide/inject symbol that exposes the sorting API (sortBy array, toggleSort callback, isSorted predicate) from OrigamDataTable to its column-header subcomponents.
ORIGAM_DATE_ADAPTER_KEY
constVue provide/inject symbol that carries the active IDateInstance adapter (date parsing, formatting, arithmetic). Provided by OrigamDateProvider and consumed by all date-picker and date-field components.
ORIGAM_DATE_OPTIONS_KEY
constVue provide/inject symbol that carries the IDateOptions configuration object (locale, firstDayOfWeek, adapter factory…) provided by OrigamDateProvider and read by the date composable to bootstrap the adapter.
ORIGAM_DEFAULTS_KEY
constVue provide/inject symbol that shares the reactive defaults map (Ref<IDefault>) from OrigamDefaultsProvider to every component that calls useDefaults(). Used as a global symbol so multiple bundles of origam installed in the same page interoperate over one shared provider.
ORIGAM_DISPLAY_KEY
constVue provide/inject symbol that carries the reactive IDisplayInstance (breakpoint flags, mobile/tablet booleans, thresholds, orientation) provided by the display system and consumed by useDisplay().
ORIGAM_EXPANSION_PANEL_KEY
constVue provide/inject symbol that exposes the IGroupItemProvide selection context from OrigamExpansionPanels (accordion container) to each OrigamExpansionPanel item, enabling coordinated open/close state.
ORIGAM_FORM_KEY
constVue provide/inject symbol that exposes the IFormProvide context from OrigamForm to nested form-field components (OrigamTextField, OrigamSelect, …), enabling coordinated validation, disabled/readonly state propagation, and form submission handling.
ORIGAM_GO_TO_KEY
constVue provide/inject symbol that carries the IGoToInstance (programmatic scroll-to helper) provided by the origam plugin and consumed by useGoTo() and scroll-sensitive components such as OrigamScrollObserver.
ORIGAM_HOVER_STOP_KEY
constLocal Symbol (non-global, not shareable across bundles) used by the v-hover directive to store its cleanup/stop handle on the DOM element, preventing memory leaks on unmount.
ORIGAM_ICONS_KEY
constVue provide/inject symbol that carries the resolved TIconOptions (defaultSet, sets map, aliases) provided by the origam plugin and consumed by OrigamIcon to pick the correct icon-set renderer (svg or class).
ORIGAM_ITEM_GROUP_KEY
constVue provide/inject symbol shared by OrigamItemGroup (provider) and OrigamItem (consumer). Carries the IGroupProvide selection context (selected values, toggle, isSelected…) enabling single / multiple / mandatory selection over any custom UI.
ORIGAM_LAYOUT_ITEM_KEY
constVue provide/inject symbol that carries a ShallowRef<{ id: string }> from OrigamLayout to each registered layout item (AppBar, NavigationDrawer, Footer…), giving it access to its own layout-slot identifier.
ORIGAM_LAYOUT_KEY
constVue provide/inject symbol that carries the ILayoutProvide context from OrigamLayout to child layout items (AppBar, NavigationDrawer, Footer…). Enables items to register themselves, read the current layout map, and compute their CSS offsets relative to other registered panels.
ORIGAM_LIST_KEY
constVue provide/inject symbol that carries the OrigamList slot-coordination context (hasPrepend, updateHasPrepend, hasAppend, updateHasAppend) to its child OrigamListItem components, so item-level icons/actions align correctly with the list gutter.
ORIGAM_LOCALE_KEY
constVue provide/inject symbol that carries the combined ILocaleInstance & IRtlInstance context (current locale, t() translator, isRtl flag, rtlClasses) from the origam locale provider to all components consuming useLocale().
TIMELINE_CONTEXT_KEY
constVue InjectionKey used to provide and inject the ITimelineContext between OrigamTimeline and its OrigamTimelineItem children.
Interaction & Animation
RIPPLES
constLow-level ripple controller used internally by v-ripple. Exposes show() and hide() methods that create, animate, and remove the ripple DOM elements on the target element.
RIPPLE_OPTIONS
constDefault configuration object for the v-ripple directive — defines the CSS class, centering mode, shape, animation duration, easing function, opacity, and initial position of each ripple element.
Interactivity
KEYBOARD_ALIASES
constCentralised key-alias mapping used by the hotkey system to normalise user-friendly shorthand (esc, up, del, space…) to canonical KeyboardEvent.key values in lowercase.
KEYBOARD_MODIFIERS
constOrdered list of the five recognised modifier keys (ctrl, shift, alt, meta, cmd) used by the hotkey system when parsing and matching keyboard shortcuts.
KEYCODES
constFrozen map of legacy numeric keyCodes used by the ripple system and other low-level keyboard handlers. Covers the most common interaction keys (enter, tab, arrows, escape, space, etc.).
Internals
HANDLERS
constWeakMap used internally by bindProps to track active event listeners per HTMLElement. Allows the directive to cleanly unbind handlers without leaking references when elements are removed from the DOM.
HISTORY
constMaximum number of entries kept in the virtual scroll look-behind buffer. Controls how many previously rendered items are retained for smooth backwards scrolling.
HORIZON
constMaximum number of entries kept in the virtual scroll look-ahead buffer. Controls how many upcoming items are pre-rendered to avoid blank patches during fast scrolling.
HOVER
constHandler object used internally by the v-hover directive. Exposes show() and hide() methods that add or remove the configured CSS class on the target element when hover state changes.
IN_BROWSER
constBoolean flag that is true only when code is running in a real browser context (window + document available). Used throughout the DS to guard DOM access and prevent SSR crashes.
LOCALE_RTL_DEFAULT
constFrozen map of every supported locale code to its RTL flag. Used by the locale system to set the text-direction automatically when a locale is activated. RTL locales: ar, fa, he.
LO_CLIP
constAPCA minimum luminance clipping value (0.001). Values below this threshold are treated as absolute black to avoid mathematical artefacts in the contrast ratio calculation.
LO_CON_FACTOR
constAPCA low-contrast region scaling factor (≈ 12.82). Applied in the low-contrast branch of the Lc calculation when the absolute polarity-adjusted contrast falls below LO_CON_THRESH, to linearise the output near zero.
Internationalisation
NUMBER_FORMAT_DEFAULT_CURRENCY
constDefault currency code (ISO 4217) used by OrigamNumberFormat when format='currency' and the consumer omits the currency prop. Defaulting to 'USD' rather than throwing keeps story controls forgiving.
NUMBER_FORMAT_FALLBACK_LOCALE
constSSR-safe fallback locale for OrigamNumberFormat. Applied when neither the <html lang> attribute, navigator.language nor the explicit locale prop are available. Defaults to 'en-US'.
NUMBER_FORMAT_LRU_CAPACITY
constMaximum number of Intl.NumberFormat instances kept in the module-level LRU cache. 16 covers most realistic UIs (a few locales × a few format variants) without leaking memory in long-lived apps where every prop tweak would otherwise spawn a fresh resolver.
Layout & Sizing
BLOCK_ARRAY
constArray of the two block-axis anchor values (top and bottom). Used by the anchor / positioning system to enumerate vertical placement options without including inline or start/end variants.
BLOCK_START_END_ARRAY
constExtended block-axis anchor array that includes logical start/end values in addition to the physical top/bottom from BLOCK_ARRAY. Enables logical CSS property alignment alongside physical positioning.
BORDER_RADIUS_REGEX
constRegular expression used to detect a free-form CSS border-radius string passed via the rounded prop. Accepts 1–4 values with standard CSS length units or a unit-less 0. Non-matching values fall through to the named-variant or boolean branches of useRounded.
BORDER_REGEX
constRegular expression that parses a free-form border shorthand value into named capture groups: width, style, and color. Supports hex literals, CSS functions (rgb/hsl/rgba), CSS custom properties (var(--…)), and named keywords. The var() alternative is placed before the bare [A-Za-z]+ branch to avoid eating "var" as a keyword.
BREAKPOINTS_ARRAY
constOrdered list of the named responsive breakpoints (sm → xxl) used by the display system. Excludes the implicit xs base.
BUFFER_PX
constPixel buffer added above and below the visible viewport by the virtual-scroll engine. Pre-renders rows outside the current view to mask render latency during fast scrolling.
CUSTOM_BORDER_RADIUS_REGEX
constRegex that detects free-form CSS border-radius values not covered by the fixed-unit BORDER_RADIUS_REGEX whitelist: custom-property references (var(…)), CSS math functions (calc/clamp/min/max/env), and single lengths with viewport or advanced units (vw, vh, lh, …). Mirrors the convertToUnit escape hatch used by useDimension.
DEFAULT_DISPLAY_OPTIONS
constDefault configuration object for the useDisplay composable. Sets the mobile breakpoint to lg and the pixel thresholds for the six named breakpoints (xs → xxl) used by the responsive display system.
DEFAULT_SHEET_SNAP_POINTS
constDefault snap-point set used by OrigamSheet when the consumer does not pass custom snap points. Defines four positions: closed (0), peek (120px), half (50vh), and full (90vh).
DIMENSIONS_ARRAY
constOrdered array of all six dimension prop names (height, maxHeight, maxWidth, minHeight, minWidth, width) consumed by useDimension to iterate the full surface.
DIRECTION_ARRAY
constArray of all four directional values (top, bottom, left, right) combining BLOCK and INLINE axes. Used to validate and iterate the full directional surface (e.g. in anchor, popover, and tooltip positioning logic).
GRID_AUTO_FLOWS
constClosed list of valid `autoFlow` values for OrigamGrid (row, column, row dense, column dense). Maps directly to the CSS `grid-auto-flow` property values.
GRID_DEFAULTS
constDefault prop values used by OrigamGrid and its sub-components. Exposes the baseline settings (columns: auto, rows: auto, gap: md, autoFlow: row, alignItems: stretch, justifyItems: stretch, inline: false, tag: div) so consumers can reference them when authoring wrappers.
GRID_GAP_SIZES
constClosed list of valid gap token values (xs → xl) accepted by the gap prop of OrigamGrid. Iterate this array to build a HstSelect or a picker without duplicating string literals.
GRID_GAP_SIZE_VAR
constMaps every gap-size token to its corresponding CSS custom property, declared in the hand-maintained token sheet packages/ds/src/assets/css/tokens/light.css. Provides a single source of truth so a token rename propagates automatically.
GRID_PLACE_CONTENT
constClosed list of valid alignContent / justifyContent values for OrigamGrid. Extends GRID_PLACE_ITEMS with distribution keywords (space-between, space-around, space-evenly).
GRID_PLACE_ITEMS
constClosed list of valid alignItems / justifyItems values for OrigamGrid. Also aliased as GRID_PLACE_SELF for the per-item self-axis.
GRID_PLACE_SELF
constAlias of GRID_PLACE_ITEMS for the per-item self-axis (alignSelf / justifySelf). Shares the same four values: start, center, end, stretch.
INLINE_ARRAY
constArray of the two horizontal anchor positions (left, right) used by the anchor and location systems. Building block for INLINE_START_END_ARRAY.
INLINE_START_END_ARRAY
constExtended set of horizontal anchor positions: left, right, start, end. Spreads INLINE_ARRAY and appends the logical-property equivalents (start / end) for RTL-aware layouts.
LOCATION_STRATEGIES
constMap of the two built-in positioning strategies used by floating components (Menu, Tooltip, Picker). static = fixed viewport position (centered by default); connected = anchored to a triggering element.
MAGIC_RADIUS
constRadius (in SVG user units) of the circle path used by OrigamProgress circular mode. The value 20 is chosen so that CIRCUMFERENCE = 2π×20 ≈ 125.66, which maps cleanly to a 0–100 stroke-dashoffset range.
MARGIN_REGEX
constRegular expression that validates a CSS shorthand margin/padding string (up to four space-separated values with valid units: px, pt, PC, in, cm, mm, em, rem, %, ex, ch, fr). Used by useMargin and usePadding to distinguish shorthand strings from single token values.
MASONRY_ALIGNS
constClosed list of valid align values for OrigamMasonry. Exposed so stories and consumers can iterate the full matrix without retyping the literals. Accepted values: top (Pinterest-style) and center.
MASONRY_DEFAULTS
constDefault prop values for OrigamMasonry. Exported so consumers can reference or override them when authoring wrappers without re-importing the component.
OPPOSITE_MAP
constLookup table that maps each TLocation value to its geometric opposite. Used by the connected location strategy to flip a floating element when there is not enough space on the preferred side.
ORIGAM_SHADOW_RUNGS
constReadonlySet of named shadow-rung identifiers accepted by the elevation prop. Each rung maps to a --origam-shadow-{rung} CSS custom property. Numeric elevation values are handled separately via elevationToToken.
PADDING_REGEX
constRegExp that validates a CSS shorthand padding string (0 to 4 space-separated values each followed by a supported unit: px, pt, PC, in, cm, mm, em, rem, %, ex, ch, or fr). Returns null for invalid input.
PREDEFINED_DENSITY
constThe list of allowed density values (default, compact, comfortable) used to validate and iterate the density prop across components.
PREDEFINED_ROUNDED
constWhitelist of named border-radius variants (xs → shaped-invert) used by useRounded to decide between a utility class and an inline border-radius declaration.
ROOT_ZINDEX
constBase z-index value (1000) from which all overlay components (Overlay, Menu, Tooltip, Dialog…) derive their stacking level. Overlays stack incrementally above this floor.
SIZES_ARRAY
constOrdered list of the five standard size values (x-small → x-large) used by the `size` prop across components. Useful for iterating the complete size matrix in stories and validation helpers.
Media
AUDIO_DEFAULTS
constCanonical default prop values for OrigamAudio. Exported for story-side iteration and consumer reference. Never referenced from withDefaults() itself — the Vue SFC compiler only resolves inline literals there.
MEDIA_AUTOPLAY_SUPPRESSED_WARNING
constMEDIA_DEFAULT_PLAYBACK_RATE
constMEDIA_DEFAULT_PRELOAD
constDefault preload hint forwarded to the native <audio>/<video> element. The value 'metadata' loads only enough data to compute the duration, avoiding auto-buffering and reducing bandwidth on initial render.
MEDIA_DEFAULT_VOLUME
constDefault volume (0–1 range) for OrigamAudio and OrigamVideo. Value 1 means full volume, matching the browser native default. Materialised here so useMediaPlayer, OrigamAudio and OrigamVideo share a single source of truth instead of re-typing the literal.
MEDIA_MAX_PLAYBACK_RATE
constMEDIA_MAX_VOLUME
constMEDIA_MIN_PLAYBACK_RATE
constMEDIA_MIN_VOLUME
constMEDIA_SCRUBBER_MIN_RANGE
constMEDIA_UNKNOWN_ERROR_MESSAGE
constVIDEO_DEFAULT_PRELOAD
constDefault preload hint for the <video> element: 'metadata' loads only the duration/dimensions metadata without buffering the full stream.
Navigation
ORIGAM_STEPPER_KEY
constVue injection key (Symbol) shared by OrigamStepper (provider) and OrigamStep (consumer) to propagate step registration, active-step tracking, and navigation callbacks without prop drilling.
ORIGAM_TABS_KEY
constVue injection key (Symbol) shared by OrigamTabs (provider) and each OrigamTab (consumer). Uses a dedicated symbol so an OrigamTabs nested inside an OrigamBtnToggle does not cross-register items with the outer group.
ORIGAM_TAB_PANELS_CTX_KEY
constAuxiliary Vue injection key (Symbol) exposed by OrigamTabPanels so child OrigamTabPanel components can read transition direction and swipe settings without re-declaring the same props at every nesting level.
ORIGAM_TAB_PANELS_KEY
constVue injection key (Symbol) shared by OrigamTabPanels (provider) and each OrigamTabPanel (consumer). Kept distinct from ORIGAM_TABS_KEY so the panels group can be rendered as a sibling of the tab list under a common ancestor.
ORIGAM_WINDOW_GROUP_KEY
constVue injection key (Symbol) used by OrigamWindow to expose its IGroupItemProvide context to group-aware children (e.g. indicator dots or external navigation controls) so they can read the active item state.
ORIGAM_WINDOW_KEY
constVue injection key (Symbol) shared by OrigamWindow (provider) and its item children so they can register themselves, query the active index, and respond to swipe / transition events.
Navigation & Disclosure
LIST_OPEN_STRATEGY
constOpen strategy for list-style navigation (e.g. OrigamList). Uses MULTIPLE_OPEN_STRATEGY for opening and a custom select handler that closes all siblings not on the path from the selected item to the root.
MULTIPLE_OPEN_STRATEGY
constOpen strategy that allows any number of nested items to be expanded simultaneously. When opening an item all its ancestors are also opened; when closing only the targeted item is removed from the opened set. Contrast with SINGLE_OPEN_STRATEGY which collapses siblings. Used by OrigamList, OrigamTreeview and any nested component.
Nuxt / SSR
ORIGAM_NUXT_DEFAULT_COOKIE_MAX_AGE
constDefault max-age (in seconds) for the theme and mode persistence cookies set by the Origam Nuxt module — equals exactly one year (60 × 60 × 24 × 365).
ORIGAM_NUXT_DEFAULT_COOKIE_NAME
constDefault cookie name used by the Origam Nuxt module to persist the active theme selection across SSR page loads.
ORIGAM_NUXT_DEFAULT_MODE
constDefault color mode applied by the Nuxt module when no mode cookie is present. Defaults to "auto" so the OS preference is respected on first visit.
ORIGAM_NUXT_DEFAULT_MODES
constReadonly tuple of supported color modes shipped by the Nuxt module by default. Contains "light" and "dark"; additional modes require explicit configuration.
ORIGAM_NUXT_DEFAULT_MODE_COOKIE_NAME
constDefault cookie name used by the Origam Nuxt module to persist the active color-mode selection (light/dark/auto) across SSR page loads.
ORIGAM_NUXT_DEFAULT_PREFIX
constDefault component prefix registered by the Origam Nuxt module. All auto-imported components are available as <OrigamXxx> out of the box.
ORIGAM_NUXT_DEFAULT_THEME
constDefault brand-theme name applied by the Nuxt module when no theme cookie is present. Defaults to "auto", which lets the module resolve the appropriate built-in theme from the active color mode.
ORIGAM_NUXT_DEFAULT_THEMES
constReadonly tuple of built-in brand-theme names shipped by the Nuxt module. Contains "light" and "dark"; custom brand themes are registered via the themes option in nuxt.config.
Overlay & Positioning
SCROLL_STRATEGIES
constMap of scroll behaviour strategies consumed by overlaying components (Menu, Tooltip, Snackbar, ContextualMenu, Overlay). Keys are the prop string values; values are the strategy handler functions (or null for "none").
SINGLE_OPEN_STRATEGY
constNested-open strategy that enforces a single-open-at-a-time policy: opening a node closes any previously open sibling, while parents of the newly opened node are kept open. The `select` hook is a no-op (returns null). Used as the default strategy for ExpansionPanel.
Parallax
PARALLAX_ELEMENT_DEFAULT_STRENGTH
constPARALLAX_ELEMENT_DEPTH_TRANSLATE_FACTOR
constPARALLAX_ELEMENT_MOVEMENT_BASE
constPARALLAX_ELEMENT_MOVEMENT_DIVISOR
constPARALLAX_ELEMENT_VAR_X
constPARALLAX_ELEMENT_VAR_Y
constPARALLAX_LAYER_VAR_OFFSET_X
constPARALLAX_LAYER_VAR_OFFSET_Y
constPARALLAX_LAYER_VAR_SPEED
constPARALLAX_MOUSE_AMPLITUDE_FACTOR
constPARALLAX_SPRING_DAMPING
constPARALLAX_TRANSFORM_PRECISION
const
PasswordField
Provide / Inject
ORIGAM_MENU_KEY
constVue injection key (InjectionKey<IMenuProvide>) used by OrigamMenu to provide its context to descendant activators.
ORIGAM_NESTED_KEY
constVue injection key (InjectionKey<TNestedProvide>) that carries the parent–child nesting context (open/select strategies) for tree-structured components like List, Treeview and ExpansionPanel.
ORIGAM_PARALLAX_KEY
constVue injection key (InjectionKey<IParallaxProvide>) used by OrigamParallax to broadcast scroll-position context to child OrigamParallaxLayer and OrigamParallaxElement components.
ORIGAM_PARALLAX_LAYER_KEY
constVue injection key (InjectionKey<IParallaxLayerProvide>) used by OrigamParallaxLayer to expose layer-specific context (depth, bounds) to nested elements.
ORIGAM_SELECTION_CONTROL_GROUP_KEY
constVue injection key (InjectionKey<ISelectionGroupContext>) used by OrigamSelectionControlGroup to share selection state (modelValue, multiple, disabled…) with every child OrigamSelectionControl.
ORIGAM_SLIDE_GROUP_KEY
constVue injection key (InjectionKey<IGroupProvide>) used by OrigamSlideGroup to broadcast group-selection state (selected items, register/unregister) to child OrigamSlideGroupItem components.
QR Code
QR_CODE_DEFAULT_ECC
constDefault error-correction level ('M') for QR codes — ~15% redundancy, balancing matrix density and damage tolerance for clean digital and print mediums without a logo overlay.
QR_CODE_DEFAULT_LOGO_PADDING
constDefault padding (in pixels) applied around the logo overlay inside a QR code — 6 px provides visual breathing room without obscuring too many codewords.
QR_CODE_DEFAULT_LOGO_SIZE
constDefault logo overlay size as a ratio of the QR code width — 0.2 (20%) is the recommended ceiling before error correction starts failing.
QR_CODE_DEFAULT_MARGIN
constDefault quiet-zone width in modules surrounding the QR matrix — ISO/IEC 18004 recommends 4 modules; smaller values significantly hurt scanner reliability.
QR_CODE_LRU_CAPACITY
constMaximum number of entries kept in the module-level LRU cache keyed on serialised payload + options — 16 entries covers a realistic storybook scenario (value variants × ECC levels × small tweaks).
QR_CODE_OVERLAY_MAX_RATIO
constMaximum safe overlay size as a ratio of the QR width — above 0.3 (30%) even error-correction level 'H' cannot reconstruct the obscured codewords and scans start to fail. The composable warns instead of clamping so the consumer keeps artistic control.
QrCode
RatingField
Skeleton
Snackbar
Theme
ORIGAM_THEMES_KEY
constVue injection key (Symbol) that carries the list of brand themes installed via createOrigam({ themes }). Components read the installed theme registry through useInstalledThemes() which resolves this key.
ORIGAM_THEME_ATTR
constHTML attribute name written on the root element to activate a named theme. Setting data-theme="dark" on <html> switches the active token set.
ORIGAM_THEME_AUTO
constSentinel value for the automatic theme mode. When the active theme is set to "auto", Origam follows the OS prefers-color-scheme preference instead of an explicit theme name.
ORIGAM_THEME_DARK
constName of the built-in dark theme. Pass this value to useTheme().setTheme() or to the data-theme attribute to switch the entire app to dark mode.
ORIGAM_THEME_DEFAULTS_KEY
constORIGAM_THEME_LIGHT
constName of the built-in light theme. Pass this value to useTheme().setTheme() or to the data-theme attribute to force the app into light mode regardless of OS preference.
ORIGAM_THEME_STORAGE_KEY
constlocalStorage key under which the user's chosen theme name is persisted across page reloads. useTheme() reads and writes this key automatically.
Theme & Mode
ORIGAM_MODE_ATTR
constHTML attribute name set on the <html> element to reflect the active color mode. Consumers should read and write this attribute to synchronise mode state.
ORIGAM_MODE_AUTO
constThe sentinel string for the automatic color-mode: the DS defers to prefers-color-scheme and does not force light or dark.
ORIGAM_MODE_DARK
constLiteral value for the dark color mode. Passed to setMode() or written to the data-mode attribute to force dark rendering regardless of system preference.
ORIGAM_MODE_LIGHT
constLiteral value for the light color mode. Passed to setMode() or written to the data-mode attribute to force light rendering regardless of system preference.
ORIGAM_MODE_STORAGE_KEY
constlocalStorage / cookie key under which the user-selected color mode is persisted across page loads.
Typography
BLOCKQUOTE_ALIGNS
constClosed list of valid text alignment values for the align prop of OrigamBlockquote. Use to iterate in stories or validate consumer input.
BLOCKQUOTE_DEFAULTS
constCanonical default prop values for OrigamBlockquote. Centralised so consumers can reference them when authoring wrappers. Never referenced from withDefaults() itself.
BLOCKQUOTE_LANGS
constClosed list of valid lang values for OrigamBlockquote. Controls which decorative quote glyphs are rendered. 'auto' detects the page language at runtime.
BLOCKQUOTE_VARIANTS
constClosed list of valid variant values for OrigamBlockquote. Exposed so stories and consumers can iterate the full visual matrix without duplicating string literals.
Virtual Scroll
DOWN
constScroll direction sentinel equal to +1, representing downward scroll. Paired with UP (-1) and used by the virtual scroller to determine which direction the viewport is moving.
UP
constDirection sentinel used by the virtual scroll engine: UP = -1 indicates scrolling toward lower indices (top of the list). Paired with DOWN = 1.
Watermark
WATERMARK_DATA_ATTR
constHTML data attribute applied to every watermark layer created by OrigamWatermark. The anti-tamper MutationObserver uses it to detect and re-inject removed layers.
WATERMARK_DEFAULT_ANGLE_DEG
constDefault rotation angle in degrees for watermark tiles: -30° gives the classic diagonal look matching confidential-document watermarks.
WATERMARK_DEFAULT_COLOR
constDefault fill color for watermark text: 'currentColor' inherits the surrounding text color so the watermark blends naturally with any theme.
WATERMARK_DEFAULT_FONT_FAMILY
constDefault font-family for watermark text: 'inherit' picks up the nearest ancestor font so the watermark matches the page typography automatically.
WATERMARK_DEFAULT_FONT_SIZE_PX
constDefault font size in pixels for watermark text: 16 px is readable at standard zoom without overwhelming the content beneath.
WATERMARK_DEFAULT_FONT_WEIGHT
constDefault font weight for watermark text: 400 (normal). Accepts numeric CSS weight values or string keywords.
WATERMARK_DEFAULT_GAP_PX
constDefault gap in pixels between watermark tiles: 120 px matches the spacing of confidential-document watermarks at standard zoom (~one glyph every ~12 cm at 96 dpi).
WATERMARK_DEFAULT_OPACITY
constDefault opacity for watermark tiles: 0.1 (10%) keeps the watermark visible without obscuring the underlying content.
WATERMARK_DEFAULT_POINTER_EVENTS
constDefault CSS pointer-events value for watermark layers: 'none' makes the overlay fully click-through so it never interferes with the interactive content beneath.
WATERMARK_DEFAULT_Z_INDEX
constDefault z-index for the watermark overlay: 1 places it just above the normal document flow without competing with modals or tooltips.
WATERMARK_MIN_FONT_SIZE_PX
constWATERMARK_MIN_IMAGE_SIZE_PX
const