Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@easypost/easy-ui-icons

Package Overview
Dependencies
Maintainers
0
Versions
29
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@easypost/easy-ui-icons

Easy UI Icons is a package containing the icons that experiences can use to build on the EasyPost platform, and contains SVG files in the `svg` directory.

  • 1.0.0-alpha.28
  • latest
  • npm
  • Socket score

Version published
Weekly downloads
70
decreased by-33.33%
Maintainers
0
Weekly downloads
 
Created
Source

Easy UI Icons

Easy UI Icons is a package containing the icons that experiences can use to build on the EasyPost platform, and contains SVG files in the svg directory.

Easy UI Icons generally uses a subset of Material Symbols.

Set: Material Symbols
Style: Outlined
Fill: 0
Weight: 300
Grade: Normal
Size: 48dp

Getting started

Although it’s possible to use this package directly, we recommend using the icons in this package through Easy UI React in combination with the Icon component.

Installation

  1. Install Easy UI React (instructions) if you haven’t already.

  2. Install Easy UI Icons as a dependency:

    Using npm:

    npm install @easypost/easy-ui-icons --save
    

Usage

Import the Icon component from Easy UI React and any icon from Easy UI Icons into your project.

  1. Import the icon component from Easy UI React:

    import Icon from "@easypost/easy-ui/Icon";
    
  2. Import an icon from Easy UI Icons:

    import CheckCircleIcon from "@easypost/easy-ui-icons/CheckCircle";
    
  3. Pass the imported Easy UI icon to the symbol prop of the Icon component:

    <Icon symbol={CheckCircleIcon} />
    

Icons imported as illustrated above will assume a weight of 300. To import an icon with a different weight, add the weight as a suffix to the path.

import Icon400 from "@easypost/easy-ui/Icon400";

SVG files

For projects that don’t use React and need the raw SVG, icons are available as *.svg files in the svg folder.

import svgFile from "@easypost/easy-ui-icons/svg/Info.svg";

Development

Commands

CommandRuns
npm run buildBuilds the icons project
npm run cleanRemoves temp directories
npm run devBuilds the icons project on file changes

Adding an icon

Add icons to the src/ folder. Easy UI Icons supports custom SVG files and JSON files referencing Material Symbol configurations.

All icons in src/ are transpiled to React components and re-exported as raw SVGs on build.

Material Symbols

Add a new Material Symbol icon by specifying a named JSON file with a Material Symbols configuration.

Check.json:

{
  "name": "check",
  "style": "outlined",
  "source": "@material-symbols/svg-300"
}

To add a new Material Symbol icon with a weight other than 300, update the above to reflect it as so; using a weight of 400 as an example:

Check400.json:

{
  "name": "check",
  "style": "outlined",
  "source": "@material-symbols/svg-400"
}

FAQs

Package last updated on 24 Oct 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc