@metamask/snaps-sdk/dist/jsx/components/Icon.d.mts

A library containing the core functionality for building MetaMask Snaps

export declare enum IconName {
    Accessibility = "accessibility",
    Activity = "activity",
    AddCard = "add-card",
    AddCircle = "add-circle",
    AddSquare = "add-square",
    Add = "add",
    Ai = "ai",
    AlternateEmail = "alternate-email",
    Apple = "apple",
    Apps = "apps",
    Arrow2Down = "arrow-2-down",
    Arrow2Left = "arrow-2-left",
    Arrow2Right = "arrow-2-right",
    Arrow2UpRight = "arrow-2-up-right",
    Arrow2Up = "arrow-2-up",
    ArrowCircleDown = "arrow-circle-down",
    ArrowCircleUp = "arrow-circle-up",
    ArrowDoubleLeft = "arrow-double-left",
    ArrowDoubleRight = "arrow-double-right",
    ArrowDown = "arrow-down",
    ArrowDropDownCircle = "arrow-drop-down-circle",
    ArrowLeft = "arrow-left",
    ArrowRight = "arrow-right",
    ArrowUp = "arrow-up",
    Attachment = "attachment",
    Ban = "ban",
    BankAssured = "bank-assured",
    Bank = "bank",
    Bold = "bold",
    Book = "book",
    Bookmark = "bookmark",
    Bridge = "bridge",
    Briefcase = "briefcase",
    Bulb = "bulb",
    BuySell = "buy-sell",
    Cake = "cake",
    Calculator = "calculator",
    Calendar = "calendar",
    Call = "call",
    Camera = "camera",
    Campaign = "campaign",
    CardPos = "card-pos",
    Card = "card",
    Cash = "cash",
    Category = "category",
    Chart = "chart",
    CheckBold = "check-bold",
    Check = "check",
    CircleX = "circle-x",
    ClockFilled = "clock-filled",
    Clock = "clock",
    Close = "close",
    CloudDownload = "cloud-download",
    CloudUpload = "cloud-upload",
    Cloud = "cloud",
    CodeCircle = "code-circle",
    Code = "code",
    Coin = "coin",
    Collapse = "collapse",
    Confirmation = "confirmation",
    Connect = "connect",
    CopySuccess = "copy-success",
    Copy = "copy",
    CreditCheck = "credit-check",
    CurrencyFranc = "currency-franc",
    CurrencyLira = "currency-lira",
    CurrencyPound = "currency-pound",
    CurrencyYuan = "currency-yuan",
    Customize = "customize",
    Danger = "danger",
    DarkFilled = "dark-filled",
    Dark = "dark",
    Data = "data",
    Description = "description",
    Details = "details",
    Diagram = "diagram",
    DocumentCode = "document-code",
    Download = "download",
    Draft = "draft",
    EcoLeaf = "eco-leaf",
    EditSquare = "edit-square",
    Edit = "edit",
    EncryptedAdd = "encrypted-add",
    Eraser = "eraser",
    Error = "error",
    Ethereum = "ethereum",
    Exchange = "exchange",
    ExpandVertical = "expand-vertical",
    Expand = "expand",
    ExploreFilled = "explore-filled",
    Explore = "explore",
    Export = "export",
    Extension = "extension",
    EyeSlash = "eye-slash",
    Eye = "eye",
    FaceId = "face-id",
    Feedback = "feedback",
    File = "file",
    Filter = "filter",
    Fingerprint = "fingerprint",
    Fire = "fire",
    FirstPage = "first-page",
    Flag = "flag",
    FlashSlash = "flash-slash",
    Flash = "flash",
    Flask = "flask",
    Flower = "flower",
    Folder = "folder",
    Forest = "forest",
    FullCircle = "full-circle",
    Gas = "gas",
    Gift = "gift",
    GlobalSearch = "global-search",
    Global = "global",
    Graph = "graph",
    Hardware = "hardware",
    HashTag = "hash-tag",
    HeartFilled = "heart-filled",
    Heart = "heart",
    Hierarchy = "hierarchy",
    HomeFilled = "home-filled",
    Home = "home",
    Image = "image",
    Info = "info",
    Inventory = "inventory",
    Joystick = "joystick",
    KeepFilled = "keep-filled",
    Keep = "keep",
    Key = "key",
    LastPage = "last-page",
    LightFilled = "light-filled",
    Light = "light",
    Link = "link",
    Loading = "loading",
    Location = "location",
    LockSlash = "lock-slash",
    Lock = "lock",
    LockedFilled = "locked-filled",
    Login = "login",
    Logout = "logout",
    Mail = "mail",
    Map = "map",
    Menu = "menu",
    MessageQuestion = "message-question",
    Messages = "messages",
    Mic = "mic",
    MinusBold = "minus-bold",
    MinusSquare = "minus-square",
    Minus = "minus",
    Mobile = "mobile",
    MoneyBag = "money-bag",
    Money = "money",
    Monitor = "monitor",
    MoreHorizontal = "more-horizontal",
    MoreVertical = "more-vertical",
    MountainFlag = "mountain-flag",
    MusicNote = "music-note",
    Notification = "notification",
    PageInfo = "page-info",
    Palette = "palette",
    PasswordCheck = "password-check",
    Pending = "pending",
    People = "people",
    PersonCancel = "person-cancel",
    Pin = "pin",
    Plant = "plant",
    Plug = "plug",
    PlusAndMinus = "plus-and-minus",
    PolicyAlert = "policy-alert",
    Print = "print",
    PriorityHigh = "priority-high",
    PrivacyTip = "privacy-tip",
    ProgrammingArrows = "programming-arrows",
    Publish = "publish",
    QrCode = "qr-code",
    Question = "question",
    Receive = "receive",
    Received = "received",
    Refresh = "refresh",
    RemoveMinus = "remove-minus",
    Report = "report",
    Rocket = "rocket",
    SaveFilled = "save-filled",
    Save = "save",
    Saving = "saving",
    ScanBarcode = "scan-barcode",
    ScanFocus = "scan-focus",
    Scan = "scan",
    Search = "search",
    SecurityAlert = "security-alert",
    SecurityCross = "security-cross",
    SecurityKey = "security-key",
    SecuritySearch = "security-search",
    SecuritySlash = "security-slash",
    SecurityTick = "security-tick",
    SecurityTime = "security-time",
    SecurityUser = "security-user",
    Security = "security",
    Send = "send",
    SentimentDissatisfied = "sentiment-dissatisfied",
    SentimentNeutral = "sentiment-neutral",
    SentimentSatisfied = "sentiment-satisfied",
    SentimentVerySatisfied = "sentiment-very-satisfied",
    SettingFilled = "setting-filled",
    Setting = "setting",
    Share = "share",
    ShieldLock = "shield-lock",
    ShoppingBag = "shopping-bag",
    ShoppingCart = "shopping-cart",
    SignalCellular = "signal-cellular",
    Slash = "slash",
    Sms = "sms",
    SnapsMobile = "snaps-mobile",
    SnapsPlus = "snaps-plus",
    SnapsRound = "snaps-round",
    Snaps = "snaps",
    SortByAlpha = "sort-by-alpha",
    Sort = "sort",
    Sparkle = "sparkle",
    Speed = "speed",
    Speedometer = "speedometer",
    Square = "square",
    Stake = "stake",
    StarFilled = "star-filled",
    Star = "star",
    Start = "start",
    Storefront = "storefront",
    Student = "student",
    SwapHorizontal = "swap-horizontal",
    SwapVertical = "swap-vertical",
    TabClose = "tab-close",
    TableRow = "table-row",
    Tablet = "tablet",
    Tag = "tag",
    ThumbDownFilled = "thumb-down-filled",
    ThumbDown = "thumb-down",
    ThumbUpFilled = "thumb-up-filled",
    ThumbUp = "thumb-up",
    Tint = "tint",
    Tooltip = "tooltip",
    Translate = "translate",
    Trash = "trash",
    TrendDown = "trend-down",
    TrendUp = "trend-up",
    TriangleUp = "triangle-up",
    TriangleDown = "triangle-down",
    Undo = "undo",
    Unfold = "unfold",
    UnlockedFilled = "unlocked-filled",
    Unpin = "unpin",
    UploadFile = "upload-file",
    Upload = "upload",
    Usb = "usb",
    UserCheck = "user-check",
    UserCircleAdd = "user-circle-add",
    UserCircleRemove = "user-circle-remove",
    UserCircle = "user-circle",
    User = "user",
    VerifiedFilled = "verified-filled",
    Verified = "verified",
    Videocam = "videocam",
    ViewColumn = "view-column",
    ViewInAr = "view-in-ar",
    VolumeOff = "volume-off",
    VolumeUp = "volume-up",
    WalletFilled = "wallet-filled",
    Wallet = "wallet",
    Warning = "warning",
    WebTraffic = "web-traffic",
    Widgets = "widgets",
    WifiOff = "wifi-off",
    Wifi = "wifi",
    X = "x"
}
/**
 * The colors available to the {@link Link} component.
 */
export type IconColor = 'default' | 'primary' | 'muted' | 'error' | 'success' | 'warning';
/**
 * The props of the {@link Icon} component.
 *
 * @property name - The name of the icon to display from a pre-defined list.
 * @property color - The color of the displayed icon.
 * @property size - The size of the displayed icon. Use `inherit` to size it the same as the text.
 * @category Component Props
 */
export type IconProps = {
    name: `${IconName}`;
    color?: IconColor | undefined;
    size?: 'md' | 'inherit' | undefined;
};
/**
 * An icon component which is used to display an icon from a pre-defined list.
 *
 * @param props - The props of the component.
 * @param props.name - The name of the icon to display from a pre-defined list.
 * @param props.color - The color of the displayed icon.
 * @param props.size - The size of the displayed icon. Use `inherit` to size it the same as the text.
 * @returns An icon element.
 * @example
 * <Icon name="warning" color="warning" size="md" />
 * @category Components
 */
export declare const Icon: import("../component.mjs").SnapComponent<IconProps, "Icon">;
/**
 * An icon element.
 *
 * @see {@link Icon}
 * @category Elements
 */
export type IconElement = ReturnType<typeof Icon>;
//# sourceMappingURL=Icon.d.mts.map