Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@department-of-veterans-affairs/mobile-assets) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
VA Mobile Design System - Assets Package
The Assets package contains static assets such as fonts, images, and SVG icons for use by VA mobile applications.
For consumers
The Assets package is a peer dependency to the Components package so it is expected to be added separately via your package manager (e.g. yarn) alongside using components. It does not contain any code, so it is up to the consumer to configure the package to be leveraged by their app, notably the fonts so they are available within your app for the components.
The components package contains an Icon convenience component that makes leveraging both the assets package icons and custom SVGs specific to your app easy; it is highly recommended to use for icon needs. A visual list of available icons can be found in Storybook.
For contributors
Before contributing, consider if the contribution is necessary. This package is intended for shared assets. If your asset is only relevant to a specific app, then it should be handled within the app.
Fonts and Images
For fonts and images, contributing is as simple as adding the asset to the package via the GitHub web interface using the add file/folder buttons and creating a PR.
Icons
The majority of the included icons originate from a sprite sheet from @department-of-veterans-affairs/component-library. We have a script which extracts each of the SVGs from the sprite and saves them to the icons/vads folder. This makes them easier to use with the aforementioned Icon component.
For icons intended for use across VA web and mobile, please consult with VADS as they must be approved by the Design System Council before they can be added to the source sprite. Keep in mind the Icon convenience component can handle custom SVGs to help display an app-specific icon without it being part of the assets package.