Vitepress Theme Akari Docsv1.0.0GitHubSettingsMore

Choosing icons ​

Every Material Symbols icon comes in three styles and two forms. The theme uses the outlined style by default, and the filled form for states such as selected or on.

Styles ​

StyleCharacterImport path
OutlinedEven strokes and clear spacing; fits best with M3 components@m3e/icons/outlined/<name>
RoundedRounded stroke ends and corners; softer@m3e/icons/rounded/<name>
SharpSquare corners; harder-edged@m3e/icons/sharp/<name>

Keep to one style within an interface. The theme's navigation, app bar and buttons all use Outlined. To switch the whole site to Rounded, replace every import in icons.ts and set variant="rounded" on <m3e-icon>.

Outlined and filled ​

The filled attribute shows an icon's filled form:

html
<m3e-icon name="home"></m3e-icon>
<m3e-icon name="home" filled></m3e-icon>

M3 uses fill to mean "current" or "on": in the rail, the current category's icon is filled and the others are outlined. Don't rely on fill alone to show state; the selected item also changes its background color and text.

Size ​

Icons are 24px by default and scale with font-size. Common sizes:

SizeUse
20pxCompact lists, inline notes
24pxDefault: buttons, navigation, list items
40px and upEmpty-state illustrations, onboarding pages
html
<m3e-icon name="search" style="font-size: 20px"></m3e-icon>
<m3e-icon name="search_off" style="font-size: 48px"></m3e-icon>

Don't change the icon size inside components such as buttons and navigation items. These components already set icon size and spacing according to the M3 spec.

Choosing the right icon ​

  • Prefer icons with established meanings: search for search, settings for settings, translate for language.
  • Use one icon per meaning, and don't use the same icon for different actions in different places.
  • When an abstract concept (such as "theme" or "component") has no common icon, pick one with a simple shape that stays clear at 24px, and always pair it with text.
GitHub Settings

Search the docs

Type a page title, a component name or words from the text.

Press ⌘/Ctrl + K to open it anytime

Choose a language

EnglishEnglish (United States)العربيةArabic (Saudi Arabia)FrançaisFrench (France)日本語Japanese (Japan)한국어Korean (South Korea)简体中文Chinese (China)

Settings

Color
VariantTonal SpotVibrantFidelityExpressiveMonochromeNeutralRainbowFruit Salad
ContrastDefaultMediumHigh
MotionStandardExpressive
Text directionFollow languageLeft to rightRight to left
Text size100%150%200%