SPF019917: Don't specify both Web Part icon and Web Part image |
Web Part manifest shouldn't specify both the Web Part icon and Web Part image
CheckId | SPF019917 |
---|---|
TypeName | DontSpecifyBothWebPartIconAndImage |
Severity | Warning |
Type | Web Part Manifest |
Each group of preconfigured entries in the Web Part manifest should specify a Web Part image either using the officeFabricIconFontName or the iconImageUrl property but not both. When both values are specified, the value of the iconImageUrl property is ignored and the icon specified in the officeFabricIconFontName property is used instead.
Web Part image set using the officeFabricIconFontName property (MyWebPart.manifest.json):
{
"$schema": "../../../node_modules/@microsoft/sp-module-interfaces/lib/manifestSchemas/jsonSchemas/clientSideComponentManifestSchema.json",
"id": "8908df13-a965-4445-9c48-ecec77c44be4",
"alias": "WeatherWebPart",
"componentType": "WebPart",
"version": "0.0.1",
"manifestVersion": 2,
"preconfiguredEntries": [{
"groupId": "8908df13-a965-4445-9c48-ecec77c44be4",
"group": { "default": "Default" },
"title": { "default": "Weather" },
"description": { "default": "Shows weather for the given place" },
"officeFabricIconFontName": "Sunny",
"properties": {
"location": ""
}
}]
}
"$schema": "../../../node_modules/@microsoft/sp-module-interfaces/lib/manifestSchemas/jsonSchemas/clientSideComponentManifestSchema.json",
"id": "8908df13-a965-4445-9c48-ecec77c44be4",
"alias": "WeatherWebPart",
"componentType": "WebPart",
"version": "0.0.1",
"manifestVersion": 2,
"preconfiguredEntries": [{
"groupId": "8908df13-a965-4445-9c48-ecec77c44be4",
"group": { "default": "Default" },
"title": { "default": "Weather" },
"description": { "default": "Shows weather for the given place" },
"officeFabricIconFontName": "Sunny",
"properties": {
"location": ""
}
}]
}
Disclaimer: The views and opinions expressed in this documentation and in SPCAF do not necessarily reflect the opinions and recommendations of Microsoft or any member of Microsoft. SPCAF and RENCORE are registered trademarks of Rencore. All other trademarks, service marks, collective marks, copyrights, registered names, and marks used or cited by this documentation are the property of their respective owners.