@digital-ai/dot-illustrations v1.0.10

dot-illustrations

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

Files are organized in 3 separate folders

• agility
• dashboards
• digitalai

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

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-digitalai-launch-light"></i>
</span>

Contributing

To add new illustrations, first add the new file to the appropriate location in one of the asset folders (agility, digitalai, dashboards.). 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:

/* Light illustrations */

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

/* Dark illustrations */

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

Finally, update demo/index.html by adding your new illustrations like so:

<div>
  <img class="illustration-agility-launch-dark"></i>
  <span>agility-launch-dark</span>
</div>

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",
  }