foamicons 0.10.2 → 1.0.1

package/llms.txt

@@ -0,0 +1,74 @@
+# Foamicons
+
+React SVG icon library with 236+ icons and 14 brand logos in three styles.
+
+## Naming
+
+- All component names are PascalCase.
+- Base (stroked) icons have no suffix: `Bell`
+- Duotone variant: `BellDuotone`
+- Filled variant: `BellFill`
+- Logos use `Logo` prefix: `LogoInstagram`
+  - Dark variant: `LogoInstagramDark`
+  - Fill variant (currentColor): `LogoInstagramFill`
+
+## Aliases
+
+Many icons have semantic aliases (e.g. `Settings` -> `Cog`, `Home` -> `House`).
+Aliases are valid imports but canonical names are preferred in generated code.
+Aliases apply to all variants: `Settings`, `SettingsDuotone`, `SettingsFill`.
+
+## Metadata (machine-readable)
+
+Read the catalog instead of parsing dist/index.js:
+
+```js
+import catalog from 'foamicons/catalog';   // { version, icons, logos, deprecated }
+import aliases from 'foamicons/aliases';     // { alias: canonical }
+import tags from 'foamicons/tags';           // { canonical: [tags] }
+import deprecations from 'foamicons/deprecations'; // { old: new }
+```
+
+Each catalog entry has: name, kind, variants, aliases, tags.
+
+## Typed helpers (runtime)
+
+```ts
+import {
+  iconNames,        // readonly string[] of all icon component names
+  logoNames,        // readonly string[] of all logo component names
+  allNames,         // combined
+  baseIconNames,    // base names without variant suffixes
+  baseLogoNames,    // base logo names without variant suffixes
+  iconAliases,      // { canonical: [aliases] }
+  aliasToCanonical, // { alias: canonical }
+  iconTags,         // { canonical: [tags] }
+  getCanonicalName, // (nameOrAlias) => canonical
+} from 'foamicons';
+
+// TypeScript types
+import type { IconName, LogoName, BaseIconName, BaseLogoName } from 'foamicons';
+```
+
+## Usage
+
+```tsx
+import { Bell, BellDuotone, BellFill } from 'foamicons';
+
+<Bell className="h-4 w-4" />
+<BellDuotone secondaryOpacity={0.4} />
+<BellFill size={24} />
+```
+
+## Props
+
+size (default 16), strokeWidth (default 1), absoluteStrokeWidth (default true),
+color, secondaryColor, secondaryOpacity (default 0.4), className, ...SVGProps.
+
+## Available icons (236 base icons, each with base/Duotone/Fill variants)
+
+Activity, Alert, Archive, ArchiveArrowUp, ArrowDown, ArrowDown01, ArrowDown10, ArrowDownCog, ArrowDownIG, ArrowDownLeft, ArrowDownMapPin, ArrowDownNarrowWide, ArrowDownRight, ArrowDownSC, ArrowDownTT, ArrowDownUp, ArrowDownWideNarrow, ArrowDownYT, ArrowLeft, ArrowRight, ArrowRightToLine, ArrowUp, ArrowUpAZ, ArrowUpCog, ArrowUpIG, ArrowUpLeft, ArrowUpMapPin, ArrowUpNarrowWide, ArrowUpRight, ArrowUpSC, ArrowUpTT, ArrowUpWideNarrow, ArrowUpYT, ArrowUpZA, AtSign, AudioLines, BadgeCheckbox, Ban, Bell, Bold, Bookmark, Brain, Calendar, ChartArea, ChartBarStacked, ChartColumn, ChartColumnSquare, ChartNetwork, ChartNoAxesCombined, ChartPie, Checkbox, Checkmark, ChevronDown, ChevronLeft, ChevronRight, ChevronUp, ChevronUpDown, Circle, CircleAlert, CircleCheck, CircleDashed, CircleDollarSign, CircleOverlap, CirclePlus, CircleQuestionMark, CircleX, ClipboardList, Clock, ClockArrowDown, ClockArrowUp, ClosedCaption, Cog, Columns3, Command, ContentHeart, ContentPlus, ContentUser, Copy, Download, Eclipse, Ellipsis, EllipsisVertical, ExternalLink, Eye, EyeOff, File, FileArrowDown, FileArrowLeft, FileArrowLeftRight, FileArrowRight, FileArrowUp, FileChartColumn, FileCheck, FileCog, FileImage, FilePlus, FileUser, FileX, Flame, Folder, FolderChartColumn, FolderCheck, FolderCog, FolderPlus, FolderX, Frown, Fullscreen, GalleryHorizontal, GalleryHorizontalEnd, GalleryThumbnails, GalleryVertical, GalleryVerticalEnd, Globe, Grip, GripHorizontal, GripVertical, Heart, HeartPulse, History, Hotspot, House, Image, Images, Inbox, Info, Italic, LayoutDashboard, LayoutGrid, LayoutList, LayoutPanelBottom, LayoutPanelLeft, LayoutPanelRight, LayoutPanelTop, LayoutRows, LayoutTemplate, Link, List, ListFilter, ListIndentDecrease, ListIndentIncrease, ListOrdered, LoaderCircle, Lock, LogOut, Mail, MailMove, MailPlus, MapPin, Maximize, Megaphone, MegaphoneActive, Menu, MessageSquare, MessagesSquare, Minus, Moon, MousePointerClick, Move, Notebook, Office, Palette, PanelLeft, PanelLeftChevronLeft, PanelLeftChevronRight, PanelRight, Pause, Pencil, Pin, Play, Plus, Pointer, QuotationMarkLeft, QuotationMarkRight, Reach, Reel, RefreshCw, RefreshCwOff, RemoveFormatting, Reply, Rocket, Rolodex, RotateCcw, RotateCw, Save, Search, SearchUser, Share, Shield, ShieldCheck, ShieldOff, ShieldPlus, ShieldUser, ShieldX, Slash, SlidersHorizontal, Smile, Sparkles, Square, SquarePen, Star, Sun, Tag, Tags, Target, TextAlignCenter, TextAlignEnd, TextAlignJustify, TextAlignStart, ThumbsDown, ThumbsUp, ToolCase, Trash, TrashEmpty, TrendingDown, TrendingUp, TriangleDown, TriangleDownUp, TriangleUp, Unlink, Unlock, Unplug, Upload, User, UserArrowLeft, UserArrowLeftRight, UserArrowOutUpRight, UserArrowRight, UserCog, UserPlus, Users, Video, Volume2, VolumeOff, X, Zap, ZapOff
+
+## Available logos (14 logos, each with color/Dark/Fill variants)
+
+LogoFacebook, LogoFile, LogoFilePdf, LogoFileSheet, LogoFoam, LogoFoamSymbol, LogoGmail, LogoGoogle, LogoInstagram, LogoLinkedin, LogoMicrosoft, LogoSnapchat, LogoTiktok, LogoYoutube

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "foamicons",
-  "version": "0.10.2",
+  "version": "1.0.1",
   "description": "Foam icon library for React",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -16,15 +16,28 @@
         "types": "./dist/index.d.cts",
         "default": "./dist/index.cjs"
       }
+    },
+    "./catalog": {
+      "default": "./dist/catalog.json"
+    },
+    "./aliases": {
+      "default": "./dist/aliases.json"
+    },
+    "./tags": {
+      "default": "./dist/tags.json"
+    },
+    "./deprecations": {
+      "default": "./dist/deprecations.json"
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "llms.txt"
   ],
   "sideEffects": false,
   "scripts": {
     "generate": "tsx scripts/build-icons.ts",
-    "build": "pnpm run generate && tsup",
+    "build": "pnpm run generate && tsup && tsx scripts/build-metadata.ts",
     "test": "vitest run",
     "test:watch": "vitest",
     "prepublishOnly": "pnpm run build"