ESLint plugin

The essential plugin for use with the Atlassian Design System.

no-utility-icons

Utility icons are to be phased out by the Design system team. We instead encourage using core icon with our new size prop. Docs link.

Examples

This rule checks for usage of utility icons and enforces using their core counterparts.

Incorrect

import AddIcon from '@atlaskit/icon/utility/add';

<AddIcon label="" />;

Correct

import AddIcon from '@atlaskit/icon/core/add';

<AddIcon label="" size="small" />;

Options

This rule comes with an option to configure whether autofixes are provided

enableAutoFixer

Enables/disables autofixes for icons that are able to be automatically migrated. Defaults to false to reduce noise.

Was this page helpful?
We use this feedback to improve our documentation.