IColProps

interface
Layout

Props for OrigamCol — a responsive grid column that accepts breakpoint spans (cols/sm/md/lg/xl/xxl), column offsets, order, color and spacing.

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.

cols
TCols
Column span for all breakpoints (1–12 or "auto").
sm
TCols
Column span applied at the sm breakpoint and above.
md
TCols
Column span applied at the md breakpoint and above.
lg
TCols
Column span applied at the lg breakpoint and above.
xl
TCols
Column span applied at the xl breakpoint and above.
xxl
TCols
Column span applied at the xxl breakpoint and above.
offset
Omit<TCols, '12'>
Column offset for all breakpoints (1–11 or "auto").
offsetSm
Omit<TCols, '12'>
Column offset applied at the sm breakpoint and above.
offsetMd
Omit<TCols, '12'>
Column offset applied at the md breakpoint and above.
offsetLg
Omit<TCols, '12'>
Column offset applied at the lg breakpoint and above.
offsetXl
Omit<TCols, '12'>
Column offset applied at the xl breakpoint and above.
offsetXxl
Omit<TCols, '12'>
Column offset applied at the xxl breakpoint and above.
order
number
CSS order for all breakpoints.
orderSm
number
CSS order applied at the sm breakpoint and above.
orderMd
number
CSS order applied at the md breakpoint and above.
orderLg
number
CSS order applied at the lg breakpoint and above.
orderXl
number
CSS order applied at the xl breakpoint and above.
orderXxl
number
CSS order applied at the xxl breakpoint and above.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Responsive column with breakpoint spans

vue