APIénumérations.
Chaque enum TypeScript utilisé dans les props d'origam. Entièrement documenté avec ses définitions, ses membres et des références croisées vers les composants qui les utilisent.
143 enums répartis dans 43 catégories
PARCOURIR PAR CATÉGORIE
Tous les enums.
Animation & Motion
PARALLAX_DIRECTION
enumTypeScript enum for Parallax scroll/motion direction — vertical, horizontal, or both axes.
PARALLAX_EASING
enumTypeScript enum for Parallax easing curve — linear, ease-out, or spring physics.
PARALLAX_ELEMENT_TYPE
enumTypeScript enum for the CSS transform type applied to each Parallax element — scale, translate, rotate, depth, or custom.
PARALLAX_EVENT
enumTypeScript enum for the browser event driving the Parallax effect — mouse move, scroll, or device orientation.
Animation & Transitions
Audio
AUDIO_LOOP_MODE
enumTypeScript enum for the loop strategy of OrigamAudio when a playlist is active (none, all, one).
AUDIO_VARIANT
enumTypeScript enum for the visual variant of OrigamAudio (expanded, compact). Deprecated aliases: normal, minimal.
COVER_POSITION
enumSide of the audio surface where the album cover is painted relative to the controller column in OrigamAudio.
Behavior
OPEN_STRATEGY
enumTypeScript enum controlling how tree/list nodes open — single, multiple, or list mode.
SCROLL_BEHAVIOR
enumTypeScript enum for Toolbar scroll behavior — hide, invert, collapse, elevate, or activate on scroll.
SCROLL_STRATEGIES
enumTypeScript enum for overlay scroll strategy — none, close, block, or reposition.
SELECTED
enumTypeScript enum for tri-state selection — on, off, or indeterminate.
SELECT_STRATEGY
enumTypeScript enum for tree/list selection strategy — single-leaf, leaf, independent, single-independent, or classic.
Bracket
Chart
CHART_BULLET_ORIENTATION
enumOrientation of a bullet chart — horizontal (progress bar style) or vertical (column style).
CHART_CARTESIAN_KIND
enumChart topology selector for the cartesian family (line, area, bar, column, scatter, spline, stepped-line).
CHART_HONEYCOMB_COLOR_MODE
enumColor encoding mode for the honeycomb chart — categorical (one color per series) or heatmap (gradient intensity).
CHART_HONEYCOMB_ORIENTATION
enumHexagon orientation for the honeycomb chart — pointy-top or flat-top.
CHART_MAP_MODE
enumRendering mode for the map chart — choropleth (region fill by value) or flight routes (arc connections).
CHART_PICTORIAL_DIRECTION
enumFill direction for the pictorial bar chart — vertical (bottom to top) or horizontal (left to right).
CHART_PICTORIAL_MODE
enumSymbol rendering mode for the pictorial chart — stack (repeat symbols) or fill (clip a single symbol).
CHART_POLAR_KIND
enumChart type selector for the polar family — pie (full circle segments) or donut (ring with a hollow center).
CHART_PYRAMID_KIND
enumShape variant for the pyramid/funnel chart — pyramid (widest at bottom, tip up) or funnel (widest at top, narrows down).
CHART_SMOOTHING
enumCHART_SPARKLINE_KIND
enumChart type for inline sparkline widgets — line, area, column, or bar.
CHART_STACKING
enumStacking strategy for bar, column, and area charts — normal (absolute values) or percent (normalized to 100%).
CHART_STREAMGRAPH_OFFSET
enumBaseline offset strategy for the streamgraph chart — wiggle, silhouette, expand, or zero.
CHART_SUNBURST_LABEL_MODE
enumCHART_TREEMAP_ALGORITHM
enumLayout algorithm for the treemap chart — squarified (aspect-ratio optimized) or slice-dice (alternating horizontal/vertical splits).
CHART_TYPE
enumMaster enum of all chart types supported by the Origam chart component family.
CHART_WORD_CLOUD_ROTATION
enumWord rotation strategy for the word cloud chart — none (horizontal only), random (any angle), or orthogonal (0° and 90° only).
Code
Commons
BG_FG_ROLE
enumBORDER_LOGICAL_AXIS
enumCLIENT_POSITION
enumAxis selector for pointer / touch event client coordinates (clientX or clientY).
COLOR_MODE
enumCONTROLS_SOURCE
enumFONT_FAMILY
enumFONT_SIZE
enumFONT_WEIGHT
enumINTENT
enumLETTER_SPACING
enumLINE_HEIGHT
enumLOADER_KIND
enumROUNDED_TOKEN
enumTEXT_ALIGN
enumTEXT_TRANSFORM
enum
Data Display
BRACKET_MATCH_STATUS
enumTypeScript enum for the status of a match in a tournament bracket (pending, live, completed, forfeited).
BRACKET_VARIANT
enumTypeScript enum for the tournament bracket format (single-elimination, double-elimination, round-robin).
CARD_TYPE
enumTypeScript enum for the layout type of a Card inside a collection (grid, list).
EMPTY_STATE_PRESET
enumClosed set of semantic preset values for OrigamEmptyState. Each preset provides a predefined icon, title and description.
FILTERS_MODE
enumStrategy used when multiple active filters are evaluated together on a collection. Determines whether an item must satisfy some or all conditions.
LINES
enumNumber of text lines displayed per list item (one, two, three).
LIST_ITEM_ROLE
enumThe ARIA role a row announces, chosen by its list so the container and its rows can never disagree.
LIST_ITEM_TYPE
enumDiscriminates between the three possible children of OrigamList: item, subheader, or divider.
LIST_ROLE
enumThe ARIA role OrigamList announces: a plain list, or a listbox when the consumer asks for selection.
REFERRER_POLICY
enumTypeScript enum for the HTML referrerpolicy attribute — controls how much referrer information is sent with image requests.
SORT_DIRECTION
enumTypeScript enum for column sort order — ascending or descending.
DataList
DataTable
Feedback & Status
FileField
Form & Input
CALENDAR_STRATEGY
enumTypeScript enum for the rendering strategy of the date picker calendar (dynamic, static).
INLINE_EDIT_ACTION
enumIdentifies action buttons rendered by OrigamInlineEdit (edit, confirm, cancel).
OTP_INPUT_FIELD_TYPE
enumTypeScript enum for OTP input field type — text, number, or password.
SLIDER_FIELD_VARIANT
enumTypeScript enum for SliderField visual variant — full form field, bare timer scrubber, or waveform audio scrubber.
TEXTAREA_MODE
enumTypeScript enum for the render mode of OrigamTextareaField — plain (legacy textarea) or rich (contenteditable).
TEXTAREA_OUTPUT
enumTypeScript enum for the serialisation format of the rich-text textarea v-model — HTML or Markdown.
TEXTAREA_TOOLBAR_COMMAND
enumTypeScript enum for rich-text toolbar command identifiers — bold, italic, link, lists, headings, code, clear-format.
TEXTAREA_TOOLBAR_POSITION
enumTypeScript enum for where the rich-text toolbar is rendered relative to the editable surface — top, bottom, or floating.
TEXT_FIELD_TYPE
enumTypeScript enum for the HTML input type attribute values supported by OrigamTextField and related field components.
VALIDATE_ON
enumTypeScript enum for the validation trigger of form fields — blur, input, submit, and lazy variants.
VARIANT_INPUT
enumTypeScript enum for the visual variant of text input controls — underlined, filled, solo, outlined, plain.
Grid
Interaction
FOCUS_LOCATION
enumEnum describing focus navigation directions within a component (next, prev, first, last).
KEYBOARD_MODIFIERS_KEY
enumKeyboard modifier key identifiers used for hotkey configuration (ctrl, shift, alt, meta, cmd).
KEYBOARD_VALUES
enumStandard KeyboardEvent.key values used for hotkey detection and keyboard navigation.
Interaction & Events
Kbd
Layout & Positioning
ADJACENT
enumTypeScript enum for slot positions adjacent to a form control (clear, prepend, append, appendInner, prependInner).
ALIGN
enumTypeScript enum for cross-axis alignment in flex/grid layouts (start, end, center, baseline, stretch).
AXIS
enumTypeScript enum for the drag or scroll axis constraint (both, x, y).
BLOCK
enumTypeScript enum for block-axis anchor positions used in overlay and floating element placement (top, bottom).
Layout & Sizing
BREAKPOINTS
enumTypeScript enum for responsive breakpoint tiers used in the grid system (xs, sm, md, lg, xl, xxl).
COLS
enumGrid column span values (1–12) used by the OrigamCol component to set its width within a 12-column grid.
DENSITY
enumCamelcase editorial update
DIMENSIONS
enumEnumeration of the six dimension prop keys supported by IDimensionProps and consumed by useDimension().
DIRECTION
enumTwo-axis direction enum used by scrollable or swipeable components to constrain movement to horizontal or vertical.
FLEX_DIRECTION
enumCSS flex-direction values exposed as a TypeScript enum. Used by OrigamRow to control the main axis of a grid row.
INLINE
enumHorizontal anchor axis values (left, right) used for overlay positioning.
JUSTIFY
enumHorizontal alignment / justify-content values for flex/grid containers.
LOCATION_STRATEGIES
enumPositioning strategy for floating overlays: static (document flow) or connected (anchored to an activator).
MODE
enumScroll / expand axis for components like InfiniteScroll and Transition (horizontal, vertical, shift).
POSITION
enumTypeScript enum for CSS position strategy — static, relative, fixed, absolute, or sticky.
ROW_GUTTER
enumNamed grid-gutter rungs for OrigamRow. A rung is the TOTAL space between two neighbouring columns: each OrigamCol pads half of it on each side, and the row pulls back half of it as a negative margin so the outer edge of the grid sits flush with its container.
SIZES
enumTypeScript enum for component size scale (x-small, small, default, large, x-large).
START_END
enumTypeScript enum for logical inline placement — start or end.
Masonry
Media
Navigation
BOTTOM_NAV_POSITION
enumTypeScript enum for horizontal placement of the BottomNav bar when it does not span full width (start, center, end).
INFINITE_SCROLL_MODE
enumTrigger mode for OrigamInfiniteScroll: intersection-observer or manual button.
INFINITE_SCROLL_SIDE
enumWhich side(s) of the scroll container can trigger loading (start, end, both).
INFINITE_SCROLL_STATUS
enumCurrent fetch status emitted by OrigamInfiniteScroll (ok, empty, loading, error).
TAB_VARIANT
enumTypeScript enum for the visual variant of the Tabs component — default, pills, underline.
NumberFormat
PasswordField
Shape & Appearance
BORDER_STYLE
enumTypeScript enum mirroring CSS border-style values (none, hidden, dotted, dashed, solid, double, groove, ridge, inset, outset).
ROUNDED
enumTypeScript enum for corner radius tokens (x-small through x-large, shaped, shaped-invert).
VARIANT
enumTypeScript enum for component visual variants (text, flat, elevated, tonal, outlined, plain, ghost).