@snacky/ui 0.3.2 → 0.3.4

package/dist/index.d.cts

@@ -367,12 +367,30 @@ declare function Avatar({ src, alt, size, className }: AvatarProps): react.JSX.E
 type IllustrationVariant = 'empty' | 'createAccount' | 'welcome' | 'success' | 'discountReferral';
 interface IllustrationProps {
     variant: IllustrationVariant;
-    /** Host your own export of this illustration (this package ships no artwork). */
+    /** Your own export of this illustration - this package ships no artwork. */
     src: string;
     alt: string;
     className?: string;
 }
-/** Snacky Illustration - decorative spot illustration for empty states, onboarding, confirmations. */
+/**
+ * Snacky Illustration - decorative spot illustration for empty states,
+ * onboarding and confirmations.
+ *
+ * ```tsx
+ * <Illustration variant="empty" src="/img/empty.svg" alt="No products found" />
+ * ```
+ *
+ * This ships no artwork, deliberately, and that is the normal split - Material,
+ * Radix and Chakra ship none either. What belongs in a design system is the
+ * documented canvas size per variant, which is what this owns; the Snacky
+ * artwork itself is modified stock and is not ours to redistribute.
+ *
+ * Export your own at the variant's ratio (SVG preferred) and serve it wherever
+ * your app already serves static assets. Open Peeps (openpeeps.com) is CC0 and
+ * drops in cleanly; unDraw (undraw.co) is free without attribution but its
+ * licence forbids redistributing assets "in packs", so keep it inside your own
+ * app. See the package README for the fuller note.
+ */
 declare function Illustration({ variant, src, alt, className }: IllustrationProps): react.JSX.Element;
 
 type ProductImageUsage = 'product-card' | 'product-details' | 'list' | 'review' | 'variant' | 'accordion-modal';

package/dist/index.d.ts

@@ -367,12 +367,30 @@ declare function Avatar({ src, alt, size, className }: AvatarProps): react.JSX.E
 type IllustrationVariant = 'empty' | 'createAccount' | 'welcome' | 'success' | 'discountReferral';
 interface IllustrationProps {
     variant: IllustrationVariant;
-    /** Host your own export of this illustration (this package ships no artwork). */
+    /** Your own export of this illustration - this package ships no artwork. */
     src: string;
     alt: string;
     className?: string;
 }
-/** Snacky Illustration - decorative spot illustration for empty states, onboarding, confirmations. */
+/**
+ * Snacky Illustration - decorative spot illustration for empty states,
+ * onboarding and confirmations.
+ *
+ * ```tsx
+ * <Illustration variant="empty" src="/img/empty.svg" alt="No products found" />
+ * ```
+ *
+ * This ships no artwork, deliberately, and that is the normal split - Material,
+ * Radix and Chakra ship none either. What belongs in a design system is the
+ * documented canvas size per variant, which is what this owns; the Snacky
+ * artwork itself is modified stock and is not ours to redistribute.
+ *
+ * Export your own at the variant's ratio (SVG preferred) and serve it wherever
+ * your app already serves static assets. Open Peeps (openpeeps.com) is CC0 and
+ * drops in cleanly; unDraw (undraw.co) is free without attribution but its
+ * licence forbids redistributing assets "in packs", so keep it inside your own
+ * app. See the package README for the fuller note.
+ */
 declare function Illustration({ variant, src, alt, className }: IllustrationProps): react.JSX.Element;
 
 type ProductImageUsage = 'product-card' | 'product-details' | 'list' | 'review' | 'variant' | 'accordion-modal';