@africanies/angular-web-sdk 0.1.12 → 0.1.13

package/.nx/cache/7730350229628359718/dist/libs/africanies-icons/README.md

@@ -0,0 +1,69 @@
+# @africanies/africanies-icons
+
+Typed SVG icon system for AFRICANIES apps. Icons ship as a **single sprite** plus an
+`IconName` union — not one Angular component per glyph.
+
+## Why a sprite?
+
+There are 600–1000+ icons in `/svg`. Generating a component (or HTTP request)
+per file would hurt bundle size, compile time, and runtime waterfalls. The build
+script packs every SVG into `icons.sprite.svg`; `IconRegistryService` fetches
+that file **once** and inlines it into the DOM so `<africanies-icon>` can use
+`<use href="#name">`.
+
+## Usage
+
+```ts
+import { AfricaniesIconComponent, AFRICANIES_ICON_SPRITE_URL } from '@africanies/africanies-icons';
+
+// Provide the URL where you serve the published sprite asset:
+providers: [
+  {
+    provide: AFRICANIES_ICON_SPRITE_URL,
+    useValue: '/assets/africanies-icons/icons.sprite.svg',
+  },
+],
+```
+
+```html
+<africanies-icon name="truck" />
+<africanies-icon name="search" [size]="32" />
+```
+
+### Serving the sprite
+
+After installing `@africanies/africanies-icons`, copy (or angular.json `assets` map) the
+published file:
+
+`node_modules/@africanies/africanies-icons/assets/icons.sprite.svg`
+→ `src/assets/africanies-icons/icons.sprite.svg`
+
+Then point {@link AFRICANIES_ICON_SPRITE_URL} at `/assets/africanies-icons/icons.sprite.svg`
+(the package default). Use a leading `/` so the sprite loads on nested routes.
+
+## Adding a new icon
+
+1. Drop a new `.svg` into the monorepo `/svg` folder (kebab-case filename;
+   spaces are normalized to hyphens).
+2. From the repo root run:
+
+```bash
+npm run icons:build
+```
+
+3. Commit the regenerated files:
+   - `libs/africanies-icons/src/assets/icons.sprite.svg`
+   - `libs/africanies-icons/src/lib/icon-name.ts` (`ICON_NAMES` + `IconName`)
+
+The new name appears in `ICON_NAMES` / `IconName` for autocomplete, type-checking,
+and the playground gallery.
+
+## Public API
+
+| Export | Role |
+| --- | --- |
+| `ICON_NAMES` | Generated `as const` array of every icon id (for galleries / iteration) |
+| `IconName` | `typeof ICON_NAMES[number]` — closed union for typed `name` inputs |
+| `AfricaniesIconComponent` | `<africanies-icon name="…">` |
+| `IconRegistryService` | Fetches/inlines the sprite once |
+| `AFRICANIES_ICON_SPRITE_URL` | InjectionToken for the sprite URL |