IBorderProps

interface
Border & Shape

Full border contract — shorthand plus per-side, logical (block/inline), color and style props, consumed via useBorder().borderClasses and borderStyles.

TypeScript

Definition

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

typescript

API

Properties

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

border
boolean | number | string | TDirectionBoth | Array<TDirectionBoth>
Shorthand border — true enables all sides, a number sets width in px, a string sets the full CSS value, or a direction / array of directions.
borderTop
boolean | number | string
Top border — true, a px width or a full CSS border value.
borderLeft
boolean | number | string
Left border — true, a px width or a full CSS border value.
borderBottom
boolean | number | string
Bottom border — true, a px width or a full CSS border value.
borderRight
boolean | number | string
Right border — true, a px width or a full CSS border value.
borderBlock
boolean | number | string
Logical block-axis border (top + bottom in horizontal writing modes).
borderInline
boolean | number | string
Logical inline-axis border (left + right in horizontal writing modes).
borderInlineStart
boolean | number | string
borderInlineEnd
boolean | number | string
borderBlockStart
boolean | number | string
borderBlockEnd
boolean | number | string
borderColor
string
Border color — a CSS color value or a design token name.
borderStyle
string
Border style — solid, dashed, dotted, etc.
borderTopColor
TColor
borderRightColor
TColor
borderBottomColor
TColor
borderLeftColor
TColor
borderInlineStartColor
TColor
borderInlineEndColor
TColor
borderBlockStartColor
TColor
borderBlockEndColor
TColor

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Card with dashed primary border

vue