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.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- borderboolean | 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.
- borderTopboolean | number | string
- Top border — true, a px width or a full CSS border value.
- borderLeftboolean | number | string
- Left border — true, a px width or a full CSS border value.
- borderBottomboolean | number | string
- Bottom border — true, a px width or a full CSS border value.
- borderRightboolean | number | string
- Right border — true, a px width or a full CSS border value.
- borderBlockboolean | number | string
- Logical block-axis border (top + bottom in horizontal writing modes).
- borderInlineboolean | number | string
- Logical inline-axis border (left + right in horizontal writing modes).
- borderInlineStartboolean | number | string
- borderInlineEndboolean | number | string
- borderBlockStartboolean | number | string
- borderBlockEndboolean | number | string
- borderColorstring
- Border color — a CSS color value or a design token name.
- borderStylestring
- Border style — solid, dashed, dotted, etc.
- borderTopColorTColor
- borderRightColorTColor
- borderBottomColorTColor
- borderLeftColorTColor
- borderInlineStartColorTColor
- borderInlineEndColorTColor
- borderBlockStartColorTColor
- borderBlockEndColorTColor
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