# PulsoIcon-Package (CityPulso/PulsoIcon-Package)

> An animated icon set for React, Vue, Svelte, Jetpack Compose and SwiftUI: about 9955 icons, each with its own hover motion, including Lucide icons and brand logos.

- GitHub: https://github.com/CityPulso/PulsoIcon-Package
- GitHub.Locker page: https://github.locker/CityPulso/PulsoIcon-Package
- Stars: 592
- Language: TypeScript
- Last push: 2026-11-13

## Questions and answers

Written by GitHub.Locker from the README and the repository; check the README below for details.

**Is it an icon font, or a library I import into my code?**

A library. Each icon is an imported component. In React it is a drop-in replacement for lucide-react, with the same component names and props.

**How do I switch my React project to it?**

Run 'npm install pulsoicon-react' and change the import from lucide-react. Component names and props stay the same, so usually only the import changes. The React package was called 'pulsoicon' up to 5.2.1, so older tutorials may use that name.

**Are there catches with the brand logos?**

Brand icons start with Brand (BrandGithub). Brands added in 4.0 need that prefix; brands up to 3.1 also work without it. The logos are simplified redraws and trademarks of their owners, so check each brand's own guidelines before using one.

**What do I install for Vue, Svelte, Android or iOS?**

Vue 3.5+: 'npm install pulsoicon-vue'. Svelte 5: 'npm install pulsoicon-svelte'. Android: the Jetpack Compose package 'com.citypulso:pulsoicon-compose' through Gradle. iOS and macOS: the SwiftUI Swift package. Any other framework: 'npm install pulsoicon-core'.

**Can I use it in a commercial closed-source product?**

Yes, under the ISC license. If you ship it, include PulsoIcon's LICENSE file, which also holds notices for Lucide, Tabler, Iconoir, Hugeicons and Phosphor, for example on a third-party notices page. Crediting PulsoIcon in the UI is optional.

**Can I turn the animation off or start it from code?**

Yes. animated={false} makes an icon fully static. autoAnimated={false} disables the hover trigger. The play prop, or the ref handle, lets your code start and stop the motion.

**Are there filled versions of the icons?**

Yes. Set solid to draw the filled version in colour. About 1,700 icons have a true filled drawing from Tabler or Phosphor; the rest fill their closed outline shapes and keep inner lines visible.

**Where do the icons come from?**

About 3,700 were drawn for this set, including about 2,770 line-art brand logos. The rest build on the shapes of Lucide, Tabler Icons and Iconoir, which are credited in the LICENSE file.

**Does it respect reduced motion settings?**

Yes. When the system asks for less motion, nothing moves and the icons stay still.


---

## README (checked against GitHub 2026-11-18)

Source: https://github.com/CityPulso/PulsoIcon-Package/blob/main/README.md

<p align="center">
  <img src="./logo.png" alt="PulsoIcon" width="160" />
</p>

<h1 align="center">PulsoIcon</h1>

<p align="center">
  <strong>9955 animated icons. Every one has its own motion.</strong><br />
  For React, Vue, Svelte, Solid, Preact, Angular, Astro, Jetpack Compose and SwiftUI. Icons come alive on hover; in React they replace lucide-react in one line.
</p>

<p align="center">
  <a href="https://www.npmjs.com/package/pulsoicon-react"><img src="https://img.shields.io/npm/v/pulsoicon-react?color=f2552c" alt="npm version" /></a>
  <a href="https://www.npmjs.com/package/pulsoicon-react"><img src="https://img.shields.io/npm/dm/pulsoicon-react?color=f2552c" alt="npm downloads" /></a>
  <a href="./LICENSE"><img src="https://img.shields.io/npm/l/pulsoicon-react?color=f2552c" alt="license" /></a>
</p>

<p align="center">
  <a href="https://pulsoicon.com"><strong>pulsoicon.com</strong></a>: browse all icons, try them live and copy the code ·
  <a href="https://pulsoicon.com/playground">Playground</a> ·
  <a href="https://pulsoicon.com/docs">Documentation</a>
</p>

<p align="center">
  <strong>Docs:</strong>
  <a href="./packages/react/README.md">React</a> ·
  <a href="./packages/vue/README.md">Vue</a> ·
  <a href="./packages/svelte/README.md">Svelte</a> ·
  <a href="./packages/solid/README.md">Solid</a> ·
  <a href="./packages/preact/README.md">Preact</a> ·
  <a href="./packages/angular/README.md">Angular</a> ·
  <a href="./packages/astro/README.md">Astro</a> ·
  <a href="./kotlin/README.md">Android (Compose)</a> ·
  <a href="./swift/README.md">iOS / macOS (SwiftUI)</a> ·
  <a href="./packages/core/README.md">Core data</a>
</p>

---

<p align="center">
  <img src="./PulsoIcon_README_Loop.gif" alt="PulsoIcon icons animating on hover" width="720" />
</p>

A bell rings. A calendar lifts its rings. A trash can opens its lid. A clock's hand goes round.

PulsoIcon gives every icon a motion written for that icon, not one effect stamped on all of them. At rest each icon is a clean 24×24 icon; it plays when someone hovers or focuses the button, link or tab it sits in.

Every one of the 9955 motions is written for this set. About 3,700 icons are drawn here, including the line-art brand logos; the rest build on the shapes of [Lucide](https://lucide.dev), [Tabler Icons](https://tabler.io/icons) and [Iconoir](https://iconoir.com), which are credited in [LICENSE](./LICENSE).

## Why PulsoIcon

- **9955 icons, each with its own motion**:
  - **About 3,700 drawn for this set**: about 2,770 line-art brand logos (CityPulso, GitHub, Slack, Spotify, OpenAI, Claude, TikTok, VS Code, Google Drive, …, most drawn after the logos collected by [Simple Icons](https://simpleicons.org)) and around 900 other icons, including lowercase a–z, animals, sports, 3D tools and icons drawn after [Phosphor](https://phosphoricons.com).
  - **Built on open icon sets**: all 2020 [Lucide](https://lucide.dev) icons (as of 1.68), plus the shapes of [Tabler Icons](https://tabler.io/icons) (3.50, including 264 brand logos) and [Iconoir](https://iconoir.com) (7.12).
  - **3042 brand logos** in all.
- **Switch in one line** (React): same component names as lucide-react (`Calendar`, `CalendarIcon`, aliases such as `AlertCircle`) and the same props. Usually you only change the import.
- **Ships only what you use**: every icon is its own module and the package is side-effect free, so bundlers keep the icons you import and drop the rest. Three icons add about 12 kB before minification.
- **Plays where people point**: hover or focus anywhere on a button, link, label, tab or menu item and its icon plays.
- **Respects reduced motion**: nothing moves when the system asks for less motion.
- **Every platform, one source**: React, Vue, Svelte, Solid, Preact, Angular, Astro, Jetpack Compose and SwiftUI draw the same icons with the same motion and take the same props.

## Packages

One version number covers every package.

| Platform                  | Install                                                                          | Guide                                          |
| ------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------- |
| React 18+                 | `npm install pulsoicon-react`                                                    | [React README](./packages/react/README.md)     |
| Vue 3.5+                  | `npm install pulsoicon-vue`                                                      | [Vue README](./packages/vue/README.md)         |
| Svelte 5                  | `npm install pulsoicon-svelte`                                                   | [Svelte README](./packages/svelte/README.md)   |
| Solid 1.8+                | `npm install pulsoicon-solid`                                                    | [Solid README](./packages/solid/README.md)     |
| Preact 10.11+             | `npm install pulsoicon-preact`                                                   | [Preact README](./packages/preact/README.md)   |
| Angular 19+               | `npm install pulsoicon-angular`                                                  | [Angular README](./packages/angular/README.md) |
| Astro 5+                  | `npm install pulsoicon-astro`                                                    | [Astro README](./packages/astro/README.md)     |
| Android (Jetpack Compose) | `implementation("com.citypulso:pulsoicon-compose:<version>")`                    | [Android README](./kotlin/README.md)           |
| iOS / macOS (SwiftUI)     | `.package(url: "https://github.com/CityPulso/PulsoIcon-Package.git", from: "<version>")` | [iOS / macOS README](./swift/README.md)        |
| Any other framework       | `npm install pulsoicon-core`                                                     | [Core README](./packages/core/README.md)       |

Each guide has the install, a quick start, every prop and how to play icons from code on that platform.

`pulsoicon-core` holds the icon data the web packages share; they install it for you. Until 5.2.1 the React package was called `pulsoicon`; from 6.0.1 it is `pulsoicon-react` (only the import changes).

## Quick start

React ([full guide](./packages/react/README.md)):

```tsx
import { Bell, Trash2 } from "pulsoicon-react";

<button><Bell size={20} /> Notifications</button>
<button><Trash2 color="crimson" strokeWidth={1.5} /> Delete</button>
```

Vue ([full guide](./packages/vue/README.md)):

```vue
<script setup lang="ts">
import { Bell } from "pulsoicon-vue";
</script>

<template>
  <button><Bell :size="20" /> Notifications</button>
</template>
```

Svelte ([full guide](./packages/svelte/README.md)):

```svelte
<script lang="ts">
  import { Bell } from "pulsoicon-svelte";
</script>

<button><Bell size={20} /> Notifications</button>
```

Solid ([full guide](./packages/solid/README.md)) and Preact ([full guide](./packages/preact/README.md)) take the same JSX as React, imported from `pulsoicon-solid` or `pulsoicon-preact`.

Angular ([full guide](./packages/angular/README.md)):

```ts
import { Bell, PulsoIconComponent } from "pulsoicon-angular";

@Component({
  imports: [PulsoIconComponent],
  template: `<button><pulso-icon [icon]="Bell" size="20" /> Notifications</button>`,
})
export class Toolbar {
  protected readonly Bell = Bell;
}
```

Astro ([full guide](./packages/astro/README.md)):

```astro
---
import Bell from "pulsoicon-astro/icons/bell";
---

<button><Bell size={20} /> Notifications</button>
```

Jetpack Compose ([full guide](./kotlin/README.md)):

```kotlin
val interactions = remember { MutableInteractionSource() }
IconButton(onClick = { /* … */ }, interactionSource = interactions) {
    PulsoIcon(PulsoIcons.Bell, contentDescription = "Notifications", interactionSource = interactions)
}
```

SwiftUI ([full guide](./swift/README.md)):

```swift
Button { /* … */ } label: {
    Label { Text("Notifications") } icon: { PulsoIconView(.bell, size: 20) }
}
```

Hover the button (press it, on Android) and its icon plays.

## Props

Every package takes the same props, with the same defaults and meaning (Kotlin and Swift spell the types their own way).

| Prop                  | Type               | Default        | Description                                                                                    |
| --------------------- | ------------------ | -------------- | ---------------------------------------------------------------------------------------------- |
| `size`                | `number \| string` | `24`           | Width and height                                                                               |
| `color`               | `string`           | `currentColor` | Stroke colour, and fill colour when `solid`                                                    |
| `strokeWidth`         | `number \| string` | `2`            | Stroke width on the 24-unit grid                                                               |
| `absoluteStrokeWidth` | `boolean`          | `false`        | Keep the stroke the same number of pixels at any size                                          |
| `solid`               | `boolean`          | `false`        | Filled icon instead of outline (see [Solid icons](#solid-icons))                               |
| `animated`            | `boolean`          | `true`         | `false` makes the icon fully static: nothing plays it, not even the ref or `play`              |
| `autoAnimated`        | `boolean`          | `true`         | Play the built-in hover / focus trigger. `false` turns that off; the ref and `play` still work |
| `play`                | `boolean`          |                | `true` plays the motion, `false` returns to rest. Works with or without `autoAnimated`         |

On the web, any other SVG attribute (`className` / `class`, `style`, `aria-label`, …) is passed to the `<svg>`. Icons render with `aria-hidden="true"`; give the surrounding button or link a label.

## When the animation plays

On the web, an icon plays when the pointer enters, or focus moves into, its closest `button`, `a`, `label`, `summary`, `[role="button"]`, `[role="link"]`, `[role="tab"]` or `[role="menuitem"]`. If there is none, the icon plays on its own hover.

Any other element can become the trigger with `data-icon-trigger`:

```tsx
<div className="card" data-icon-trigger>
  <MapPin /> 3 venues near you
</div>
```

On Android the icon plays with the control whose `interactionSource` you pass; on Apple platforms, while a pointer hovers it. Everywhere, `play` and the handle (`ref`, `bind:this`, `rememberPulsoIconHandle()`, `PulsoIconHandle`) play it from code, and nothing moves when the system asks for reduced motion.

## Solid icons

`solid` draws the filled version of an icon, in `color`:

```tsx
<Heart solid color="crimson" />
```

About 1,700 icons have a filled drawing taken from the [Tabler](https://tabler.io/icons) filled set or the [Phosphor](https://phosphoricons.com) fill weight. Their source file has a `solid` list and a "Solid from …" comment. The other icons fill their closed outline shapes and cut their inner lines out of the fill, so the details stay visible. Motions that draw a stroke on (`draw`, `redraw`, …) pop in instead on filled shapes.

## Finding icons

### Other names

Icons also answer to the names other icon sets use: `Gear` is `Settings`, `Magnifier` is `Search`, `Cart` is `ShoppingCart`, `World` is `Globe`, `DotsHorizontal` is `Ellipsis`, and so on. Every icon is also exported with an `Icon` suffix (`BellIcon`).

### Brand logos

Brand icons start with `Brand` (`BrandGithub`, `BrandSlack`, `BrandOpenai`, …). The brands added up to 3.1 are also exported without the prefix (`Github`, `Slack`); the ones added in 4.0 only with it, because many brand names are ordinary words. They are simplified line drawings made for this set, most of the newer ones drawn after the logos collected by [Simple Icons](https://simpleicons.org).

All product names, logos and brands are the property of their respective owners and are used here only to refer to those products or services. Their use does not imply endorsement. Follow each brand's own guidelines when you use its logo.

### All icons at once

Every icon also has a kebab-case name (`party-popper`), the same on every platform, for storing on your data. The web packages export `ICONS` / `ICON_NAMES` from `<package>/all`, the names alone from `<package>/names` and one icon from `<package>/icons/<name>`; Compose has `PulsoIcons.byKey("party-popper")` and SwiftUI `PulsoIcon.byKey("party-popper")`.

## Report a wrong icon

If an icon is drawn wrong, a brand logo doesn't match the real one, or a motion looks off, please email
**citypulso@gmail.com** with the icon name (for example `brand-avianca`) and, if you can, a screenshot or a link
to the correct logo. Issues on GitHub are welcome too.

## Contributing

```bash
npm install
npm run preview          # every gallery at once: React :10205, Vue :10206, Svelte :10207, Solid :10208,
                         # Preact :10209, Angular :10210, Astro :10211 (npm run preview -- vue for just one)
npm run gen              # after editing an icon: rewrites every platform's icon files from packages/core
npm test
npm run build
```

Each icon is one data file in `packages/core/src/icons/<name>.ts`, shared by every platform: the shapes of the icon and, for each shape, an optional motion (`r` recipe from `packages/core/src/recipes.ts`, `d` delay, `x`/`y` direction, `a` amplitude, `o` pivot point on the 24×24 grid). Edit that file to change how an icon moves, then run `npm run gen`. Other names live in `packages/core/src/aliases.ts`.

| Folder                                                        | What                                                                               |
| ------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `packages/core`                                               | `pulsoicon-core`: the icons, recipes, solid drawings and the framework-free player |
| `packages/react`, `vue`, `svelte`, `solid`, `preact`, `astro` | The web packages; their icon files are generated and committed                     |
| `packages/angular`                                            | The Angular library, built by ng-packagr; npm publishes its `dist/`                |
| `kotlin/`                                                     | The Android library (Gradle); `icons/` is generated and committed                  |
| `swift/` and `Package.swift`                                  | The Swift package; `Icons/` is generated and committed                             |
| `preview/`                                                    | One gallery per web framework; `preview/shared` holds what they share              |

The Kotlin and Swift recipes are written by hand; their tests check them against `packages/core` (`kotlin/`: `./gradlew :pulsoicon:testDebugUnitTest`; Swift: `swift test`). `npm run test:browser` plays icons in Chromium through React, Vue, Svelte, Solid and Preact side by side and checks that they move the same.

### Releasing

`package.json` at the root holds the one version of every package. `npm run set-version -- 6.1.0` sets it everywhere; push that to `main` and CI publishes the npm packages and the Maven artifact that are not out yet, then tags `6.1.0` for Swift Package Manager.

## License

PulsoIcon is open source under the [ISC license](./LICENSE) © CityPulso.

### What is ours, and what comes from other icon sets

| Part                                                                        | Origin                                                                           |
| --------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| Every animation (how each icon moves)                                       | Written for PulsoIcon                                                            |
| Runtime code (every package's components, triggers, motion recipes)         | Written for PulsoIcon                                                            |
| About 3,700 icons, including about 2,770 line-art brand logos               | Drawn for PulsoIcon                                                              |
| Shapes of the 2020 Lucide icons                                             | Based on [Lucide](https://lucide.dev) (ISC; some derived from Feather, MIT)      |
| Shapes of the icons marked "Adapted from Tabler Icons"                      | Based on [Tabler Icons](https://tabler.io/icons) (MIT)                           |
| Shapes of the icons marked "Adapted from Iconoir"                           | Based on [Iconoir](https://iconoir.com) (MIT)                                    |
| Five icons marked "Adapted from Hugeicons"                                  | Adapted from [Hugeicons](https://hugeicons.com) (MIT)                            |
| Icons marked "Drawn after Phosphor Icons"                                   | Redrawn after [Phosphor](https://phosphoricons.com) shapes (MIT)                 |
| Solid shapes marked "Solid from Tabler Icons" / "Solid from Phosphor Icons" | Taken from the Tabler filled set and the Phosphor fill weight (MIT)              |
| Brand icons marked "Drawn after Simple Icons"                               | Drawn after the logos collected by [Simple Icons](https://simpleicons.org) (CC0) |

Icons based on or drawn after Tabler Icons, Iconoir, Hugeicons, Phosphor or Simple Icons name their source in a comment at the top of their file; the Lucide icons keep their Lucide names. The full license texts are in [LICENSE](./LICENSE).

### Using PulsoIcon in your project

You may use PulsoIcon freely, including in commercial and closed-source products. The one condition, from ISC and the MIT licenses of the sets above, is the notice:

- **If you ship PulsoIcon** (in an app, a website bundle, a template or a library of your own), include PulsoIcon's [LICENSE](./LICENSE) file with it, for example on your "open-source licenses" or "third-party notices" page or in a `THIRD_PARTY_NOTICES` file. It already contains the notices of Lucide, Tabler Icons, Iconoir, Hugeicons and Phosphor.
- **If you copy or modify icons** from PulsoIcon into your own set, keep the source comment at the top of each file, and keep the LICENSE notices.
- You don't have to credit PulsoIcon inside your product's interface, although a link is always appreciated.

Brand logos are trademarks of their owners. Using a brand icon doesn't imply endorsement, and you should follow each brand's own guidelines.

