Unkey
ContributingCompanyArchitectureRFCsDesignGitHub

Icons

Available icons for Unkey's apps.

PropTypeDefault
className
string | undefined
-

Customize

As a rule of thumb, you should only customize the color, but there's always an edge case.

Icons

These are all the icons available to import.

import { IconName } from "@unkey/icons";
<BarsFilter/>
<Bolt/>
<BookBookmark/>
<Calendar/>
<CaretRight/>
<Check/>
<ChevronExpandY/>
<ChevronLeft/>
<ChevronRight/>
<CircleCarretRight/>
<CircleCarretRight/>
<Fingerprint/>
<Gauge/>
<Gear/>
<Grid/>
<InputSearch/>
<Layers3/>
<Magnifier/>
<Nodes/>
<Plus/>
<Refresh3/>
<ShieldCheck/>
<ShieldKey/>
<Sliders/>
<Sparkle3/>
<TaskChecked/>
<TaskUnchecked/>
<TimeClock/>
<Trash/>
<TriangleWarning/>
<TriangleWarning2/>
<Ufo/>
<XMark/>

Adding new icons

Importing icons is a manual process.

Open the icon in the Nucleo UI Essential collection and select the icon(s) you want to export.

Export it as jsx, and remove the title. Nucleo Export Settings

Update the code to match our guidelines.

Rename the file to .tsx

Add the following license block at the start of the file:

/**
* Copyright © Nucleo
* Version 1.3, January 3, 2024
* Nucleo Icons
* https://nucleoapp.com/
* - Redistribution of icons is prohibited.
* - Icons are restricted for use only within the product they are bundled with.
*
* For more details:
* https://nucleoapp.com/license
*/

Replace the function syntax with: export const INSERT_ICON_NAME: React.FC<IconProps> = (props) => {

Remove the default export

Update all color references to currentColor

Add {...props} to the root svg element.

Export it in the /internal/icons/src/index.ts barrel file.

Import and add it in in this file under #icons in alphabetic order.

Previous

Colors

Next

Button

On this page