LigatureIcon

Data Display
stable

Renders a Material Design ligature icon by placing the icon name as text content inside an element styled with the Material Icons font.

Preview

Rendering the live preview…

home

Rendering the live preview…

primary

Rendering the live preview…

danger

Rendering the live preview…

x-large

Structure

Anatomy

Visual breakdown of the component's internal structure with BEM class call-outs.

Anatomy of OrigamLigatureIconSchematic of the LigatureIcon component with 2 numbered internal parts. home 1 2 origam-icon origam-icon--ligature
Anatomy of <origam-ligature-icon> — 2 parts: the root element styled with the Material Icons ligature font, and the text content node that holds the ligature name.
1.origam-icon.origam-icon--ligature
Root element. Carries both .origam-icon and .origam-icon--ligature. The SCSS rule sets font-family: "Material Icons", "Material Symbols Outlined" and enables font-feature-settings: "liga".
2.origam-icon--size-{size}
Optional size modifier class (e.g. .origam-icon--size-large). Applied only for named TSize values; numeric sizes use an inline font-size style instead.

API

Props

All props accepted by this component, with their type, default value and description.

icon
The ligature name rendered as text content, e.g. "home" for Material Icons. The font resolves the glyph via font feature liga.
color
Text color (foreground) of the icon. Accepts a semantic intent or a CSS color value.
bgColor
Background color of the icon container.
id
string
class
string | Array<string> | object
disabled
boolean
false
Renders the icon in a disabled (muted) visual state.
style
string | Array<string> | object | StyleValue
tag
string
'div'
HTML element rendered at the root. Common alternatives: span, i.
Named size token (x-small, small, default, large, x-large) or a raw number (converted to px). Controls font-size and line-height.
padding
boolean | number | string
paddingTop
boolean | number | string
paddingLeft
boolean | number | string
paddingBottom
boolean | number | string
paddingRight
boolean | number | string
paddingBlock
boolean | number | string
paddingInline
boolean | number | string
paddingInlineStart
boolean | number | string
paddingInlineEnd
boolean | number | string
paddingBlockStart
boolean | number | string
paddingBlockEnd
boolean | number | string
margin
boolean | number | string
marginTop
boolean | number | string
marginLeft
boolean | number | string
marginBottom
boolean | number | string
marginRight
boolean | number | string
marginBlock
boolean | number | string
marginInline
boolean | number | string
marginInlineStart
boolean | number | string
marginInlineEnd
boolean | number | string
marginBlockStart
boolean | number | string
marginBlockEnd
boolean | number | string
border
boolean | number | string | TDirectionBoth | Array<TDirectionBoth>
false
Applies a border around the icon container.
borderTop
boolean | number | string
borderLeft
boolean | number | string
borderBottom
boolean | number | string
borderRight
boolean | number | string
borderBlock
boolean | number | string
borderInline
boolean | number | string
borderInlineStart
boolean | number | string
borderInlineEnd
boolean | number | string
borderBlockStart
boolean | number | string
borderBlockEnd
boolean | number | string
borderColor
string
borderStyle
string
borderTopColor
TColor
borderRightColor
TColor
borderBottomColor
TColor
borderLeftColor
TColor
borderInlineStartColor
TColor
borderInlineEndColor
TColor
borderBlockStartColor
TColor
borderBlockEndColor
TColor
height
number | string
Overrides the icon container height.
maxHeight
number | string
maxWidth
number | string
minHeight
number | string
minWidth
number | string
width
number | string
Overrides the icon container width.
Border-radius token or boolean for the icon container.
roundedTopRight
boolean | number | string
roundedTopLeft
boolean | number | string
roundedBottomLeft
boolean | number | string
roundedBottomRight
boolean | number | string
roundedStartStart
boolean | number | string
roundedStartEnd
boolean | number | string
roundedEndStart
boolean | number | string
roundedEndEnd
boolean | number | string

API

Exposed members

Properties and methods accessible via template ref (defineExpose). Use them for programmatic control.

<T extends object>(props: T, exclude?: string[]) => Partial<T>
Utility to forward a filtered subset of props to a child component.
Ref<string>
Reactive CSS string generated by useStyle from computed icon styles.
string
Unique style-sheet ID for this instance.
() => void
Injects the computed style sheet into the document.
() => void
Removes the injected style sheet.
Ref<boolean>
True once the style sheet has been injected into the DOM.

Customisation

CSS variables

CSS custom properties exposed by this component. Override them to customise the component without losing theme compatibility.

Icon color. Inherits currentColor by default, overridden by the color prop.
Font size for the default size variant.
Transition duration for color and opacity changes.

Inclusion

Accessibility

ARIA roles, keyboard navigation and focus management. Sourced from the real component template.

Notes

  • Decorative icons should carry aria-hidden="true" on the parent wrapper to hide them from assistive technologies.
  • Requires the Material Icons or Material Symbols Outlined font to be loaded in the page. Without the font, the raw ligature text string is shown instead of the glyph.

Foundation

Design tokens

Excerpt from this component's token declarations — the --origam-<component>---<property> variables, declared in its hand-maintained token sheet with no build step.

Source
color
currentColor
Default icon color. Inherits currentColor so the icon automatically matches surrounding text.
dimension
var(--origam-font__size---md)
Font size for the default size variant.
dimension
var(--origam-font__size---lg)
Font size for the large size variant.
color
var(--origam-color__action--primary---bg)
Icon color when color="primary".
color
var(--origam-color__text---disabled)
Icon color when disabled.

Interactive

Playground

Edit props live and see the component update in real time. The generated code snippet updates as you change values.

Rendering the live preview…

Usage

Examples

Ready-to-paste code snippets for your templates.

Basic ligature icon

vue

Size variants

vue

Ecosystem

Family

Components from the same folder that share conventions and often compose together.