ICardProps

interface
Card

Full 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).

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

contentDisplay
TCardContentDisplay
disabled
boolean
Puts the card in a disabled state — mutes pointer events and reduces visual opacity.
flat
boolean
Removes the elevation shadow, rendering the card flush with its container.
hover
boolean
Force-enables the hover visual state (shadow lift + cursor pointer) without waiting for pointer entry.
image
string
URL of an image rendered as the card background.
link
boolean
Renders the card as a navigable link surface (adds cursor pointer and focuses via href/to).
subtitle
string | number
Secondary text line rendered below the title in the built-in header.
text
string | number
Body text rendered inside the built-in card text area.
title
string | number
Headline text rendered in the built-in card header.
type
TCardType
Card type variant — controls layout and semantic role (e.g. outlined, tonal, elevated).
titleId
string

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Feature card with color, elevation and image

vue