untitledui-js-base/README.md

A simple library with a fully customizable collection of untitledui icons with out of the box support for framer motion

⚠️ **Deprecation Notice** ⚠️  
**`untitledui-js-base` would soon be deprecated.** Please migrate to `untitledui-js` for continued support and updates.  
Active maintenance for `untitledui-js-base` will cease on **January 27, 2025**. [Jump to Migration Guide →](#migration-guide)

## Features

✅ 1100+ Untitled UI style icons  
✅ Full SVG customization  
✅ Framer Motion integration (React)  
✅ Multi-framework support:

- React 17+
- Vue 3+
- SolidJS 1+
- Qwik 1+

## Why Migrate?

| Feature           | `untitledui-js-base` | `untitledui-js` |
| ----------------- | -------------------- | --------------- |
| Animation Support | Basic                | Advanced        |
| Tree Shaking      | Partial              | Full            |
| Framework Support | React Only           | 4 Frameworks    |
| Maintenance Ends  | 2024-01-01           | Ongoing         |

## Migration Guide

### 1. Uninstall Legacy Package

```bash
npm uninstall untitledui-js-base
```

### 2. Install New Package

```bash
npm install untitledui-js
```

### 3. Update Imports

```diff
// React
- import { Activity } from 'untitledui-js-base';
+ import { Activity } from 'untitledui-js/react';

// Vue 3
+ import { Activity } from 'untitledui-js/vue';

// SolidJS
+ import { Activity } from 'untitledui-js/solid';

// Qwik
+ import { Activity } from 'untitledui-js/qwik';
```

### 4. Animation API Changes

```tsx
// Legacy Pattern
<Activity
  pathProps={{
    animate: { rotate: 360 },
  }}
/>;

// New Pattern
import { motion } from "motion/react";

<Activity
  animation={{
    motion: motion,
    attributes: {
      svg: {
        initial: { scale: 0.9 },
        animate: { scale: 1 },
        transition: { duration: 0.3 },
      },
    },
  }}
/>;
```

Support Timeline

| Period           | untitledui-js-base | untitledui-js    |
| ---------------- | ------------------ | ---------------- |
| Jan 27th, 2025 + | No updates         | Priority support |