Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 937 Bytes

readme.md

File metadata and controls

43 lines (29 loc) · 937 Bytes

Cypress Icons

The latest versions of the icons. The public API will always reference these files.

./dist is not checked into source control.

API

const icons = require("@cypress/icons")

// get the absolute path to default favicon
icons.getPathToFavicon("favicon-blue.ico")
// => /Users/.../dist/favicon/favicon-blue.ico

// get the absolute path to icon
icons.getPathToIcon("[email protected]")
// => /Users/.../dist/icons/[email protected]

Architecture detail

To build the MacOS icons you have to use the iconutil command line tool installed. This command line tool is only installed on MacOS.

If you are not on MacOS, the building of this icon will simply be skipped. If you are not on MacOS, the building of this icon will be skipped instead of erroring.

Developing

All the icons are in the assets directory.

## run build to dump to ./dist
yarn build

Testing

yarn test