Expand Minimize

SPF019918: Specify valid Web Part image URL

Specify valid Web Part image URL

CheckId SPF019918
TypeName SpecifyValidIconImageUrl
Severity CriticalError
Type Web Part Manifest

Web part image URL in the iconImageUrl property must be an absolute URL.

Bad practice

{
  "$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" },
    "iconImageUrl": "/assets/webpart-icon.png",
    "properties": {
      "location": ""
    }
  }]
}


Good practice
{
  "$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" },
    "iconImageUrl": "https://spfx.blob.core.windows.net/spfx-weather-webpart/assets/webpart-icon.png",
    "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.