@akinon/icons 0.5.0 → 1.0.0

package/dist/cjs/icomoon.d.ts

@@ -1,32 +1,48 @@
 import { CSSProperties, JSXElementConstructor, SVGProps } from 'react';
 import { IconName } from './icon-type';
 type IconSetItem = {
+    /**
+     * Metadata for a single icon in the Icomoon icon set.
+     */
     properties: {
+        /**
+         * The unique name of the icon.
+         */
         name: string;
     };
     icon: {
+        /**
+         * SVG path data for the icon.
+         */
         paths: string[];
+        /**
+         * Optional attributes for the icon's paths.
+         */
         attrs?: object[];
+        /**
+         * The width of the icon.
+         */
         width?: number | string;
     };
 };
 type IconSet = {
     /**
-     * The icons of the icon set.
+     * A collection of icons, each with metadata and path data.
      */
     icons: IconSetItem[];
 };
 export interface IconProps extends SVGProps<SVGElement> {
     /**
-     * The name of the icon.
+     * The name of the icon to be rendered. Must match a name in the provided icon set.
      */
     icon: IconName;
     /**
-     * The size of the icon.
+     * The size of the icon, specified in pixels (number) or any valid CSS size string (e.g., '2rem').
+     * @default 24
      */
     size?: string | number;
     /**
-     * The title of the icon.
+     * A descriptive title for the icon, used for accessibility and screen readers.
      */
     title?: string;
     /**
@@ -34,7 +50,7 @@ export interface IconProps extends SVGProps<SVGElement> {
      */
     disableFill?: boolean;
     /**
-     * Whether to remove the inline style of the icon.
+     * Removes all inline styles from the icon, including `width`, `height`, and `fill`.
      */
     removeInlineStyle?: boolean;
     /**
@@ -46,13 +62,13 @@ export interface IconProps extends SVGProps<SVGElement> {
      */
     PathComponent?: JSXElementConstructor<any>;
     /**
-     * The style of the icon.
+     * Additional styles applied to the icon. Inline styles are merged unless `removeInlineStyle` is true.
      */
     style?: CSSProperties;
 }
-interface IcomoonProps extends IconProps {
+export interface IcomoonProps extends IconProps {
     /**
-     * The icon set of the icon.
+     * The Icomoon icon set containing all available icons.
      */
     iconSet: IconSet;
 }

package/dist/cjs/icomoon.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"icomoon.d.ts","sourceRoot":"","sources":["../../src/icomoon.tsx"],"names":[],"mappings":"AAAA,OAAO,EAEL,aAAa,EACb,qBAAqB,EACrB,QAAQ,EACT,MAAM,OAAO,CAAC;AAEf,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,KAAK,WAAW,GAAG;IACjB,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;KACzB,CAAC;CACH,CAAC;AAEF,KAAK,OAAO,GAAG;IACb;;OAEG;IACH,KAAK,EAAE,WAAW,EAAE,CAAC;CACtB,CAAC;AAEF,MAAM,WAAW,SAAU,SAAQ,QAAQ,CAAC,UAAU,CAAC;IACrD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IAEH,YAAY,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,CAAC;IAC1C;;OAEG;IAEH,aAAa,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,CAAC;IAC3C;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB;AAED,UAAU,YAAa,SAAQ,SAAS;IACtC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,eAAO,MAAM,OAAO,0GAUjB,YAAY,kFAyCd,CAAC"}
+{"version":3,"file":"icomoon.d.ts","sourceRoot":"","sources":["../../src/icomoon.tsx"],"names":[],"mappings":"AACA,OAAO,EAEL,aAAa,EACb,qBAAqB,EACrB,QAAQ,EACT,MAAM,OAAO,CAAC;AAEf,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,KAAK,WAAW,GAAG;IACjB;;OAEG;IACH,UAAU,EAAE;QACV;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IAEF,IAAI,EAAE;QACJ;;WAEG;QACH,KAAK,EAAE,MAAM,EAAE,CAAC;QAEhB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QAEjB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;KACzB,CAAC;CACH,CAAC;AAEF,KAAK,OAAO,GAAG;IACb;;OAEG;IACH,KAAK,EAAE,WAAW,EAAE,CAAC;CACtB,CAAC;AAEF,MAAM,WAAW,SAAU,SAAQ,QAAQ,CAAC,UAAU,CAAC;IACrD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,CAAC;IAE1C;;OAEG;IACH,aAAa,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,CAAC;IAE3C;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB;AAED,MAAM,WAAW,YAAa,SAAQ,SAAS;IAC7C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,eAAO,MAAM,OAAO,0GAUjB,YAAY,kFAyCd,CAAC"}

package/dist/cjs/icomoon.js

@@ -12,6 +12,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Icomoon = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
 const react_1 = require("react");
 const Icomoon = (_a) => {
     var { iconSet, icon, size = 24, title, disableFill, removeInlineStyle, SvgComponent, PathComponent } = _a, props = __rest(_a, ["iconSet", "icon", "size", "title", "disableFill", "removeInlineStyle", "SvgComponent", "PathComponent"]);

package/dist/cjs/icon-type.d.ts

@@ -1,3 +1,3 @@
-export declare const IconNameList: readonly ["acilissayfalari", "add_picture", "add_video", "alarm-create", "alarm-trigger", "arrow-product", "arrow_down", "arrow_up", "arti", "attribute-mapping", "ayarlar", "bank", "bars-code", "bekleyenurunler", "bilgilendirme_servis", "bin", "box", "calendar", "chevron_down", "chevron_up", "circle-down", "circle-up", "clock", "clock1", "close", "copy", "dagitimsenaryolari", "dashboard", "dashboard1", "doc", "download", "drag_drop", "durum_transfer", "edit", "eksi", "entagrator", "entegresyon", "envelope", "exclude", "feed", "female", "file", "filter", "fiyat_listeleri", "fiyatlistesi", "fiyatservisleri", "folder_minus", "folder_plus", "form", "gateway", "genderfree", "gift", "iade", "image", "import_export", "indirimkodlari", "info", "info-outlined", "iptaliadetalepleri", "kampanyalar", "kargo", "kargolog", "kargosirketleri", "kargoyonetimentegrasyonu", "kartayarlari", "katalog", "katalogkontrol", "kataloglar", "kategoriacilis", "kategoriler", "koleksiyonlar", "krerikartitipleri", "kullaniciyonetimi", "kupon", "linked", "list", "live", "live-commerce", "log", "lokasyon", "loop", "loyaltyentegrasyon", "loyatlyhesaplari", "magazastok", "mail", "male", "map", "mapping", "minus", "modelsema", "musteri", "musteri_grup", "musteriler", "mutabakat", "mutabakat-islemleri", "no", "notification", "notification-ring", "odeme", "oms", "onay", "outdent", "ozellik_seti", "paketlemeemirleri", "paketlokasyon", "phone-call", "plus", "pos-terminal", "preview", "product_stroke", "profile", "recommendation", "refresh", "report", "rules", "samsonite", "satiskanalllari", "search", "senaryolar", "seo", "settings", "shop", "siparis", "siparisservisleri", "siralama", "siralama_degistir", "skulog", "slack", "sms", "sms-text", "sort_arrow_down", "sort_arrow_up", "sosyalhesaplar", "statiksayfa", "stok_listeleri", "stoklistesi", "stokservisleri", "stream-key", "streams", "tavsiyesistemi", "teslimat", "toplukupon", "transferemirleri", "transferlokasyon", "transfersenaryolari", "triangle", "unified", "unified_stroke", "unifiedsozlesme", "urun_ozellikleri", "urunler", "urunlistesi", "urunstokentegrasyon", "urunstoksorgulama", "warning", "warning_arrow", "warning_tri", "warning_triangle", "widgetsemayonetimi", "widgetyonetimi", "yes", "zoom-in"];
+export declare const IconNameList: readonly ["acilissayfalari", "add_picture", "add_video", "alarm-create", "alarm-trigger", "arrow-product", "arrow_down", "arrow_up", "arti", "attach", "attribute-mapping", "ayarlar", "bank", "bars-code", "bekleyenurunler", "bilgilendirme_servis", "bin", "box", "calendar", "chevron_down", "chevron_up", "circle-down", "circle-up", "clock", "clock1", "close", "copy", "dagitimsenaryolari", "dashboard", "dashboard1", "doc", "download", "drag_drop", "durum_transfer", "edit", "eksi", "entagrator", "entegresyon", "envelope", "exclude", "feed", "female", "file", "filter", "fiyat_listeleri", "fiyatlistesi", "fiyatservisleri", "folder_minus", "folder_plus", "form", "gateway", "genderfree", "gift", "iade", "image", "import_export", "indirimkodlari", "info", "info-outlined", "iptaliadetalepleri", "kampanyalar", "kargo", "kargolog", "kargosirketleri", "kargoyonetimentegrasyonu", "kartayarlari", "katalog", "katalogkontrol", "kataloglar", "kategoriacilis", "kategoriler", "koleksiyonlar", "krerikartitipleri", "kullaniciyonetimi", "kupon", "linked", "list", "live", "live-commerce", "log", "lokasyon", "loop", "loyaltyentegrasyon", "loyatlyhesaplari", "magazastok", "mail", "male", "map", "mapping", "minus", "modelsema", "musteri", "musteri_grup", "musteriler", "mutabakat", "mutabakat-islemleri", "no", "notification", "notification-ring", "odeme", "oms", "onay", "outdent", "ozellik_seti", "paketlemeemirleri", "paketlokasyon", "phone-call", "plus", "pos-terminal", "preview", "product_stroke", "profile", "recommendation", "refresh", "report", "rules", "samsonite", "satiskanalllari", "search", "senaryolar", "seo", "settings", "shop", "siparis", "siparisservisleri", "siralama", "siralama_degistir", "skulog", "slack", "sms", "sms-text", "sort_arrow_down", "sort_arrow_up", "sosyalhesaplar", "statiksayfa", "stok_listeleri", "stoklistesi", "stokservisleri", "stream-key", "streams", "tavsiyesistemi", "teslimat", "toplukupon", "transferemirleri", "transferlokasyon", "transfersenaryolari", "triangle", "unified", "unified_stroke", "unifiedsozlesme", "urun_ozellikleri", "urunler", "urunlistesi", "urunstokentegrasyon", "urunstoksorgulama", "warning", "warning_arrow", "warning_tri", "warning_triangle", "widgetsemayonetimi", "widgetyonetimi", "yes", "zoom-in"];
 export type IconName = typeof IconNameList[number];
 //# sourceMappingURL=icon-type.d.ts.map

package/dist/cjs/icon-type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"icon-type.d.ts","sourceRoot":"","sources":["../../src/icon-type.ts"],"names":[],"mappings":"AACE,eAAO,MAAM,YAAY,+sEAAgtE,CAAC;AAC1uE,MAAM,MAAM,QAAQ,GAAG,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC"}
+{"version":3,"file":"icon-type.d.ts","sourceRoot":"","sources":["../../src/icon-type.ts"],"names":[],"mappings":"AACE,eAAO,MAAM,YAAY,ytEAA0tE,CAAC;AACpvE,MAAM,MAAM,QAAQ,GAAG,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC"}

package/dist/cjs/icon-type.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IconNameList = void 0;
-exports.IconNameList = ['acilissayfalari', 'add_picture', 'add_video', 'alarm-create', 'alarm-trigger', 'arrow-product', 'arrow_down', 'arrow_up', 'arti', 'attribute-mapping', 'ayarlar', 'bank', 'bars-code', 'bekleyenurunler', 'bilgilendirme_servis', 'bin', 'box', 'calendar', 'chevron_down', 'chevron_up', 'circle-down', 'circle-up', 'clock', 'clock1', 'close', 'copy', 'dagitimsenaryolari', 'dashboard', 'dashboard1', 'doc', 'download', 'drag_drop', 'durum_transfer', 'edit', 'eksi', 'entagrator', 'entegresyon', 'envelope', 'exclude', 'feed', 'female', 'file', 'filter', 'fiyat_listeleri', 'fiyatlistesi', 'fiyatservisleri', 'folder_minus', 'folder_plus', 'form', 'gateway', 'genderfree', 'gift', 'iade', 'image', 'import_export', 'indirimkodlari', 'info', 'info-outlined', 'iptaliadetalepleri', 'kampanyalar', 'kargo', 'kargolog', 'kargosirketleri', 'kargoyonetimentegrasyonu', 'kartayarlari', 'katalog', 'katalogkontrol', 'kataloglar', 'kategoriacilis', 'kategoriler', 'koleksiyonlar', 'krerikartitipleri', 'kullaniciyonetimi', 'kupon', 'linked', 'list', 'live', 'live-commerce', 'log', 'lokasyon', 'loop', 'loyaltyentegrasyon', 'loyatlyhesaplari', 'magazastok', 'mail', 'male', 'map', 'mapping', 'minus', 'modelsema', 'musteri', 'musteri_grup', 'musteriler', 'mutabakat', 'mutabakat-islemleri', 'no', 'notification', 'notification-ring', 'odeme', 'oms', 'onay', 'outdent', 'ozellik_seti', 'paketlemeemirleri', 'paketlokasyon', 'phone-call', 'plus', 'pos-terminal', 'preview', 'product_stroke', 'profile', 'recommendation', 'refresh', 'report', 'rules', 'samsonite', 'satiskanalllari', 'search', 'senaryolar', 'seo', 'settings', 'shop', 'siparis', 'siparisservisleri', 'siralama', 'siralama_degistir', 'skulog', 'slack', 'sms', 'sms-text', 'sort_arrow_down', 'sort_arrow_up', 'sosyalhesaplar', 'statiksayfa', 'stok_listeleri', 'stoklistesi', 'stokservisleri', 'stream-key', 'streams', 'tavsiyesistemi', 'teslimat', 'toplukupon', 'transferemirleri', 'transferlokasyon', 'transfersenaryolari', 'triangle', 'unified', 'unified_stroke', 'unifiedsozlesme', 'urun_ozellikleri', 'urunler', 'urunlistesi', 'urunstokentegrasyon', 'urunstoksorgulama', 'warning', 'warning_arrow', 'warning_tri', 'warning_triangle', 'widgetsemayonetimi', 'widgetyonetimi', 'yes', 'zoom-in'];
+exports.IconNameList = ['acilissayfalari', 'add_picture', 'add_video', 'alarm-create', 'alarm-trigger', 'arrow-product', 'arrow_down', 'arrow_up', 'arti', 'attach', 'attribute-mapping', 'ayarlar', 'bank', 'bars-code', 'bekleyenurunler', 'bilgilendirme_servis', 'bin', 'box', 'calendar', 'chevron_down', 'chevron_up', 'circle-down', 'circle-up', 'clock', 'clock1', 'close', 'copy', 'dagitimsenaryolari', 'dashboard', 'dashboard1', 'doc', 'download', 'drag_drop', 'durum_transfer', 'edit', 'eksi', 'entagrator', 'entegresyon', 'envelope', 'exclude', 'feed', 'female', 'file', 'filter', 'fiyat_listeleri', 'fiyatlistesi', 'fiyatservisleri', 'folder_minus', 'folder_plus', 'form', 'gateway', 'genderfree', 'gift', 'iade', 'image', 'import_export', 'indirimkodlari', 'info', 'info-outlined', 'iptaliadetalepleri', 'kampanyalar', 'kargo', 'kargolog', 'kargosirketleri', 'kargoyonetimentegrasyonu', 'kartayarlari', 'katalog', 'katalogkontrol', 'kataloglar', 'kategoriacilis', 'kategoriler', 'koleksiyonlar', 'krerikartitipleri', 'kullaniciyonetimi', 'kupon', 'linked', 'list', 'live', 'live-commerce', 'log', 'lokasyon', 'loop', 'loyaltyentegrasyon', 'loyatlyhesaplari', 'magazastok', 'mail', 'male', 'map', 'mapping', 'minus', 'modelsema', 'musteri', 'musteri_grup', 'musteriler', 'mutabakat', 'mutabakat-islemleri', 'no', 'notification', 'notification-ring', 'odeme', 'oms', 'onay', 'outdent', 'ozellik_seti', 'paketlemeemirleri', 'paketlokasyon', 'phone-call', 'plus', 'pos-terminal', 'preview', 'product_stroke', 'profile', 'recommendation', 'refresh', 'report', 'rules', 'samsonite', 'satiskanalllari', 'search', 'senaryolar', 'seo', 'settings', 'shop', 'siparis', 'siparisservisleri', 'siralama', 'siralama_degistir', 'skulog', 'slack', 'sms', 'sms-text', 'sort_arrow_down', 'sort_arrow_up', 'sosyalhesaplar', 'statiksayfa', 'stok_listeleri', 'stoklistesi', 'stokservisleri', 'stream-key', 'streams', 'tavsiyesistemi', 'teslimat', 'toplukupon', 'transferemirleri', 'transferlokasyon', 'transfersenaryolari', 'triangle', 'unified', 'unified_stroke', 'unifiedsozlesme', 'urun_ozellikleri', 'urunler', 'urunlistesi', 'urunstokentegrasyon', 'urunstoksorgulama', 'warning', 'warning_arrow', 'warning_tri', 'warning_triangle', 'widgetsemayonetimi', 'widgetyonetimi', 'yes', 'zoom-in'];

package/dist/cjs/icon.d.ts

@@ -1,5 +1,18 @@
 import * as React from 'react';
 import { IconProps } from './icomoon';
+/**
+ * Icomoon Icon Component for React.
+ *
+ * This flexible component renders icons from a custom Icomoon icon set.
+ * It supports various customization options, such as size, style, and dynamic path rendering,
+ * and allows replacing the default `<svg>` and `<path>` elements with custom components.
+ *
+ * The component seamlessly integrates with any Icomoon-generated icon set and follows best practices
+ * for accessibility by supporting titles and ARIA attributes.
+ *
+ * This component also accepts all default <a href="https://react.dev/reference/react-dom/components/common#common-props"
+ * target="_blank" rel="noopener noreferrer">React HTML attributes</a>, along with additional SVG-specific attributes.
+ */
 export declare const Icon: (props: IconProps) => React.JSX.Element;
 export * from './utils';
 //# sourceMappingURL=icon.d.ts.map

package/dist/cjs/icon.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"icon.d.ts","sourceRoot":"","sources":["../../src/icon.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAW,SAAS,EAAE,MAAM,WAAW,CAAC;AAG/C,eAAO,MAAM,IAAI,UAAW,SAAS,sBAEpC,CAAC;AAEF,cAAc,SAAS,CAAC"}
+{"version":3,"file":"icon.d.ts","sourceRoot":"","sources":["../../src/icon.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAW,SAAS,EAAE,MAAM,WAAW,CAAC;AAG/C;;;;;;;;;;;;GAYG;AAEH,eAAO,MAAM,IAAI,UAAW,SAAS,sBAEpC,CAAC;AAEF,cAAc,SAAS,CAAC"}

package/dist/cjs/icon.js

@@ -18,6 +18,19 @@ exports.Icon = void 0;
 const React = require("react");
 const icomoon_1 = require("./icomoon");
 const selection_json_1 = require("./selection.json");
+/**
+ * Icomoon Icon Component for React.
+ *
+ * This flexible component renders icons from a custom Icomoon icon set.
+ * It supports various customization options, such as size, style, and dynamic path rendering,
+ * and allows replacing the default `<svg>` and `<path>` elements with custom components.
+ *
+ * The component seamlessly integrates with any Icomoon-generated icon set and follows best practices
+ * for accessibility by supporting titles and ARIA attributes.
+ *
+ * This component also accepts all default <a href="https://react.dev/reference/react-dom/components/common#common-props"
+ * target="_blank" rel="noopener noreferrer">React HTML attributes</a>, along with additional SVG-specific attributes.
+ */
 const Icon = (props) => (React.createElement(icomoon_1.Icomoon, Object.assign({ iconSet: selection_json_1.default }, props)));
 exports.Icon = Icon;
 __exportStar(require("./utils"), exports);