Skip to content

Icon System

Miuix provides a rich built-in icon system that meets the primary design needs of most applications. These icons are categorized by functionality and usage, making them easy to use in your projects.

Usage

To use Miuix icons in your project, first import them correctly:

kotlin
import androidx.compose.foundation.layout.size
import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier
import androidx.compose.ui.unit.dp
import top.yukonga.miuix.kmp.basic.Icon
import top.yukonga.miuix.kmp.icon.MiuixIcons

Then, you can use the icons as follows:

kotlin
// Use the Check icon from the Basic category
Icon(
    imageVector = MiuixIcons.Basic.Check,
    contentDescription = "Check",
    modifier = Modifier.size(24.dp)
)

// Use the Settings icon from the Useful category
Icon(
    imageVector = MiuixIcons.Useful.Settings,
    contentDescription = "Settings",
    modifier = Modifier.size(24.dp)
)

Icon Categories

The Miuix icon system currently includes the following main categories:

Basic Icons

Basic icons include commonly used basic UI elements such as arrows and checkmarks. These icons are also used in Miuix's own components. Below is the complete list:

  • Check: Checkmark icon
  • ArrowUpDown: Up and down arrow icon
  • ArrowUpDownIntegrated: Integrated up and down arrow icon
  • ArrowRight: Right arrow icon

Useful Icons

Useful icons include a large number of functional icons suitable for various application scenarios. Below is the complete list:

Icon NameDescriptionCommon Usage
AddSecretAdd encrypted contentAdd passwords, private items, etc.
BackBack iconNavigate back to the previous screen
BlocklistBlocklist iconBlock users, add to blacklist
CancelCancel iconCancel operations, close dialogs
CopyCopy iconCopy content to clipboard
CutCut iconCut content to clipboard
DeleteDelete iconDelete items, content, or files
EditEdit iconEdit content, modify information
ImmersionMoreImmersive more optionsShow more options in immersive mode
InfoInfo iconShow detailed information, tips
LikeLike iconLike, favorite functionality
MoreMore iconShow more options or menus
MoveMove iconMove items to other locations
NavigatorSwitchNavigation switch iconSwitch navigation views
NewNew iconCreate new content, files, or items
OrderOrder iconSort content
PastePaste iconPaste content from clipboard
PersonalPersonal/user iconPersonal information, user page
PlayPlay iconPlay media content
RebootReboot iconRestart app or system
RefreshRefresh iconRefresh content or page
RemoveRemove iconRemove items (soft delete)
RemoveBlocklistRemove blocklist iconUnblock
RemoveSecretRemove encrypted contentRemove encrypted items
RenameRename iconRename files or items
RestoreRestore iconRestore deleted content
SaveSave iconSave content or changes
ScanScan iconScan QR codes, etc.
SearchSearch iconSearch content
SelectAllSelect all iconSelect all items
SettingsSettings iconApp or system settings
ShareShare iconShare content to other platforms
StickStick iconPin content to the top
UnlikeUnlike iconUnlike or unfavorite
UnstickUnpin contentUnpin content
UpdateUpdate iconUpdate apps or content

Other Icons

The "Other" category includes icons for specific scenarios.

  • GitHub: GitHub icon

Released under the Apache-2.0 License