To Keep It Going, Please Show Your Love.Buy Me a Coffee at

Svelte Radix

sponsor npm Created by Shin Okada License npm

310+ SVG Radix icons components for Svelte.

Repo #

GitHub Repo

Installation #

pnpm i -D svelte-radix

Usages #

In a svelte file:

  import { Accessibility, ActivityLog, AlignBaseline } from 'svelte-radix';

<Accessibility />
<ActivityLog />
<AlignBaseline />

Faster compiling #

If you need only a few icons from this library in your Svelte app, import them directly. This can optimize compilation speed and improve performance by reducing the amount of code processed during compilation.

  import ActivityLog from 'svelte-radix/ActivityLog.svelte';

<ActivityLog />

Props #

  • size = ctx.size || ‘24’;
  • role = ctx.role || ‘img’;
  • color = ctx.color || ‘currentColor’;
  • ariaLabel = ‘file name’;
  • withEvents = false

IDE support #

If you are using an LSP-compatible editor, such as VSCode, Atom, Sublime Text, or Neovim, hovering over a component name will display a documentation link, features, props, events, and an example.

Size #

Use the size prop to change the size of icons.

<Accessibility size="40" />
<ActivityLog size="50" />
<AlignBaseline size="60" />

If you are using Tailwind CSS, you can add a custom size using Tailwind CSS by including the desired classes in the class prop. For example:

<ActivityLog class="shrink-0 h-20 w-20" />

Setting Global Icon using setContext #

You can establish global icon preferences in your Svelte application using setContext. This allows you to configure icon-related properties once and share them across multiple components. Here’s how you can do it:

  import { setContext } from 'svelte';

  // Define your global icon settings
  const iconCtx = {
    strokeWidth: '1.5',
    size: '100', // Icon size in pixels
    color: '#ff4488' // Icon color in hexadecimal or CSS color name
  setContext('iconCtx', iconCtx);

The size, color, and role properties are optional, allowing you to fine-tune the appearance and accessibility of your icons as needed.

If you set size, icons can be customized with different colors. For example:

  import { setContext } from 'svelte';
  import { ActivityLog } from 'svelte-radix';
  const iconCtx = {
    size: '50'
  setContext('iconCtx', iconCtx);

<ActivityLog color="#ff4488" />

Remember that you can set only one or two of these properties, allowing you to tailor icon settings to your specific design and accessibility requirements.

Feel free to mix and match these properties as needed to create visually appealing and accessible icons in your Svelte application.

Creating a Default Icon Setting #

You can create a config file, /src/lib/icon.config.json.

The Icon component serves as a wrapper for svelte:component, allowing you to establish a global default setting or expand the capabilities of a component.

To create a default global icon setting, follow these steps:

Configuration File #

Start by creating a configuration file named /src/lib/icon.config.json with the following structure:

  "config1": {
    "size": 40,
    "color": "#FF5733"
  "config2": {
    "size": 50,
    "color": "#445533"

In this JSON file, you can define different configurations (config1 and config2 in this case) for your icons, specifying attributes like size, variation, and color.

Implementation #

In your Svelte page file, make use of the configurations from the JSON file:

<script lang="ts">
  type IconConfig = {
    config1: {
      size: number;
      color: string;
    config2: {
      size: number;
      color: string;
  import config from '$lib/icon.config.json';
  import { Icon, Accessibility, ActivityLog } from 'svelte-radix';

  const iconConfig: IconConfig = config;
  const config1 = iconConfig.config1;
  const config2 = iconConfig.config2;

<Icon {...config1} icon="{Accessibility}" />
<Icon {...config2} icon="{ActivityLog}" />

We import the configurations from the JSON file and assign them to config1 and config2. We then utilize the Icon component with the spread attributes {...config1} and {...config2} to apply the respective configurations to each icon.

Custom Default Icon #

If you wish to create a custom default icon, you can follow these steps:

Create a Svelte component named src/lib/MyIcon.svelte:

<script lang="ts">
  import type { ComponentType } from 'svelte';
  const config = {
    size: 30,
    color: '#FF5733'
  import { Icon } from 'svelte-radix';
  export let icon: ComponentType;

<Icon {...config} {icon} />

This component, MyIcon.svelte, accepts an icon prop which you can use to pass in the specific icon component you want to display. The default configuration is also applied to the icon.

Implementation in a Page #

To use your custom default icon in a Svelte page, do the following:

  import MyIcon from '$lib/MyIcon.svelte';
  import { Accessibility } from 'svelte-radix';

<MyIcon icon="{Accessibility}" />

Here, we import the MyIcon component and the Accessibility icon. By passing the Accessibility icon to the icon prop of MyIcon, you apply the default configuration to the icon.

CSS HEX Colors #

Use the color prop to change colors with HEX color code.

<Accessibility color="#c61515" />
<ActivityLog color="#3759e5" />
<AlignBaseline color="#3fe537" />

CSS framworks suport #

You can apply CSS framework color and other attributes directly to the icon component or its parent tag using the class prop.

Tailwind CSS example:

<Accessibility class="h-24 w-24 text-blue-700 mr-4" />

Bootstrap examples:

<Accessibility class="position-absolute top-0 px-1" />

Dark mode #

If you are using the dark mode on your website with Tailwind CSS, add your dark mode class to the class prop.

Let’s use dark for the dark mode class as an example.

<Accessibility class="text-blue-700 dark:text-red-500" />

aria-label #

All icons have aria-label. For example Accessibility has aria-label="accessibility". Use ariaLabel prop to modify the aria-label value.

<Accessibility ariaLabel="accessibility icon" />

Unfocusable icon #

If you want to make an icon unfocusable, add tabindex="-1".

<Accessibility tabindex="-1" />

Events #

Add the withEvents props if you want the following events forwarding:

  • on:click
  • on:keydown
  • on:keyup
  • on:focus
  • on:blur
  • on:mouseenter
  • on:mouseleave
  • on:mouseover
  • on:mouseout

Passing down other attributes #

You can pass other attibutes as well.

<Accessibility tabindex="0" />

Using svelte:component #

  import { Accessibility } from 'svelte-radix';

<svelte:component this="{Accessibility}" />

Using onMount #

  import { Accessibility } from 'svelte-radix';
  import { onMount } from 'svelte';
  const props = {
    size: '50',
    color: '#ff0000'
  onMount(() => {
    const icon = new Accessibility({ target: document.body, props });

Import all #

Use import * as Icon from 'svelte-radix.

  import * as Icon from 'svelte-radix';

<Icon.Accessibility />
<Icon.ActivityLog />

<Icon.Accessibility size="30" />
<Icon.ActivityLog size="40" />

<h1>CSS HEX color</h1>
<Icon.Accessibility color="#c61515" size="40" />

<h1>Tailwind CSS</h1>
<Icon.Accessibility class="text-blue-500" />
<Icon.ActivityLog class="text-pink-700" />

Original source #


License #

svelte-radix License

radix-ui/icons LICENSE

Other icons #