4.2 KiB
SVG Icons
import type { IconName } from '@ray-template/icons'
import { RIcon } from '@ray-template/ui/icon'
const name: IconName = 'directional/resize_h'
const renderIcon = () => <RIcon name={name} />
RIcon.name and route meta.icon use the same group-qualified names. For example, packages/icons/src/business/orders/approved.svg becomes business/orders/approved. Search and copy usage from the SVG Icons demo.
Interactive example
The icon library copies TSX by default, such as <RIcon name="action/search" />. Select Vue template and click an icon to copy <r-icon name="action/search" /> for a Vue template that imports RIcon.
::: details View example source <<< @/../admin/src/views/demo/svg-icons/index.tsx :::
Add and generate icons
- Choose an existing group such as
action,navigation, orsystem, or create a business group. Start path segments with a letter and use lowercase letters, digits, underscores, or hyphens. - Use
currentColorfor monochrome icons andnonefor empty areas. Keep brand colors. - The dev server or
pnpm icons:generateupdatespackages/icons/src/manifest.ts. Verify withpnpm icons:checkand commit the manifest with the SVGs. Generate the union type from the files.
Production builds generate a separate hashed sprite per top-level group, loaded under the deployment base. Replace bare names in old source. Cached bare names are migrated only if the filename is unique.
RIcon API
@/components exports RIcon, IconProps, iconProps, IconName, and IconPackage. @/icons also exports the icon types.
| Prop | Default | Description |
|---|---|---|
name |
Required | Full group-qualified path. The first segment selects the sprite. |
size |
20 |
Base width and height. Numbers are pixels, and CSS sizes are supported. |
width / height |
0 / 0 |
Override the base dimensions individually. 0 uses size. |
color |
'currentColor' |
SVG fill. Brand icons with their own colors may retain them. |
prefix |
'icon' |
Symbol prefix, which must match generation. |
customClassName |
None | Extra class for the root. |
depth |
1 |
Icon opacity level. |
cursor |
'inherit' |
Inherits the parent control's cursor. |
onClick(event) |
None | Accepts a callback or array. |
The inner SVG is hidden from screen readers. For an action, wrap it in a button with an accessible name and preserve keyboard operation and focus.
RIcon props · Sprite reference implementation
Icon sources
Shared icons come from the IconPark outline collection on Iconfont. The source inventory lists names and Iconfont IDs by use. Monochrome icons follow text color. Ray and other brand marks retain their original colors.
Prefer existing icon names. Three retired assets migrate when loading old route configurations.
action/export_excelbecomesaction/download.logo/officebecomesnavigation/table.illustration/login_bgbecomesnavigation/other.
Use the new full names in new code.