isSpartanIconName
@spartanfx/react / index / isSpartanIconName
Function: isSpartanIconName()
function isSpartanIconName(name): name is "Mail" | "Accept" | "CheckMark" | "Add" | "Cancel" | "ChromeClose" | "Delete" | "Edit" | "Copy" | "Refresh" | "Clock" | "Link" | "RemoveLink" | "Ringer" | "Info" | "Warning" | "ErrorBadge" | "Completed" | "Lightbulb" | "Undo" | "Upload" | "Move" | "SIPMove" | "OpenInNewWindow" | "Export" | "Page" | "ReadingMode" | "FollowUser" | "PeopleExternalShare" | "ChevronDown" | "ChevronLeft" | "ChevronRight" | "Up" | "Down" | "CaretDown8" | "CaretUp8" | "SortUp" | "SortDown" | "More" | "MoreCommands" | "Filter" | "FilterSolid" | "ClearFilter" | "RemoveFilter" | "ColumnOptions" | "SearchIssue" | "GripperDotsVertical" | "CircleAddition" | "DuplicateRow" | "DependencyRemove" | "Calendar" | "CalendarWeek" | "CalendarAgenda" | "Bold" | "Italic" | "Underline" | "Strikethrough" | "Subscript" | "Superscript" | "Font" | "FontSize" | "FontIncrease" | "FontDecrease" | "ClearFormatting" | "Brush" | "RightDoubleQuote" | "NumberSymbol" | "NumberField" | "AlignLeft" | "AlignCenter" | "AlignRight" | "BulletedList" | "NumberedList" | "List" | "Header" | "Header1" | "LineSpacing" | "Code" | "PaddingLeft" | "PaddingRight" | "BidiLtr" | "BidiRtl" | "TableComputed" | "InsertColumnsRight" | "DeleteTable" | "BackgroundColor" | "Photo2" | "ImageSearch" | "BorderDash" | "ZoomIn" | "ClearNight" | "DOM" | "DeveloperTools" | "ExcelLogo" | "TeamsLogo" | "Folder" | "Document" | "WordDocument" | "TextDocument" | "PDF" | "ExcelDocument" | "PowerPointDocument" | "FileImage" | "FileCode" | "FileHTML" | "Video" | "MusicInCollection" | "ZipFolder" | "ChevronUp" | "DoubleChevronLeft8" | "DoubleChevronRight8" | "Back" | "Forward" | "Home" | "GlobalNavButton" | "Settings" | "Search" | "Help" | "Clear" | "Save" | "Download" | "Share" | "Print" | "Cut" | "Paste" | "Redo" | "Sync" | "Pinned" | "Lock" | "Unlock" | "View" | "Hide" | "Money" | "Repair" | "Error" | "Blocked" | "FavoriteStar" | "FavoriteStarFill" | "Heart" | "HeartFill" | "Emoji" | "LikeSolid" | "DislikeSolid" | "Phone" | "Chat" | "Comment" | "Send" | "Contact" | "People" | "AddFriend" | "Play" | "Pause" | "Stop" | "Previous" | "Next" | "Volume3" | "Mute" | "Camera" | "Microphone" | "OpenFolder" | "NewFolder" | "Attach" | "ShoppingCart" | "Tag" | "Flag" | "Bookmark" | "Location" | "Globe" | "Cloud" | "CloudUpload" | "Database" | "Sort" | "GridView" | "Dashboard" | "BarChart" | "LineChart" | "PieChart" | "FullScreen" | "BackToWindow" | "Remove" | "CheckboxComposite" | "Checkbox" | "RadioBtnOn" | "RadioBtnOff" | "Highlight";
Narrowing helper: is name a known in-house icon?
Parameters
name
string
Returns
name is "Mail" | "Accept" | "CheckMark" | "Add" | "Cancel" | "ChromeClose" | "Delete" | "Edit" | "Copy" | "Refresh" | "Clock" | "Link" | "RemoveLink" | "Ringer" | "Info" | "Warning" | "ErrorBadge" | "Completed" | "Lightbulb" | "Undo" | "Upload" | "Move" | "SIPMove" | "OpenInNewWindow" | "Export" | "Page" | "ReadingMode" | "FollowUser" | "PeopleExternalShare" | "ChevronDown" | "ChevronLeft" | "ChevronRight" | "Up" | "Down" | "CaretDown8" | "CaretUp8" | "SortUp" | "SortDown" | "More" | "MoreCommands" | "Filter" | "FilterSolid" | "ClearFilter" | "RemoveFilter" | "ColumnOptions" | "SearchIssue" | "GripperDotsVertical" | "CircleAddition" | "DuplicateRow" | "DependencyRemove" | "Calendar" | "CalendarWeek" | "CalendarAgenda" | "Bold" | "Italic" | "Underline" | "Strikethrough" | "Subscript" | "Superscript" | "Font" | "FontSize" | "FontIncrease" | "FontDecrease" | "ClearFormatting" | "Brush" | "RightDoubleQuote" | "NumberSymbol" | "NumberField" | "AlignLeft" | "AlignCenter" | "AlignRight" | "BulletedList" | "NumberedList" | "List" | "Header" | "Header1" | "LineSpacing" | "Code" | "PaddingLeft" | "PaddingRight" | "BidiLtr" | "BidiRtl" | "TableComputed" | "InsertColumnsRight" | "DeleteTable" | "BackgroundColor" | "Photo2" | "ImageSearch" | "BorderDash" | "ZoomIn" | "ClearNight" | "DOM" | "DeveloperTools" | "ExcelLogo" | "TeamsLogo" | "Folder" | "Document" | "WordDocument" | "TextDocument" | "PDF" | "ExcelDocument" | "PowerPointDocument" | "FileImage" | "FileCode" | "FileHTML" | "Video" | "MusicInCollection" | "ZipFolder" | "ChevronUp" | "DoubleChevronLeft8" | "DoubleChevronRight8" | "Back" | "Forward" | "Home" | "GlobalNavButton" | "Settings" | "Search" | "Help" | "Clear" | "Save" | "Download" | "Share" | "Print" | "Cut" | "Paste" | "Redo" | "Sync" | "Pinned" | "Lock" | "Unlock" | "View" | "Hide" | "Money" | "Repair" | "Error" | "Blocked" | "FavoriteStar" | "FavoriteStarFill" | "Heart" | "HeartFill" | "Emoji" | "LikeSolid" | "DislikeSolid" | "Phone" | "Chat" | "Comment" | "Send" | "Contact" | "People" | "AddFriend" | "Play" | "Pause" | "Stop" | "Previous" | "Next" | "Volume3" | "Mute" | "Camera" | "Microphone" | "OpenFolder" | "NewFolder" | "Attach" | "ShoppingCart" | "Tag" | "Flag" | "Bookmark" | "Location" | "Globe" | "Cloud" | "CloudUpload" | "Database" | "Sort" | "GridView" | "Dashboard" | "BarChart" | "LineChart" | "PieChart" | "FullScreen" | "BackToWindow" | "Remove" | "CheckboxComposite" | "Checkbox" | "RadioBtnOn" | "RadioBtnOff" | "Highlight"