proicons 4.8.1 → 4.10.0

package/lib/proicons.d.ts

@@ -1,440 +1,8 @@
+import icons from './icons';
+import categories from './categories';
 import replace from './replace';
 import getIconInfo from './getIconInfo';
 import search from './search';
-declare const _default: {
-    icons: {
-        add: string;
-        addCircular: string;
-        addRhombus: string;
-        addSquare: string;
-        addSquareMultiple: string;
-        "addSquareMultiple-Var": string;
-        appRemove: string;
-        apps: string;
-        appsAdd: string;
-        backspace: string;
-        cancel: string;
-        checkmark: string;
-        compose: string;
-        copy: string;
-        "copy-Var": string;
-        crop: string;
-        cut: string;
-        delete: string;
-        eye: string;
-        eyeOff: string;
-        fastFoward: string;
-        heart: string;
-        heartStylistic: string;
-        keyboardShift: string;
-        more: string;
-        moreVertical: string;
-        pause: string;
-        pencil: string;
-        play: string;
-        playCircular: string;
-        reverse: string;
-        search: string;
-        star: string;
-        tune: string;
-        checkmarkStarburst: string;
-        creditCard: string;
-        lock: string;
-        lockOpen: string;
-        shield: string;
-        shieldCancel: string;
-        shieldCheckmark: string;
-        shieldKeyhole: string;
-        chat: string;
-        cloud: string;
-        comment: string;
-        commentMultiple: string;
-        "commentMultiple-Var": string;
-        database: string;
-        databaseAdd: string;
-        globe: string;
-        mail: string;
-        mailOpen: string;
-        megaphone: string;
-        megaphoneLoud: string;
-        mention: string;
-        narrator: string;
-        person: string;
-        person2: string;
-        personAdd: string;
-        personAdd2: string;
-        personCircle: string;
-        personMultiple: string;
-        phoneAccept: string;
-        phoneHangUp: string;
-        send: string;
-        "wi-fi": string;
-        anchor: string;
-        attatch: string;
-        bookInfo2: string;
-        calendar: string;
-        diamond: string;
-        eraser: string;
-        eyedropper: string;
-        eyedropperColor: string;
-        flashlight: string;
-        gift: string;
-        hatGraduation: string;
-        highlighter: string;
-        hourglass: string;
-        layers: string;
-        lightbulb: string;
-        link: string;
-        microphone: string;
-        microphoneOff: string;
-        pin: string;
-        pinOff: string;
-        timer: string;
-        wrench: string;
-        alertCircle: string;
-        alertTriangle: string;
-        arrowSync: string;
-        arrowSync2: string;
-        badge: string;
-        bell: string;
-        cancelCircle: string;
-        cancelSquare: string;
-        checkmarkCircle: string;
-        clock: string;
-        doNotDisturb: string;
-        info: string;
-        prohibited: string;
-        spinner: string;
-        emoji: string;
-        emojiFrown: string;
-        emojiGrin: string;
-        emojiLaughter: string;
-        skull: string;
-        arrowClockwise: string;
-        arrowCounterclockwise: string;
-        arrowDown: string;
-        arrowDownload: string;
-        arrowEnter: string;
-        arrowExport: string;
-        arrowFoward: string;
-        arrowImport: string;
-        arrowLeft: string;
-        arrowMove: string;
-        arrowRedo: string;
-        arrowRedo2: string;
-        arrowReply: string;
-        arrowRight: string;
-        arrowRotateClockwise: string;
-        arrowRotateCounterclockwise: string;
-        arrowSort: string;
-        arrowSwap: string;
-        arrowTrending: string;
-        arrowUndo: string;
-        arrowUndo2: string;
-        arrowUp: string;
-        arrowUpDown: string;
-        arrowUpload: string;
-        chevronDown: string;
-        chevronLeft: string;
-        chevronRight: string;
-        chevronUp: string;
-        subtract: string;
-        document: string;
-        drawText: string;
-        note: string;
-        noteAdd: string;
-        quote: string;
-        spacebar: string;
-        symbols: string;
-        text: string;
-        textAdd: string;
-        textAlignCenter: string;
-        textAlignJustify: string;
-        textAlignLeft: string;
-        textAlignRight: string;
-        textBold: string;
-        textCaseLowercase: string;
-        textCaseTitle: string;
-        textCaseUppercase: string;
-        textClearFormatting: string;
-        textCollapse: string;
-        textColor: string;
-        textEditStyle: string;
-        textEffects: string;
-        textExpand: string;
-        textFont: string;
-        textFontSize: string;
-        textFootnote: string;
-        textHighlightColor: string;
-        textIndentDecrease: string;
-        textIndentIncrease: string;
-        textItalic: string;
-        textLarge: string;
-        textLetterSpacing: string;
-        textLineHeight: string;
-        textLineSpacing: string;
-        textNumberList: string;
-        textPositionBottom: string;
-        textPositionMiddle: string;
-        textPositionTop: string;
-        textSmall: string;
-        textStrikethrough: string;
-        textSubscript: string;
-        textSuperscript: string;
-        textTypography: string;
-        textUnderline: string;
-        file: string;
-        fileAdd: string;
-        fileSync: string;
-        folder: string;
-        folderAdd: string;
-        folderOpen: string;
-        hardDrive: string;
-        pdf: string;
-        pdf2: string;
-        photo: string;
-        qrCode: string;
-        save: string;
-        saveAs: string;
-        accessibility: string;
-        battery: string;
-        batteryFull: string;
-        button: string;
-        checkboxIntermediate2: string;
-        checkboxUnchecked: string;
-        checkmarkChecked: string;
-        checkmarkIntermediate: string;
-        closedCaptions: string;
-        cursor: string;
-        cursorClick: string;
-        darkTheme: string;
-        extension: string;
-        menu: string;
-        settings: string;
-        zoomIn: string;
-        zoomOut: string;
-        airplane: string;
-        airplaneLanding: string;
-        airplaneTakeoff: string;
-        beach: string;
-        buildingMultiple: string;
-        component: string;
-        directions: string;
-        home: string;
-        home2: string;
-        location: string;
-        map: string;
-        museum: string;
-        vehicleCar: string;
-        barGraph: string;
-        boxMargins: string;
-        clipboard: string;
-        clipboardPaste: string;
-        clipboardSearch: string;
-        compareSize: string;
-        grid: string;
-        gridDots: string;
-        layout: string;
-        pageMargins: string;
-        panelLeft: string;
-        panelLeftContract: string;
-        panelLeftExpand: string;
-        panelLeftOpen: string;
-        panelRight: string;
-        panelRightContract: string;
-        panelRightExpand: string;
-        table: string;
-        tableSimple: string;
-        backgroundColor: string;
-        borderAll: string;
-        colorPalette: string;
-        mask: string;
-        paintBucket: string;
-        paintbrush: string;
-        paintbrush2: string;
-        shapeDifference: string;
-        shapeIntersect: string;
-        shapeSubtract: string;
-        shapeUnion: string;
-        strokeThickness: string;
-        arrowMaximize: string;
-        arrowMinimize: string;
-        chromeRestore: string;
-        "chromeRestore-Var": string;
-        contractDown: string;
-        expand: string;
-        fullScreenMaximize: string;
-        fullScreenMinimize: string;
-        open: string;
-        pictureInPicture: string;
-        pictureInPicture2: string;
-        pictureInPictureEnter: string;
-        pictureInPictureExit: string;
-        window: string;
-        windowMultiple: string;
-        "windowMultiple-Var": string;
-        beaker: string;
-        braces: string;
-        bracesVariable: string;
-        branch: string;
-        branchCompare: string;
-        branchFork: string;
-        branchFork2: string;
-        bug: string;
-        code: string;
-        gitCommit: string;
-        script: string;
-        script2: string;
-        terminal: string;
-        videoClip: string;
-        arc: string;
-        circle: string;
-        circleSmall: string;
-        cornerRadius: string;
-        hexagon: string;
-        lineDiagonal: string;
-        octagon: string;
-        pentagon: string;
-        rectangleWide: string;
-        rhombus: string;
-        square: string;
-        triangle: string;
-        backgroundColorAccent: string;
-        eyedropperColorAccent: string;
-        highlighterAccent: string;
-        paintBucketAccent: string;
-        tagAccent: string;
-        textColorAccent: string;
-        textHighlightColorAccent: string;
-        amazon: string;
-        appStore: string;
-        apple: string;
-        bluetooth: string;
-        css: string;
-        facebook: string;
-        figma: string;
-        github: string;
-        google: string;
-        google2: string;
-        googleChrome: string;
-        googlePlay: string;
-        html: string;
-        instagram: string;
-        javascript: string;
-        microsoft: string;
-        microsoftEdge: string;
-        python: string;
-        roblox: string;
-        tiktok: string;
-        visualStudioCode: string;
-        xTwitter: string;
-        youtube: string;
-        youtubeShorts: string;
-        book: string;
-        book2: string;
-        bookAdd: string;
-        bookAdd2: string;
-        bookInfo: string;
-        bookOpen: string;
-        box: string;
-        broom: string;
-        calligraphyPen: string;
-        cart: string;
-        compass: string;
-        flag: string;
-        library: string;
-        photoFilter: string;
-        ribbon: string;
-        ribbonStar: string;
-        video: string;
-        briefcase: string;
-        briefcase2: string;
-        cent: string;
-        dollar: string;
-        graph: string;
-        toolbox: string;
-        cake: string;
-        coffeeHot: string;
-        cookies: string;
-        drop: string;
-        hamburger: string;
-        boxDrag: string;
-        cursorDrag: string;
-        hand: string;
-        thumbsDown: string;
-        thumbsUp: string;
-        angle: string;
-        calculator: string;
-        hash: string;
-        ruler: string;
-        screenSize: string;
-        headphones: string;
-        movie: string;
-        musicNote: string;
-        musicNote2: string;
-        soundwave: string;
-        volume: string;
-        volume0: string;
-        volume1: string;
-        volumeMute: string;
-        leaf: string;
-        leafThree: string;
-        leafTwo: string;
-        history: string;
-        question: string;
-        questionCircle: string;
-        sparkle: string;
-        alignBottom: string;
-        alignHorizontalCenters: string;
-        alignLeft: string;
-        alignRight: string;
-        alignTop: string;
-        alignVerticalCenters: string;
-        appsList: string;
-        archive: string;
-        archiveAdd2: string;
-        board: string;
-        bookmark: string;
-        bookmarkAdd: string;
-        bookmarkMultiple: string;
-        "bookmarkMultiple-Var": string;
-        centerHorizontal: string;
-        centerVertical: string;
-        filter: string;
-        filter2: string;
-        filterCancel: string;
-        filterCancel2: string;
-        sectionBreak: string;
-        tag: string;
-        tagMultiple: string;
-        "tagMultiple-Var": string;
-        taskList: string;
-        textBulletList: string;
-        textBulletListSquare: string;
-        textBulletListSquareAdd: string;
-        camera: string;
-        computer: string;
-        computerMac: string;
-        foldableHorizontal: string;
-        foldableHorizontalHalf: string;
-        foldableVertical: string;
-        foldableVerticalHalf: string;
-        game: string;
-        keyboard: string;
-        laptop: string;
-        motherboard: string;
-        phone: string;
-        printer: string;
-        tv: string;
-        tablet: string;
-        watch: string;
-        brightness: string;
-        moon: string;
-        weatherCloudy: string;
-    };
-    replace: typeof replace;
-    getIconInfo: typeof getIconInfo;
-    categories: string[];
-    search: typeof search;
-};
-export default _default;
+export { 
+/** List of all available icons with camelCase keys and SVG strings as values. */
+icons, replace, getIconInfo, categories, search };

package/lib/replace.d.ts

@@ -1,3 +1,8 @@
 import { ProIconReplaceConfig } from './interfaces';
+/**
+ * Converts all elements with the `proicon` attribute (which can be customised in the config) on the page to an icon corresponding to the attribute value.
+ * @param rootElm The element to search inside for children with the `proicon` attribute. Defaults to `document.body`.
+ * @param config An optional configuration to customise the behaviour of the replace method
+ */
 declare function replace(rootElm?: Element, config?: ProIconReplaceConfig): void;
 export default replace;

package/lib/search.d.ts

@@ -1,3 +1,4 @@
 import { ProIconInfo } from "./interfaces";
-declare function search(key: string): ProIconInfo[];
+/** Searches for icons with names or tags that contain `key` and returns them as `ProIconInfo`. */
+declare function search(query: string): ProIconInfo[];
 export default search;

package/package.json

@@ -1,41 +1,90 @@
-{
-    "name": "proicons",
-    "version": "4.8.1",
-    "description": "A collection of 400+ modern and open-source icons",
-    "main": "dist/proicons.js",
-    "files": [
-        "dist",
-        "lib"
-    ],
-    "scripts": {
-        "build": "webpack --mode=production --node-env=production",
-        "dev": "webpack serve --mode=development --open",
-        "build-files": "node ./bin/build.js",
-        "dev-build": "webpack --mode=development",
-        "prepare": "node ./bin/publish.js"
-    },
-    "keywords": [
-        "icons",
-        "icon-pack",
-        "roblox",
-        "js"
-    ],
-    "author": "ProCode Software",
-    "license": "MIT",
-    "devDependencies": {
-        "@types/node": "^22.3.0",
-        "@types/webpack": "^5.28.5",
-        "@webpack-cli/generators": "^3.0.7",
-        "html-webpack-plugin": "^5.6.0",
-        "ts-loader": "^9.5.1",
-        "typescript": "^5.5.4",
-        "webpack": "^5.93.0",
-        "webpack-dev-server": "^5.0.4",
-        "ansi-colors": "^4.1.3",
-        "chalk": "^5.3.0",
-        "prettier": "^3.3.3",
-        "svg2ttf": "^6.0.3",
-        "svgo": "^3.3.2"
-    },
-    "dependencies": {}
+{
+  "name": "proicons",
+  "version": "4.10.0",
+  "description": "A collection of 400+ modern and open-source icons",
+  "type": "module",
+  "main": "dist/cjs/proicons.cjs",
+  "main:umd": "dist/umd/proicons.cjs",
+  "module": "dist/es/proicons.js",
+  "typings": "lib/proicons.d.ts",
+  "amdName": "proicons",
+  "unpkg": "dist/umd/proicons.cjs",
+  "jsdelivr": "dist/umd/proicons.cjs",
+  "browser": "dist/umd/proicons.cjs",
+  "files": [
+    "dist",
+    "lib"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/es/proicons.js",
+      "require": "./dist/cjs/proicons.cjs",
+      "types": "./lib/proicons.d.ts",
+      "default": "./dist/umd/proicons.cjs"
+    }
+  },
+  "workspaces": [
+    "packages/*",
+    "tools/*",
+    "site"
+  ],
+  "repository": {
+    "url": "ProCode-Software/proicons"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/ProCode-Software/proicons",
+  "bugs": "https://github.com/ProCode-Software/proicons/issues",
+  "keywords": [
+    "icons",
+    "icon-pack",
+    "js",
+    "feather",
+    "lucide",
+    "fluent",
+    "font awesome",
+    "svg",
+    "proicons",
+    "procode"
+  ],
+  "author": "ProCode Software",
+  "license": "MIT",
+  "devDependencies": {
+    "@twbs/fantasticon": "^3.0.0",
+    "@types/node": "^22.7.5",
+    "adm-zip": "^0.5.16",
+    "ansi-colors": "^4.1.3",
+    "chalk": "^5.3.0",
+    "d3-delaunay": "^6.0.4",
+    "jimp": "^1.6.0",
+    "minisearch": "^7.1.0",
+    "oslllo-svg-fixer": "^5.0.0",
+    "piscina": "^4.7.0",
+    "prettier": "^3.3.3",
+    "progress": "^2.0.3",
+    "sass-embedded": "^1.79.5",
+    "sharp": "^0.33.5",
+    "svg2ttf": "^6.0.3",
+    "svgo": "^3.3.2",
+    "typescript": "^5.6.3",
+    "vite": "^5.4.9",
+    "vite-plugin-html": "^3.2.2",
+    "vitepress": "^1.4.1",
+    "vue": "^3.5.12",
+    "@proicons/cli": "1.0.0"
+  },
+  "scripts": {
+    "dev": "pnpm vite",
+    "icons:build": "node --no-deprecation ./bin/build.js",
+    "icons:optimize": "pnpm run icons:build -o",
+    "icons:build-frozen": "pnpm run icons:build -l",
+    "icons:build-rebuild": "pnpm run icons:build -r",
+    "font:build": "pnpm run icons:build -f",
+    "build": "pnpm tsc && pnpm vite build",
+    "preview": "pnpm vite preview",
+    "docs:dev": "pnpm vitepress dev site/src --port 9000",
+    "docs:build": "pnpm vitepress build site/src",
+    "docs:preview": "pnpm vitepress preview site/src"
+  }
 }