@nice2dev/icons 1.3.4 → 1.3.6

package/dist/types/icons/index.d.ts

@@ -1,14 +1,14 @@
 export { NtdArrowUp, NtdArrowDown, NtdArrowLeft, NtdArrowRight, NtdChevronUp, NtdChevronDown, NtdChevronLeft, NtdChevronRight, NtdMenu, NtdClose, NtdMoreHorizontal, NtdMoreVertical, NtdExternalLink, NtdRefresh, } from './navigation';
 export { NtdSearch, NtdEdit, NtdEditDetail, NtdTrash, NtdSave, NtdDownload, NtdUpload, NtdShare, NtdCopy, NtdClipboard, NtdPlus, NtdMinus, NtdCheck, NtdFilter, NtdSort, NtdPrint, NtdZoomIn, NtdZoomOut, NtdUndo, NtdRedo, NtdReply, NtdLink, NtdSettings, NtdLogIn, NtdLogOut, NtdLock, NtdUnlock, NtdGroup, NtdUngroup, } from './actions';
 export { NtdHome, NtdUser, NtdAdmin, NtdUsers, NtdHeart, NtdStar, NtdBell, NtdEye, NtdEyeOff, NtdInfo, NtdWarning, NtdError, NtdSuccess, NtdHelp, NtdClock, NtdHourglass, NtdCalendar, NtdTag, NtdBackspace, NtdBookmark, NtdFlag, NtdThumbUp, NtdThumbDown, NtdShield, NtdGlobe, NtdMap, NtdPin, NtdSun, NtdMoon, NtdCursor, NtdWireframe, } from './ui';
-export { NtdRecycle, NtdCompost, NtdTrashSort, NtdSolarPanel, NtdWindTurbine, NtdEvCharger, NtdHydropower, NtdCarbonFootprint, NtdCo2, NtdNetZero, NtdEcoFriendly, NtdOrganic, NtdBiodegradable, NtdPlantTree, NtdWildlife, sustainabilityIcons, } from './sustainability';
+export { NtdRecycle, NtdCompost, NtdTrashSort, NtdSolarPanel, NtdWindTurbine, NtdEvCharger, NtdCarbonFootprint, NtdCo2, NtdNetZero, NtdEcoFriendly, NtdOrganic, NtdBiodegradable, NtdPlantTree, NtdWildlife, sustainabilityIcons, } from './sustainability';
 export { NtdAccessibility, NtdWheelchair, NtdBlind, NtdDeaf, NtdSignLanguage, NtdBraille, NtdAudioDescription, NtdClosedCaptions, NtdDyslexia, NtdEasyRead, NtdScreenReader, NtdHearingAid, NtdAssistiveTech, accessibilityIcons, } from './accessibility';
 export { NtdContract, NtdLegalDocument, NtdTermsOfService, NtdPrivacyPolicy, NtdGdpr, NtdCcpa, NtdCookieConsent, NtdCopyright, NtdTrademark, NtdPatent, NtdCompliance, NtdCertified, NtdAudit, legalIcons, } from './legal';
 export { NtdPlay, NtdPause, NtdStop, NtdSkipForward, NtdSkipBack, NtdVolume, NtdVolumeMute, NtdImage, NtdCamera, NtdVideo, NtdMicrophone, NtdMicrophoneOff, NtdMusic, NtdMail, NtdInbox, NtdPhone, NtdChat, NtdSend, NtdNotification, NtdWifi, NtdBluetooth, NtdPalette, NtdBrush, NtdPenTool, NtdSpline, } from './media';
 export { NtdFile, NtdFileText, NtdFolder, NtdFolderOpen, NtdArchive, NtdDatabase, NtdCloud, NtdCloudUpload, NtdCloudDownload, NtdTerminal, NtdCode, NtdGit, NtdPackage, NtdLayers, NtdGrid, NtdList, NtdTable, NtdSmartphone, NtdMonitor, NtdCpu, NtdKey, NtdAward, NtdCoffee, NtdCart, NtdShoppingCart, NtdCreditCard, NtdPieChart, NtdBarChart, NtdActivity, NtdTarget, NtdTruck, } from './files';
 export { NtdDumpsterFire, NtdRocket, NtdGamepadOldschool, NtdPuzzle, NtdPartyPopper, NtdTrophy, NtdCrown, NtdDice, NtdSmile, NtdSmiley, NtdSad, NtdSkull, NtdGhost, NtdLightning, NtdZap, } from './fun';
-export { NtdSunrise, NtdSunset, NtdRain, NtdSnow, NtdThunderstorm, NtdWind, NtdDroplet, NtdThermometer, NtdUmbrella, NtdLeaf, NtdFlower, NtdTree, NtdMountain, NtdWave, NtdFire, NtdSnowflake, NtdCompass, NtdAnchor, NtdFeather, NtdBug, } from './weather';
-export { NtdArrowUpCircle, NtdArrowDownCircle, NtdArrowLeftCircle, NtdArrowRightCircle, NtdSquare, NtdCircle, NtdTriangle, NtdHexagon, NtdOctagon, NtdDiamond, NtdPentagon, NtdCross, NtdStar4, NtdCornerUpLeft, NtdCornerUpRight, NtdCornerDownLeft, NtdCornerDownRight, NtdMaximize, NtdMinimize, NtdMove, NtdRepeat, NtdShuffle, NtdPoint, NtdSegment, NtdPerpendicular, NtdParallel, NtdMidpoint, NtdAngleBisector, } from './shapes';
+export { NtdSunrise, NtdSunset, NtdRain, NtdSnow, NtdThunderstorm, NtdWind, NtdDroplet, NtdHydropower, NtdThermometer, NtdUmbrella, NtdLeaf, NtdFlower, NtdTree, NtdMountain, NtdWave, NtdFire, NtdSnowflake, NtdCompass, NtdAnchor, NtdFeather, NtdBug, } from './weather';
+export { NtdArrowUpCircle, NtdArrowDownCircle, NtdArrowLeftCircle, NtdArrowRightCircle, NtdSquare, NtdCircle, NtdTriangle, NtdHexagon, NtdOctagon, NtdDiamond, NtdPentagon, NtdCross, NtdCornerUpLeft, NtdCornerUpRight, NtdCornerDownLeft, NtdCornerDownRight, NtdMaximize, NtdMinimize, NtdMove, NtdRepeat, NtdShuffle, NtdPoint, NtdSegment, NtdPerpendicular, NtdParallel, NtdMidpoint, NtdAngleBisector, } from './shapes';
 export { NtdBriefcase, NtdDollar, NtdWallet, NtdReceipt, NtdBank, NtdTrendUp, NtdTrendDown, NtdPercent, NtdInvoice, NtdInvoiceDoc, NtdStore, NtdBarcode, NtdCalculator, NtdPresentation, NtdClipboardCheck, NtdPiggyBank, NtdCoins, NtdKanban, NtdMilestone, } from './business';
 export { NtdAtSign, NtdPhoneOff, NtdBubble, NtdThumbsUp, NtdThumbsDown, NtdBellRing, NtdMegaphone, NtdQrCode, } from './social';
 export { NtdBrackets, NtdServer, NtdGitBranch, NtdGitCommit, NtdGitMerge, NtdBattery, NtdSlash, NtdHash, NtdBugDev, NtdBlueprint, NtdPrototype, NtdComponent, NtdNodes, NtdFlow, NtdAIBrain, NtdNeural, NtdForge, NtdPipeline, NtdDeploy, NtdGateway, NtdDataMesh, NtdFeatureFlag, NtdViteLogo, NtdBunLogo, NtdDenoLogo, NtdTauriLogo, NtdSvelteLogo, NtdNextJsLogo, NtdAstroLogo, NtdQwikLogo, NtdSolidJsLogo, } from './devtech';
@@ -19,7 +19,7 @@ export { NtdSmartBulb, NtdThermostat, NtdSmartCamera, NtdDoorbell, NtdMotionSens
 export { NtdApple, NtdPizza, NtdGlass, NtdHeartPulse, NtdPill, NtdSyringe, NtdStethoscope, NtdWeight, NtdBandaid, NtdCake, NtdEgg, NtdHamburger, NtdDna, } from './health';
 export { NtdNiceToDev, NtdOmniVerk, NtdOmniVerkLogo, NtdOmniVerkSpinner, NtdOmniVerkBadge, NtdOmniVerkWatermark, NtdOmniVerkAnimated, } from './brand';
 export { NtdGamepad, NtdGamepadController, NtdJoystick, NtdVrHeadset, NtdTrophy as NtdTrophyGaming, NtdLeaderboard, NtdHealthBar, NtdXpBar, NtdStar as NtdStarGaming, NtdTwitch, NtdYoutubeLive, NtdDiscord, NtdDice as NtdDiceGaming, NtdSword, NtdShield as NtdShieldGaming, NtdPotion, gamingIcons, } from './gaming';
-export { NtdNeuralNetwork, NtdBrain, NtdDeepLearning, NtdChatbot, NtdRobot, NtdVoiceAssistant as NtdAIAssistant, NtdTensor, NtdGradient, NtdDataset, NtdModel, NtdTraining, NtdInference, NtdSparkle, NtdMagicWand, NtdPrompt, aiIcons, } from './ai';
+export { NtdNeuralNetwork, NtdBrain, NtdDeepLearning, NtdChatbot, NtdRobot, NtdVoiceAssistant as NtdAIAssistant, NtdTensor, NtdGradient, NtdDataset, NtdModel, NtdTraining, NtdInference, NtdSparkle, NtdStar4, NtdMagicWand, NtdPrompt, aiIcons, } from './ai';
 export { NtdGraduationCap, NtdDiploma, NtdSchool, NtdUniversity, NtdBook, NtdBookBookmark, NtdOpenBook, NtdNotebook, NtdPencil, NtdPen, NtdOnlineCourse, NtdWebinar, NtdCertificate, NtdQuiz, NtdExam, NtdFlashcard, NtdBackpack, NtdCalculator as NtdCalculatorEdu, educationIcons, } from './education';
 export { NtdBeaker, NtdFlask, NtdTestTube, NtdPetriDish, NtdMicroscope, NtdDna as NtdDnaScience, NtdAtom, NtdMolecule, NtdPeriodictable, NtdMagnet, NtdTelescope, NtdPlanet, NtdRocket as NtdRocketScience, NtdResearch, NtdHypothesis, NtdExperiment, scienceIcons, } from './science';
 export { NtdHouse as NtdHouseRealEstate, NtdApartment, NtdCondo, NtdVilla, NtdOfficeBuilding, NtdWarehouse, NtdKey as NtdKeyRealEstate, NtdFloorPlan, NtdSquareMeters, NtdBedroom, NtdBathroom, NtdGarage, NtdPool, NtdForSale, NtdForRent, NtdSold, NtdMortgage, realestateIcons, } from './realestate';

package/dist/types/icons/shapes.d.ts

@@ -10,7 +10,6 @@ export declare const NtdOctagon: import("react").ForwardRefExoticComponent<impor
 export declare const NtdDiamond: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;
 export declare const NtdPentagon: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;
 export declare const NtdCross: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;
-export declare const NtdStar4: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;
 export declare const NtdCornerUpLeft: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;
 export declare const NtdCornerUpRight: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;
 export declare const NtdCornerDownLeft: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;

package/dist/types/icons/sustainability.d.ts

@@ -15,7 +15,6 @@ export declare const NtdTrashSort: import("react").ForwardRefExoticComponent<imp
 export declare const NtdSolarPanel: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;
 export declare const NtdWindTurbine: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;
 export declare const NtdEvCharger: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;
-export declare const NtdHydropower: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;
 export declare const NtdCarbonFootprint: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;
 export declare const NtdCo2: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;
 export declare const NtdNetZero: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;

package/dist/types/icons/weather.d.ts

@@ -12,6 +12,8 @@ export declare const NtdWind: import("react").ForwardRefExoticComponent<import("
  * arc was what made it look round and fat.
  */
 export declare const NtdDroplet: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;
+/** @deprecated The same drop as {@link NtdDroplet} — use that. */
+export declare const NtdHydropower: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;
 export declare const NtdThermometer: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;
 export declare const NtdUmbrella: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;
 export declare const NtdLeaf: import("react").ForwardRefExoticComponent<import("..").NtdIconProps & import("react").RefAttributes<SVGSVGElement>>;

package/dist/types/index.d.ts

@@ -47,13 +47,17 @@
  * @module @nicetodev/icons
  */
 import './animations.css';
-export type { IconSize, IconVariant, IconAnimation, CutoutShape, GradientPreset, GradientType, GradientAnimation, SemanticColor, NtdIconProps, IconRenderProps, } from './types';
+export type { IconSize, IconVariant, IconAnimation, CutoutShape, GradientPreset, GradientType, GradientAnimation, SemanticColor, NtdIconProps, IconRenderProps, IconStackAlign, } from './types';
 export { SIZE_MAP, GRADIENT_PRESETS, SEMANTIC_COLOR_DEFAULTS, SEMANTIC_COLOR_VARS } from './types';
 export { createIcon } from './createIcon';
 export { generateSmilAnimation, SmilAnimationWrapper as NiceSmilAnimationWrapper, SmilAnimationWrapper, createSmilAnimationDef, isSmilSupported, SMIL_ANIMATION_TYPES, } from './smilAnimations';
 export type { SmilAnimationType, SmilAnimationConfig, SmilAnimationWrapperProps, } from './smilAnimations';
 export { NiceIconPicker } from './NiceIconPicker';
 export type { NiceIconPickerProps, NiceIconPickerHandle, IconPickerEntry } from './NiceIconPicker';
+export { NiceIconStacker } from './NiceIconStacker';
+export { NiceIconStack, niceIconStackCode, renderIconStack, isValidTextBinding } from './iconStack';
+export type { NiceIconStackProps, NiceIconResolver, RenderIconStackOptions } from './iconStack';
+export type { NiceIconStackerProps, NiceIconStackerHandle, NiceIconStackLayer, } from './NiceIconStacker';
 export { AnimationController as NiceAnimationController, AnimationController, InteractiveIcon as NiceInteractiveIcon, InteractiveIcon, useAnimationSequence, createAnimationSequence, createHoverAnimation, createClickAnimation, createVisibilityAnimation, PRESET_SEQUENCES, PRESET_INTERACTIONS, } from './animationControls';
 export type { AnimationStep, AnimationSequenceConfig, AnimationPlaybackState, AnimationTrigger, InteractiveAnimationConfig, AnimationControllerHandle, AnimationControllerProps, InteractiveIconProps, } from './animationControls';
 export { exportIconToFigmaNode, exportIconToSvgString, exportIconToDataUrl, generateFigmaPluginManifest, downloadIconAsSvg, downloadIconAsPng, copyIconToClipboard, batchExportIcons, } from './figmaExport';

package/dist/types/stacking.d.ts

@@ -0,0 +1,49 @@
+import { type ReactElement, type ReactNode } from 'react';
+import type { IconStackAlign, IconVariant, NtdIconProps } from './types';
+/**
+ * Icons stacked by nesting (1.3.5): `<NtdSquare><NtdStar stackAlign="center">1</NtdStar></NtdSquare>`.
+ * An icon draws its children inside its own `<svg>` — an icon child as a nested `<svg>` placed by
+ * its `stackAlign` / `stackSize`, text centred on the icon, anything else as it is. So the stack
+ * is one SVG: it exports and copies like any icon.
+ */
+/** Set on every component createIcon makes, so a parent icon tells its icon children apart. */
+export declare const NTD_ICON_MARK = "ntdIcon";
+export declare function isNtdIconElement(node: ReactNode): node is ReactElement<NtdIconProps>;
+export declare function isFilledVariant(variant: IconVariant): boolean;
+/** Default share of the parent: centred children larger, edge and corner badges smaller. */
+export declare function defaultStackSize(align: IconStackAlign): number;
+/**
+ * Top-left corner of a stacked icon `size` units big inside the 24-unit box. A `half-…` position is
+ * halfway between the centre and the edge or corner it names (1.3.6).
+ */
+export declare function stackPlacement(align: IconStackAlign, size: number): [number, number];
+/** A corner badge — a full corner; `half-` corners sit inside the parent like its centre. */
+export declare function isCornerBadge(align: IconStackAlign): boolean;
+/**
+ * Font size of text children by length: one character 9, two 7.5, three 6, more 5 (1.3.6 — three
+ * quarters of the first sizes, so a number sits inside a star or a circle with room round it).
+ */
+export declare function defaultTextSize(length: number): number;
+export interface StackContext {
+    variant: IconVariant;
+    /** The parent's primary as drawn (a gradient's `url(#…)` included). */
+    primaryColor: string;
+    accentColor: string;
+    /** The cutout variant's tile colour — what fills the cut shape's surroundings. */
+    tileColor: string;
+    strokeWidth: number;
+    /** Where text is centred — the icon's visual centre. */
+    textCenter: readonly [number, number];
+    textColor?: string;
+    textSize?: number;
+}
+/**
+ * The children of an icon, drawn into it. Colours given on a child win; otherwise:
+ * - content inside — centred, at an edge or halfway out — is cut out of a filled parent: an icon child takes
+ *   the parent's accent as its primary (and the parent's primary as its accent, so its own text
+ *   and details read), text the accent; on `outline` / `wireframe` it stays in the parent's
+ *   colours; in a cutout it takes the tile's colour, drawn solid in the cut;
+ * - a corner badge keeps the parent's colours and sits on a disc of the accent colour a little
+ *   larger than itself — a gap cut into the parent where they overlap, unseen beyond it.
+ */
+export declare function renderStackChildren(children: ReactNode, ctx: StackContext): ReactNode;

package/dist/types/types.d.ts

@@ -269,9 +269,41 @@ export interface NtdIconProps extends Omit<SVGProps<SVGSVGElement>, 'ref'> {
      * @example `transformOrigin="top left"`
      */
     transformOrigin?: string;
+    /**
+     * Where this icon sits when it is a child of another icon (1.3.5):
+     * `<NtdSquare><NtdStar stackAlign="top-right" /></NtdSquare>`. Default `'center'`; `half-…`
+     * positions sit halfway from the centre to that edge or corner (1.3.6). Text children
+     * (`<NtdStar>1</NtdStar>`) are centred on the icon.
+     */
+    stackAlign?: IconStackAlign;
+    /**
+     * This icon's size as a share of the icon it is stacked in (1.3.5). Default `0.6` centred, `0.5`
+     * at an edge or a corner.
+     */
+    stackSize?: number;
+    /**
+     * Colour of text children (1.3.5). Default: the accent colour on a filled variant (the text reads
+     * as a cut), primary on `outline` / `wireframe`.
+     */
+    textColor?: string;
+    /**
+     * Font size of text children in the 24-unit box (1.3.5). Default by length: 9, 7.5, 6, 5 (1.3.6;
+     * it was 12, 10, 8, 6.5).
+     */
+    textSize?: number;
+    /**
+     * Turns this icon, when stacked in another, about its own centre — degrees, clockwise (1.3.6).
+     * Its own contents and text turn with it.
+     */
+    stackRotation?: number;
     /** Accessible title for screen readers */
     title?: string;
 }
+/**
+ * Where a stacked icon sits inside the icon it is a child of — the centre, an edge or a corner
+ * (1.3.5), or halfway from the centre to one (`half-…`, 1.3.6).
+ */
+export type IconStackAlign = 'center' | 'top' | 'bottom' | 'left' | 'right' | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'half-top' | 'half-bottom' | 'half-left' | 'half-right' | 'half-top-left' | 'half-top-right' | 'half-bottom-left' | 'half-bottom-right';
 /**
  * Props received by icon path renderer functions inside {@link CreateIconOptions.paths}.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nice2dev/icons",
-  "version": "1.3.4",
+  "version": "1.3.6",
   "description": "Beautiful, lightweight, multi-color SVG icon library for React with animations",
   "author": "NiceToDev <contact@nicetodev.com>",
   "license": "SEE LICENSE IN LICENSE",
@@ -109,7 +109,7 @@
   },
   "devDependencies": {
     "@chromatic-com/storybook": "^5.3.1",
-    "@nice2dev/ui-core": "^1.3.4",
+    "@nice2dev/ui-core": "^1.3.6",
     "@rollup/plugin-commonjs": "^29.0.3",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-typescript": "^12.3.0",