🚧 Rspress 2.0 document is under development
close

Built-in icons

When Rspress uses icons, it uses a SvgWrapper component to render icons. It supports icon as a URL or an svgr React component:

type Icon = React.FC<React.SVGProps<SVGSVGElement>> | string;

The following code is an example of how Rspress uses IconGithub:

Usage

When you want to replace Rspress built-in icons, use Custom Theme - Re-export for replacement.

theme/index.tsx
export { IconGithub } from './my-icons';
export * from '@rspress/core/theme-original';

All icons used by Rspress are as follows: