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

@digital-ai/dot-illustrations

v2.0.6

Published

A central place for the design team to keep illustrations and for dev teams to find them.

Downloads

1,465

Readme

dot-illustrations and integrations

A central place for the design team to keep illustrations all graphical assets for dev teams to find them.

Files are organized in 2 separate folders

  • illustrations
  • integrations

Illustrations

image

In each one of those, there is a light and dark folder to match the color style if you using a material theme do not forget to update the illustration folder directory light / dark to match the theme of the switch

Illustrations usage

React Component via dot-components

(PENDING WIP): If you are already consuming dot-components then the easiest way would be to use the DotIllustration component, documentation is available here

Standard HTML

If not using dot-components then import @digital-ai/dot-illustrations into your project as an npm package or as a git submodule. You can also download the contents of this repository and copy the index.css and asset folders into your project.

<link rel="stylesheet" href="./index.css" />

...

<span class="dot-illustration">
  <img class="${illustration-ID}"/>
</span>

Integrations

image

Integrations usage

React Component via dot-components COMING UP SOON

(PENDING WIP): If you are already consuming dot-components then the easiest way would be to use the DotIllustration component, documentation is available here

Standard HTML

If not using dot-components then import @digital-ai/dot-illustrations into your project as an npm package or as a git submodule. You can also download the contents of this repository and copy the ./integrations/index.css and asset folders into your project.

<link rel="stylesheet" href="./integrations/index.css" />

...

 <span class="dot-integration">
   <img class="${integration-ID}"/>
</span>

Contributing

To add new illustrations, first add the new file to the appropriate location in one of the asset folders (illustrations or integrations.). The file names should not contain spaces or special characters, and they must be uniquely named project wide.

Next, add new class selectors to index.css that set the content to your new files. Define the light version first, then if you have a dark version, define it second with an additional .dark-theme class selector. For example:

/* ------------------ GLOBAL ILLUSTRATIONS -------------------- */
/*Path: --------- './illustrations/light/global/*.svg  ----- light */
/*Path: --------- './illustrations/dark/global/*.svg  ------ dark */ 

.dot-illustration img.done.light {
    content: url('./illustrations/light/global/done.svg');
}

.dot-illustration img.done.dark {
    content: url('./illustrations/dark/global/done.svg');
}

Finally, update demo/script.js by adding your new illustrations in function "doMagic" by ID name like so:

// Global arrange from A-Z
    "add-new",
    "add-new-grid",
    "add-team",
    "add-user",
    "assets",

Once complete, please submit a pull request with the updated files and request someone to review in the #dot-components channel on slack.

More information is available in the .dot design system

Troubleshooting

If for some reason the latest version of dot-illustrations is not available in dot-components then you can update your package.json to use the latest version of dot-illustrations by adding the following to your resolutions section.

  "resolutions": {
    "@digital-ai/dot-illustrations": "latest",
  }