ICommonsComponentProps

interface
Utilities

Base prop contract shared by most Origam components. Provides id, class, and style pass-through so consumers can always decorate the root element.

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.

id
string
HTML id attribute forwarded to the component root element.
class
string | Array<string> | object
Extra CSS classes merged onto the component root — same shapes as Vue's :class binding.
style
string | Array<string> | object | StyleValue
Inline style forwarded to the component root — same shapes as Vue's :style binding.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Extending ICommonsComponentProps for a component

typescript