npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@synergy-design-system/assets

v1.10.0

Published

Assets for the Synergy Design System

Downloads

89

Readme

@synergy-design-system/assets

This package provides assets like:

  • logos: a collection of various logos (such as the variants of the SICK brand logo)
  • icons: the standard icons based on Material Icons
  • system-icons: a small subset of icons, that are internally used by the Synergy components

The source of the assets can be found at Figma

Installation

Please make sure to install the assets package as a dependency:

npm install --save @synergy-design-system/assets

Usage

All assets are provided as svg's.

The recommended way of using the icons is using the Synergy component. Here you will also get more information about how setting up the assets package on bundlers like vite.

<syn-icon name="warning"></syn-icon>

But the assets could also be used like following:

<img src="assets/icons/warning.svg" />

Development

This package is taking care about getting assets (like logos, system icons and default icons) from Figma. The folder structure of the assets corresponds to the structure of the Figma page.

  • logos: contains the variants of the SICK brand logo
  • icons: contains the standard icons based on Material Icons
  • system-icons: contains a small subset of icons, that are internally used by the Synergy components

Note: All assets from figma, which should not appear in this package (e.g. documentation), will start with an underscore (e.g. _my-doc-for-an-asset). This assets are getting filtered and ignored by this package.

Setup

To update the assets from Figma, first of all a personal access token in Figma needs to be created. The documentation how this can be achieved can be found here. The only needed scope is "File content" set to readonly.

After the creation of the personal access token, it needs to be saved in a .env file with the variable "FIGMA_PERSONAL_ACCESS_TOKEN". It should look like following:

FIGMA_PERSONAL_ACCESS_TOKEN = "my-personal-access-token"

Update assets from Figma

If something in the Figma assets got changed, the assets of this package also needs to be updated. To update the assets run following in the terminal of the assets package folder:

pnpm fetch-assets