Motion

ImagesBadge.

A small collection, ready to unfold.

Accent

Glow intensity

Size

Reduced motion

tsx

import { ImagesBadge } from "luminescent";
import "luminescent/style.css";


export function Example() {
  return (
    <ImagesBadge
      text="Project gallery"
      images={["/sample1.jpg", "/sample2.jpg"]}
      href="#gallery"
    />
  );
}

Installation

bash

npm install luminescent

Import luminescent/style.css once at your application root. The example above uses the same package implementation as Storybook.

Variants and states

Use the preview controls to explore the supported variants, sizes, disabled/loading states and reduced motion. Controls appear only where the component exposes the corresponding prop. Theme and glow apply to every component.

API reference

Generated from the source TypeScript interfaces. Native attributes, className, style, aria-* and data-* also pass through to the documented element. Import ImagesBadgeProps from the package for the full inherited contract.

Prop	Type	Details
`text`required	`string`	Optional unless marked required.
`images`required	`string[]`	Optional unless marked required.
`href`	`string`	Optional unless marked required.
`target`	`string`	Optional unless marked required.
`textPosition`	`'top' \| 'bottom' \| 'left' \| 'right'`	Optional unless marked required.
`size`	`'sm' \| 'md' \| 'lg'`	Optional unless marked required.
`baseWidth`	`number`	Optional unless marked required.
`imageSize`	`{ width: number; height: number }`	Optional unless marked required.
`glowColor`	`GlowColor`	Optional unless marked required.

Accessibility and keyboard

The label names the collection; preview images are decorative. Linked badges unfold on keyboard focus as well as hover. With no href the badge is display-only. At most three images are shown.

Keep labels meaningful and test application-level contrast, focus order and screen-reader output. See the accessibility guide for composition requirements.

Theme customization

tsx

import { LuminescentProvider, ImagesBadge } from "luminescent";
import "luminescent/style.css";


export function Example() {
  return (
    <LuminescentProvider theme="light" accent="violet" glow="subtle">
      <ImagesBadge
        text="Project gallery"
        images={["/sample1.jpg", "/sample2.jpg"]}
        href="#gallery"
      />
    </LuminescentProvider>
  );
}

Switch between light and dark in the preview, or open the playground for a larger workspace. Custom CSS variables can override spacing, color, typography and effects.