Package Exports
- @rhysforyou/gatsby-plugin-safari-site-icon
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 (@rhysforyou/gatsby-plugin-safari-site-icon) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
gatsby-plugin-safari-site-icon
Adds support for shipping a Safari site icon with your site. Safari site icons are monochrome, SVG icons which safari uses in place of favicons where provided.
This section of Apple's developer documentation gives a good overview of the subject, though it's worth noting these icons are now used in many other cases than just pinned sites nowadays.
Installation
# Yarn
yarn add @rhysforyou/gatsby-plugin-safari-site-icon
# npm
npm install --save @rhysforyou/gatsby-plugin-safari-site-iconUsage
Add the plugin and its options to your gatsby-config.js like so:
module.exports = {
plugins: [
{
resolve: "@rhysforyou/gatsby-plugin-safari-site-icon",
options: {
icon: "./src/images/pinned-tab-icon.svg",
color: "#FF374B"
}
}
]
};Options
| Name | Required | Description |
|---|---|---|
icon |
✅ | The path to your icon, relative to the site root |
color |
❌ | The color your icon should be tinted with |