@apia/icons 2.0.11 → 3.0.2

package/dist/index.d.ts

@@ -1,4 +1,411 @@
-export { FileIcon } from './FileIcon.js';
-export { Icon } from './Icon.js';
-export { IconsMap, TIconName, TIconType, icons, isIconName } from './iconMap.js';
+import * as React from 'react';
+import React__default from 'react';
+import { IconType, IconBaseProps } from '@meronex/icons';
+import { RequireExactlyOne } from 'type-fest';
+import * as _meronex_icons_lib from '@meronex/icons/lib';
+
+declare const FileIcon: ({ docName, iconSize, }: {
+    docName: string;
+    iconSize?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
+}) => React.JSX.Element;
+
+type TIconType = IconType;
+type TIconName = keyof typeof IconsMap;
+/**
+ * La idea original al menos, es que los nombres de los íconos sean lo más
+ * genérico posible. Como ejemplo, tenemos el ícono Plus, cuyo nombre no indica
+ * nada acerca del rol que ocupa en la aplicación, sino que solamente describe
+ * qué ícono podemos esperar encontrar.
+ *
+ * Para indicar qué uso podría tener en la aplicación, se pueden agregar tags
+ * en el array tags correspondiente.
+ */
+declare const IconsMap: {
+    Alert: {
+        icon: IconType;
+        tags: string[];
+    };
+    AreaSelect: {
+        icon: IconType;
+        tags: never[];
+    };
+    ArrowLeft: {
+        icon: IconType;
+        tags: never[];
+    };
+    ArrowRight: {
+        icon: IconType;
+        tags: never[];
+    };
+    ArrowUp: {
+        icon: IconType;
+        tags: never[];
+    };
+    ArrowDown: {
+        icon: IconType;
+        tags: never[];
+    };
+    ArrowRightThin: {
+        icon: _meronex_icons_lib.IconType;
+        tags: never[];
+    };
+    ArrowLeftThin: {
+        icon: _meronex_icons_lib.IconType;
+        tags: never[];
+    };
+    ArrowUpThin: {
+        icon: IconType;
+        tags: never[];
+    };
+    ArrowDownThin: {
+        icon: IconType;
+        tags: never[];
+    };
+    Broom: {
+        icon: IconType;
+        tags: string[];
+    };
+    Bulb: {
+        icon: IconType;
+        tags: string[];
+    };
+    Calendar: {
+        icon: IconType;
+        tags: string[];
+    };
+    Check: {
+        icon: IconType;
+        tags: string[];
+    };
+    CircleFilled: {
+        icon: IconType;
+        tags: never[];
+    };
+    Clock: {
+        icon: IconType;
+        tags: never[];
+    };
+    CloudArrow: {
+        icon: IconType;
+        tags: string[];
+    };
+    Close: {
+        icon: IconType;
+        tags: string[];
+    };
+    CloseThin: {
+        icon: IconType;
+        tags: string[];
+    };
+    Comment: {
+        icon: IconType;
+        tags: never[];
+    };
+    Copy: {
+        icon: IconType;
+        tags: never[];
+    };
+    CrossFilter: {
+        icon: IconType;
+        tags: never[];
+    };
+    Cube: {
+        icon: IconType;
+        tags: never[];
+    };
+    Desktop: {
+        icon: IconType;
+        tags: string[];
+    };
+    Difference: {
+        icon: IconType;
+        tags: never[];
+    };
+    Download: {
+        icon: IconType;
+        tags: never[];
+    };
+    DotSmall: {
+        icon: IconType;
+        tags: never[];
+    };
+    DotBig: {
+        icon: IconType;
+        tags: never[];
+    };
+    DragAndDrop: {
+        icon: IconType;
+        tags: string[];
+    };
+    Edit: {
+        icon: IconType;
+        tags: string[];
+    };
+    Ellipsis: {
+        icon: IconType;
+        tags: string[];
+    };
+    External: {
+        icon: IconType;
+        tags: string[];
+    };
+    File: {
+        icon: IconType;
+        tags: string[];
+    };
+    Filter: {
+        icon: IconType;
+        tags: never[];
+    };
+    First: {
+        icon: IconType;
+        tags: never[];
+    };
+    FlowTree: {
+        icon: IconType;
+        tags: never[];
+    };
+    FolderClosed: {
+        icon: IconType;
+        tags: string[];
+    };
+    FolderOpen: {
+        icon: IconType;
+        tags: string[];
+    };
+    FolderPlus: {
+        icon: IconType;
+        tags: string[];
+    };
+    Groups: {
+        icon: IconType;
+        tags: never[];
+    };
+    Hamburguer: {
+        icon: IconType;
+        tags: string[];
+    };
+    Help: {
+        icon: IconType;
+        tags: string[];
+    };
+    Home: {
+        icon: IconType;
+        tags: string[];
+    };
+    Info: {
+        icon: IconType;
+        tags: never[];
+    };
+    Laptop: {
+        icon: IconType;
+        tags: never[];
+    };
+    Last: {
+        icon: IconType;
+        tags: never[];
+    };
+    LetterAutocomplete: {
+        icon: IconType;
+        tags: never[];
+    };
+    Locked: {
+        icon: IconType;
+        tags: string[];
+    };
+    Magic: {
+        icon: IconType;
+        tags: string[];
+    };
+    Maximize: {
+        icon: IconType;
+        tags: string[];
+    };
+    Merge: {
+        icon: IconType;
+        tags: never[];
+    };
+    Minimize: {
+        icon: IconType;
+        tags: string[];
+    };
+    Minus: {
+        icon: IconType;
+        tags: string[];
+    };
+    MinusReverse: {
+        icon: IconType;
+        tags: string[];
+    };
+    MinusFilled: {
+        icon: IconType;
+        tags: string[];
+    };
+    Molecule: {
+        icon: IconType;
+        tags: string[];
+    };
+    Next: {
+        icon: IconType;
+        tags: never[];
+    };
+    Note: {
+        icon: IconType;
+        tags: never[];
+    };
+    PanHand: {
+        icon: IconType;
+        tags: string[];
+    };
+    Pin: {
+        icon: IconType;
+        tags: never[];
+    };
+    Plus: {
+        icon: IconType;
+        tags: string[];
+    };
+    PlusReverse: {
+        icon: IconType;
+        tags: string[];
+    };
+    PlusFilled: {
+        icon: IconType;
+        tags: string[];
+    };
+    PlusThin: {
+        icon: IconType;
+        tags: never[];
+    };
+    Pointer: {
+        icon: IconType;
+        tags: string[];
+    };
+    Previous: {
+        icon: IconType;
+        tags: never[];
+    };
+    Print: {
+        icon: IconType;
+        tags: never[];
+    };
+    Redo: {
+        icon: IconType;
+        tags: never[];
+    };
+    Refresh: {
+        icon: IconType;
+        tags: string[];
+    };
+    Save: {
+        icon: IconType;
+        tags: never[];
+    };
+    Search: {
+        icon: IconType;
+        tags: never[];
+    };
+    Settings: {
+        icon: IconType;
+        tags: string[];
+    };
+    SquareFilled: {
+        icon: IconType;
+        tags: never[];
+    };
+    SquareOutline: {
+        icon: IconType;
+        tags: never[];
+    };
+    Sort: {
+        icon: IconType;
+        tags: never[];
+    };
+    Star: {
+        icon: IconType;
+        tags: string[];
+    };
+    Sum: {
+        icon: IconType;
+        tags: string[];
+    };
+    TaskList: {
+        icon: IconType;
+        tags: string[];
+    };
+    Translate: {
+        icon: IconType;
+        tags: string[];
+    };
+    Trash: {
+        icon: IconType;
+        tags: string[];
+    };
+    Undo: {
+        icon: IconType;
+        tags: string[];
+    };
+    Upload: {
+        icon: IconType;
+        tags: never[];
+    };
+    User: {
+        icon: IconType;
+        tags: never[];
+    };
+    User2: {
+        icon: IconType;
+        tags: never[];
+    };
+    Volume: {
+        icon: IconType;
+        tags: never[];
+    };
+    WindowMaximize: {
+        icon: IconType;
+        tags: never[];
+    };
+    WindowMinimize: {
+        icon: IconType;
+        tags: never[];
+    };
+    Work: {
+        icon: IconType;
+        tags: never[];
+    };
+    ZoomIn: {
+        icon: IconType;
+        tags: string[];
+    };
+    ZoomOut: {
+        icon: IconType;
+        tags: string[];
+    };
+};
+declare const icons: Record<"Alert" | "AreaSelect" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "ArrowDown" | "ArrowRightThin" | "ArrowLeftThin" | "ArrowUpThin" | "ArrowDownThin" | "Broom" | "Bulb" | "Calendar" | "Check" | "CircleFilled" | "Clock" | "CloudArrow" | "Close" | "CloseThin" | "Comment" | "Copy" | "CrossFilter" | "Cube" | "Desktop" | "Difference" | "Download" | "DotSmall" | "DotBig" | "DragAndDrop" | "Edit" | "Ellipsis" | "External" | "File" | "Filter" | "First" | "FlowTree" | "FolderClosed" | "FolderOpen" | "FolderPlus" | "Groups" | "Hamburguer" | "Help" | "Home" | "Info" | "Laptop" | "Last" | "LetterAutocomplete" | "Locked" | "Magic" | "Maximize" | "Merge" | "Minimize" | "Minus" | "MinusReverse" | "MinusFilled" | "Molecule" | "Next" | "Note" | "PanHand" | "Pin" | "Plus" | "PlusReverse" | "PlusFilled" | "PlusThin" | "Pointer" | "Previous" | "Print" | "Redo" | "Refresh" | "Save" | "Search" | "Settings" | "SquareFilled" | "SquareOutline" | "Sort" | "Star" | "Sum" | "TaskList" | "Translate" | "Trash" | "Undo" | "Upload" | "User" | "User2" | "Volume" | "WindowMaximize" | "WindowMinimize" | "Work" | "ZoomIn" | "ZoomOut", IconType>;
+/**
+ * Se puede utilizar este type guard para aceptar argumentos en los componentes
+ * que permitan pasar tanto un nombre de ícono como un ícono en sí.
+ *
+ * @example
+ *-
+ * ({icon}: {icon: TIconName | TIconType}) => {
+ *   const ActualIcon = React.useMemo(
+ *     ()=> isIconName(icon) ? (() => <Icon name={icon} />) : icon
+ *   , [])
+ *   return <ActualIcon />
+ * }
+ */
+declare function isIconName(arg: TIconName | TIconType): arg is TIconName;
+
+type TIconArgs = RequireExactlyOne<{
+    icon: TIconName | TIconType;
+    name: TIconName;
+}>;
+declare const Icon: React__default.ForwardRefExoticComponent<(TIconArgs & IconBaseProps & {
+    title: string;
+    imageSrc?: string | undefined;
+}) & React__default.RefAttributes<any>>;
+
+export { FileIcon, Icon, IconsMap, type TIconName, type TIconType, icons, isIconName };
 //# sourceMappingURL=index.d.ts.map