Back to Twenty

Icons

packages/twenty-docs/twenty-ui/display/icons.mdx

2.2.01.4 KB
Original Source
<Frame> </Frame>

A list of icons used throughout our app.

Tabler Icons

We use Tabler icons for React throughout the app.

<Tabs> <Tab title="Installation">
yarn add @tabler/icons-react
</Tab> <Tab title="Props">

You can import each icon as a component. Here's an example:

jsx
import { IconArrowLeft } from "@tabler/icons-react";

export const MyComponent = () => {
  return <IconArrowLeft color="red" size={48} />;
};
</Tab> <Tab title="Props">
PropsTypeDescriptionDefault
sizenumberThe height and width of the icon in pixels24
colorstringThe color of the iconscurrentColor
strokenumberThe stroke width of the icon in pixels2
</Tab> </Tabs>

Custom Icons

In addition to Tabler icons, the app also uses some custom icons.

Icon Address Book

Displays an address book icon.

<Tabs> <Tab title="Usage">
jsx
import { IconAddressBook } from 'twenty-ui/display';

export const MyComponent = () => {
  return <IconAddressBook size={24} stroke={2} />;
};
</Tab> <Tab title="Props">
PropsTypeDescriptionDefault
sizenumberThe height and width of the icon in pixels24
strokenumberThe stroke width of the icon in pixels2
</Tab> </Tabs>