Package Health Score

90 / 100

security
No known security issues
popularity
Recognized
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
19.16.0	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
19.15.0	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
18.5.0	\|	03/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
17.1.0	\|	02/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
12.2.3	\|	09/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (10,220)

GitHub Stars: 145
Forks: 25
Contributors: 60

Direct Usage Popularity

The npm package @commercetools-uikit/icons receives a total of 10,220 downloads a week. As such, we scored @commercetools-uikit/icons popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package @commercetools-uikit/icons, we found that it has been starred 145 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 60
Funding: No

With more than 10 contributors for the @commercetools-uikit/icons repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 41
Open PR: 16
Last Release: 4 days ago
Last Commit: 8 days ago

Further analysis of the maintenance status of @commercetools-uikit/icons based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @commercetools-uikit/icons demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 10 Direct
Versions: 848
Install Size: 3.74 MB
Dist-tags: 5
# of Files: 179
Maintainers: 3
TS Typings: No

@commercetools-uikit/icons has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Icons

Description

All SVG icons are rendered as React components.

Usage

import { ExportIcon } from '@commercetools-uikit/icons';

;

Properties

Props	Type	Required	Values	Default	Description
`size`	`string`		'small', 'medium', 'big', 'scale'	'big'	Specifies the icon size (if `scale` is selected, the dimensions will scale according with the parents)
`color`	`string`		'solid', 'neutral60', 'info', 'primary', 'primary40', 'warning', 'error'	'solid'	Specifies the icon color

Where to use

Main use cases are:

Buttons

 {}}
  iconLeft={}
  label={this.props.intl.formatMessage(messages.exportList)}
/&gt;

Icon Buttons

 {}}
  icon={}
  label={this.props.intl.formatMessage(messages.exportList)}
/&gt;

Inline SVG for rendering custom icons

If you need to render an SVG icon that is not part of the default set of icons, it's possible to render it using a special component ``.

The component is exported as a separate entry point:

import InlineSvg from '@commercetools-uikit/icons/inline-svg';

Usage

import InlineSvg from '@commercetools-uikit/icons/inline-svg';

const svg = `<svg><path></path></svg>`;

const App = () =&gt; ;

The component accepts the same props as the <*Icon> components color and size. Additionally it requires the data prop, which is the actual SVG content.

XSS protection

The data passed to the component is run through a DOM sanitizer to prevent unwanted XSS injections.

Where to use

This component can be used whenever the icon has to be rendered dynamically on runtime. For example in the Merchant Center this can be the case for the navigation menu icons, etc.

Leading Icon

The leading icon is a an eye-catching visual element that should be used when an additional visual prominence is needed for a content section in the UI. The different colours in combination with the icons can be utilised to create certain categorisation of the elements in the UI.

The component is exported as a separate entry point:

import LeadingIcon from '@commercetools-uikit/icons/leading-icon';

Usage

import LeadingIcon from '@commercetools-uikit/icons/leading-icon';
import { ExportIcon } from '@commercetools-uikit/icons';

const app = () =&gt; } /&gt;;

Properties

Props	Type	Values	Default	Description
`size`	`string`	'10', '20', '30', '40'	'20'	Specifies the icon size
`color`	`string`	'accent', 'brown', 'neutral', 'purple', 'turquoise', 'white'	'neutral'	Specifies the icon's background color and fill color
`isInverted`	`boolean`	`true`, `false`	`false`	Specifies whether the icon has a light background and dark fill (`false`), or dark background and light fill (`true`)
`icon`	`ReactElement`	UI Kit `` component		Icon that is displayed within the component, you must supply a child icon with with this prop or the `svg` prop
`svg`	`string`	A custom SVG to display		Icon that is displayed using the `InlineSvg` component, you must supply a child icon with with this prop or the `icon` prop

Where to use

This component can be used wherever it is necessary to display a themed icon.

Custom Icon

This component is meant to be used whenever consumers need to render an icon which is not part of the ui-kit icon set.

In order to keep visual consistency, we want to keep the available sizes of all icons equal. Bear in mind we would expect custom SVG icons to not contain size attributes so it can be controlled based on the components size attribute.

The component is exported as a separate entry point:

import CustomIcon from '@commercetools-uikit/icons/custom-icon';

Usage

import CustomIcon from '@commercetools-uikit/icons/custom-icon';
import { YourCustomIcon } from './your-custom-icon-directory';

const app = () =&gt; } /&gt;;

Properties

Props	Type	Required	Values	Default	Description
`size`	`string`		'10', '20', '30', '40'	'20'	Specifies the icon size
`icon`	`union` Possible values: `, ReactElement, string`	-	A `ReactNode` or `string` that display a custom SVG		Icon displayed as a child of this component
`hasBorder`	`boolean`		`true`, `false`	`false`	Specifies whether the element displays a border

@commercetools-uikit/icons dependencies

@babel/runtime @babel/runtime-corejs3 @commercetools-uikit/design-system @commercetools-uikit/utils @emotion/react @emotion/styled @types/dompurify dompurify prop-types react-from-dom

@commercetools-uikit/icons development dependencies

react

FAQs

What is @commercetools-uikit/icons?

All SVG icons are rendered as React components. Visit Snyk Advisor to see a full health score report for @commercetools-uikit/icons, including popularity, security, maintenance & community analysis.

Is @commercetools-uikit/icons popular?

The npm package @commercetools-uikit/icons receives a total of 10,220 weekly downloads. As such, @commercetools-uikit/icons popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @commercetools-uikit/icons well maintained?

We found that @commercetools-uikit/icons demonstrated a healthy version release cadence and project activity. It has a community of 60 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @commercetools-uikit/icons safe to use?

The npm package @commercetools-uikit/icons was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 17 November-2024, at 14:52 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (10,220)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Icons

Description

Usage

Properties

Where to use

Inline SVG for rendering custom icons

Usage

XSS protection

Where to use

Leading Icon

Usage

Properties

Where to use

Custom Icon

Usage

Properties

@commercetools-uikit/icons dependencies

@commercetools-uikit/icons development dependencies

FAQs

What is @commercetools-uikit/icons?

Is @commercetools-uikit/icons popular?

Is @commercetools-uikit/icons well maintained?

Is @commercetools-uikit/icons safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues