Skip to content

Icon

Renders an icon: an SVG path string (such as an @mdi/js export) drawn on a 24×24 viewBox, or any Svelte icon component rendered directly. Decorative by default. Pass aria-label or aria-labelledby to make it informative. It then gets role="img" instead of aria-hidden.

<script lang="ts">
import { mdiAlert } from '@mdi/js';
import Rocket from '@lucide/svelte/icons/rocket';
</script>
<Icon icon={mdiAlert} size="lg" />
<Icon icon={Rocket} aria-label="Launch" />
<Icon
  icon="M12,15.5A3.5,3.5 0 0,1 8.5,12A3.5,3.5 0 0,1 12,8.5A3.5,3.5 0 0,1 15.5,12A3.5,3.5 0 0,1 12,15.5M19.43,12.97C19.47,12.65 19.5,12.33 19.5,12C19.5,11.67 19.47,11.34 19.43,11L21.54,9.37C21.73,9.22 21.78,8.95 21.66,8.73L19.66,5.27C19.54,5.05 19.27,4.96 19.05,5.05L16.56,6.05C16.04,5.66 15.5,5.32 14.87,5.07L14.5,2.42C14.46,2.18 14.25,2 14,2H10C9.75,2 9.54,2.18 9.5,2.42L9.13,5.07C8.5,5.32 7.96,5.66 7.44,6.05L4.95,5.05C4.73,4.96 4.46,5.05 4.34,5.27L2.34,8.73C2.21,8.95 2.27,9.22 2.46,9.37L4.57,11C4.53,11.34 4.5,11.67 4.5,12C4.5,12.33 4.53,12.65 4.57,12.97L2.46,14.63C2.27,14.78 2.21,15.05 2.34,15.27L4.34,18.73C4.46,18.95 4.73,19.03 4.95,18.95L7.44,17.94C7.96,18.34 8.5,18.68 9.13,18.93L9.5,21.58C9.54,21.82 9.75,22 10,22H14C14.25,22 14.46,21.82 14.5,21.58L14.87,18.93C15.5,18.67 16.04,18.34 16.56,17.94L19.05,18.95C19.27,19.03 19.54,18.95 19.66,18.73L21.66,15.27C21.78,15.05 21.73,14.78 21.54,14.63L19.43,12.97Z"
  size="xl"
/>

icon accepts an SVG path string or a Svelte component. A string is the d attribute of a path on a 24 by 24 viewBox, which is what every @mdi/js export is. A component renders as is, so any icon library that ships Svelte components works.

  • size takes one of eight tokens, xs through 4xl, from iconSizes in packages/prime-ui/src/lib/Icon/icon.ts. Color follows currentColor.
  • Decorative by default: aria-hidden and not focusable. Add an aria-label when it stands alone.
  • Icon bundles no paths of its own. Your bundler keeps only the icons you import.
<script lang="ts">
import { mdiAlert } from "@mdi/js";
import { Icon } from "@viamrobotics/prime-ui";
</script>
<Icon icon={mdiAlert} />
<script lang="ts">
import Rocket from "@lucide/svelte/icons/rocket";
import { Icon } from "@viamrobotics/prime-ui";
</script>
<Icon icon={Rocket} />

The glyphs mdi has no equivalent for live at @viamrobotics/prime-ui/icons. Each is a Svelte component, so it works as icon or on its own.

<script lang="ts">
import { Icon } from "@viamrobotics/prime-ui";
import { ViamService } from "@viamrobotics/prime-ui/icons";
</script>
<Icon icon={ViamService} />
<ViamService class="size-6" />
Code
CustomComponent.svelte
<script lang="ts">
import Rocket from "@lucide/svelte/icons/rocket";
import { mdiAlertCircle } from "@mdi/js";
import { Icon } from "@viamrobotics/prime-ui";
import { ViamService } from "@viamrobotics/prime-ui/icons";
</script>
<div class="not-content flex items-center gap-4 text-default">
<Icon icon={ViamService} size="xl" />
<Icon icon={Rocket} size="xl" />
<Icon icon={mdiAlertCircle} size="xl" class="text-danger-dark" />
</div>

Sizes

xs sm base lg xl 2xl 3xl 4xl

Paths from @mdi/js

mdiCog mdiAlertCircle mdiInformation mdiCheckCircle mdiChevronUp mdiChevronDown

Viam glyphs from @viamrobotics/prime-ui/icons (a few of 25, see the migration table for the full list)

ViamService ViamLocalModule ViamRegistryModule ViamMixedPartStatus FilterOutline Magnet Resize

Any Svelte icon component (Lucide)

rocket sparkles bot cpu

Color follows currentColor

An icon with no visible text next to it needs a name. Pass aria-label or aria-labelledby, and the icon gets role="img" and stops being hidden from assistive technology.

<Icon icon={mdiAlert} aria-label="Warning" />

prime ships no general icon set. It ships only the Viam glyphs, under @viamrobotics/prime-ui/icons. For everything else, bring @mdi/js or another library and import only what you render.

class lands on the <svg>, next to the size class. Set color with a text-* token, since the paths fill with currentColor.

Icon takes an import, not a curated kebab-case name such as icon="cog". The Icons section of the migration page maps each old name to its @mdi/js export or Viam glyph.

Takes extraClasses, ...restProps }: Props as its props.