@deepsouthsoftware/aicon

React component for AI-generated icons.

Installation

npm install @deepsouthsoftware/aicon

Getting Your API Key

1. Sign up at aicon.deepsouthsoftware.com
2. Go to your dashboard
3. Navigate to API Keys
4. Generate a new key

Basic Usage

import { AIcon } from '@deepsouthsoftware/aicon';

function App() {
  return (
    <AIcon
      name="rocket"
      apiKey="your-api-key"
      variant="flat"
      color="#FFFFFF"
      size={32}
    />
  );
}

or use a previously generated icon from your dashboard

import { AIcon } from '@deepsouthsoftware/aicon';

function App() {
  return (
    <AIcon
      id="generated_image_id_from_dashboard"
      apiKey="your-api-key"
      size={32}
    />
  );
}

Props

| Prop | Type | Required | Default | Description | |------|------|----------|---------|-------------| | name | string | No | - | USED FOR GENERATION Icon description (e.g., "rocket", "home") | | id | string | No | - | USED FOR EXISTING ICONS Unique icon ID | | apiKey | string | Yes | - | Your Publishable API key | | variant | string | No | 'flat' | 'minimalist', 'flat', '3d', 'line-art', 'gradient' | | size | number | No | 24 | Icon size in pixels | | color | string | No | - | Icon color (any CSS color) | | className | string | No | - | CSS class names | | fallback | ReactNode | No | - | Custom loading/error UI | | onLoad | function | No | - | Called when icon loads | | onError | function | No | - | Called on error |

Environment Variables

Store your API key in environment variables:

NEXT_PUBLIC_AICON_API_KEY=your-api-key

<AIcon
  id="generated_image_id_from_dashboard"
  apiKey={process.env.AICON_API_KEY}
/>

Support

• Website: aicon.deepsouthsoftware.com
• Email: [email protected]