Sp-dev-docs: SpFx Helloworld webpart does not show up under modern Page toolbox

Created on 9 Aug 2017  ·  80Comments  ·  Source: SharePoint/sp-dev-docs

Thank you for reporting an issue or suggesting an enhancement. We appreciate your feedback - to help the team to understand your needs, please complete the below template to ensure we have the necessary details to assist you.

Category

  • Bug
    spfx issue

If you are planning to share a new feature request (enhancement / suggestion), please use SP Dev UserVoice at http://aka.ms/sp-dev-uservoice.

Expected or Desired Behavior

After adding SpFx webpart to site contents, the webpart should be available in toolbox for modern UI page in SharePoint online.

Observed Behavior

Cannot find Simple hello world webpart in modern UI page toolbox, although it is available under site contents.

Steps to Reproduce

Followed all steps as explained in article
https://dev.office.com/sharepoint/docs/spfx/web-parts/get-started/serve-your-web-part-in-a-sharepoint-page
However, stuck at last step, i.e. cannot add webpart to page.

spfx-general fixed tracked bug-suspected
Source
picture Moreshwar83

Most helpful comment

The cause of the problem has been identified and we will be rolling out a fix for it shortly. Unfortunately the problem is in the generator which means packages have been created that cause this problem and will continue to cause problems. In order to fix the problem after the fix is applied you will have to do the following:

  1. Uninstall the app from a site collection
  2. The app will have to be deleted from the app catalog
  3. The new version of the app (built with the new generator) will have to be uploaded to the app catalog
  4. Then the app will have to be added back to the site collection.

This process will work on todays solutions as well, however, it will have to be re-done after the fix is rolled out.

Sorry for the trouble has caused and thank you for helping us diagnose the issue.

picture GrahamMcMynn on 14 Feb 2018
👍6

All 80 comments

Silly question, but can you scroll down in the modern page toolbox and see it lower?

patmill picture patmill on 9 Aug 2017
👎8 👍1

Offcourse I have tried it. The webpart cannot be seen at all. I was not able to put that together in screenshot. Below is full screen grab, if that helps
spfx1

Moreshwar83 picture Moreshwar83 on 9 Aug 2017
👍1

OK, just double checking. Did you get your part working on your local workbench and / or hosted workbench before uploading it to the app catalog?

If you type this into your browser (https://yourtenant.sharepoint.com/sites/yoursite/_api/web/GetClientSideWebParts) can you find your webpart listed?

If you go to your app catalog site, can you go to https://yourtenant.sharepoint.com/sites/yourappcatalog/Lists/ComponentManifests/AllItems.aspx and see your webpart in the list of available components?

patmill picture patmill on 9 Aug 2017

Hello Patmill,
Please find my answers below:

Did you get your part working on your local workbench and / or hosted workbench before uploading it to the app catalog?
Ans: Yes it is working on local workbench.
If you type this into your browser (https://yourtenant.sharepoint.com/sites/yoursite/_api/web/GetClientSideWebParts) can you find your webpart listed?
Ans: No, I cannot find it.

If you go to your app catalog site, can you go to https://yourtenant.sharepoint.com/sites/yourappcatalog/Lists/ComponentManifests/AllItems.aspx and see your webpart in the list of available components?
Ans: No, I do not see it here as well

Moreshwar83 picture Moreshwar83 on 9 Aug 2017
👍1

It started working now.
Resolution:

  1. Go to ~appcatalog/AppCatalog/Forms/AllItems.aspx
  2. Edit properties for the web part, I added short description & Description and saved.
    Webpart started appearing under ~appcatalog/Lists/ComponentManifests/AllItems.aspx
  3. Removed and re-added webpart from dev site.
    It started showing up in page toolbox. I was able to add and see it on page as well.

Thank you for your guidance Patmill.

Moreshwar83 picture Moreshwar83 on 9 Aug 2017
👍2

Glad you got it sorted out.

patmill picture patmill on 10 Aug 2017

@Moreshwar83 Thanks for pointing out to fill 'Description' and 'Short Description'. If there is no 'Description' and 'Short description' 'Client Side WebPart' don't show up in the modern page toolbox.

@patmill There seem to be bug in pulling 'Client Side WebPart' to show up in the modern page toolbox when 'Description' and 'Short Description' not filled in against the app in app catalog.

Dilli picture Dilli on 23 Aug 2017

If you check the schema of the web part manifest in ./node_modules/@microsoft/sp-module-interfaces/lib/manifestSchemas/IClientSideWebPartManifest.d.ts you can see that the description property is required. When you try to build the project without it, or with an empty value you will get a build error. Could you share your web part manifest so that we can see your configuration?

waldekmastykarz picture waldekmastykarz on 23 Aug 2017

@waldekmastykarz
Firstly, the manifest path provided above does not seems correct in local. But managed to find the file in the following path '.\SPFx\helloworld-webpart\node_modules\@microsoft\sp-module-interfaces\lib\manifestSchemas'. Please comment otherwise.

IClientSideWebPartManifest.d.ts.txt

I do see, the 'description' is not optional in the file, but could be bug in mappings.
There is no mention about 'short description' field though in the very same file.

P.S I have added '.txt' extension to the file as the file type is not supported by git hub comments.

Dilli picture Dilli on 24 Aug 2017

@Dilli sorry, I shortened the path too much in my comment, you got it right. Where did you get the reference to 'short description' from? It doesn't seem to be mentioned anywhere.

waldekmastykarz picture waldekmastykarz on 24 Aug 2017

@waldekmastykarz , Myself picked the 'short description' from app catalog. Please ignore 'short description'.

Dilli picture Dilli on 28 Aug 2017
👍1

Hi @patmill @Moreshwar83

what would i do if i cant see it in the /_api/web/GetClientSideWebParts but it is present in the sites/appcatalog/Lists/ComponentManifests/AllItems.aspx. i still cant see it when i try to add my webpart

P.S: my webpart has description as well

paigeflourin picture paigeflourin on 23 Nov 2017

I'm experiencing the same behavior as @paigeflourin - worked last week (11/20), but now, the updated web part no longer appears in the web part gallery.

I did add a provisioning feature to my solution in addition to the web part - and I'm wondering if that is what is causing the web part to no longer appear. I tried a new build without the feature block in the package-solution.json file, but that does not seem to fix it.

My solution does not appear in the /_api/web/GetClientSideWebParts output, but it is shown in ~appcatalog/Lists/ComponentManifests/AllItems.aspx and has no error messages from deployment.

Any guidance is appreciated.

smithderekm picture smithderekm on 27 Nov 2017

I'm facing the same issue as @paigeflourin .
Moreover when I try to unsinstall the app containing the webpart, it goes to recycle bin and shows zero KBs as size.
I'm unable to delete it from solution from recycle bin and consequently unable to try updating the web part as well.
Anyone else facing this issue?

vickeybird picture vickeybird on 19 Dec 2017

In my case, I found that when I added my own feature definition in the package-solutions file for provisioning, it was essentially overwriting the feature for the web part. The tooling generates the feature behind the scenes but never reveals it (annoying!) so my hand-entered feature caused the conflict.

The fix was to ensure that the package-solution file has 2 features with different IDs - one for the web part, and one for the provisioning. Once I did that, then the installation of the app put everything in the right place and the web part re-appeared in the gallery to place on a page.

Here's a sample package-solution.json to illustrate. You'll need to generate new guids for your solution/features.

{
  "$schema": "https://dev.office.com/json-schemas/spfx-build/package-solution.schema.json",
  "solution": {
    "name": "Hello World",
    "id": "300ecbc4-f139-459e-bb2d-bc3b1445a12c",
    "version": "1.0.0.0",
    "features": [
      {
        "id": "3be4d3fd-963b-4a1b-9607-cddb02c4cf16",
        "title": "Hello World Web part feature",
        "description": "A feature which activates the Client-Side WebPart named Hello World",
        "version": "1.0.0.0"
      },
      {
        "title": "Hello World Provisioning",
        "description": "Adds site columns, content types, lists for Hello World items.",
        "id": "f1c4625d-e32a-4960-8166-7610cdcb24d1",
        "version": "1.0.0.0",
        "assets": {
          "elementManifests": [
            "elements.xml"
          ]
          // ,
          // "elementFiles": [
          //   "schema.xml"
          // ]
        }
      }
    ]
  },
  "paths": {
    "zippedPackage": "solution/hello-world-webpart.sppkg"
  }
}
smithderekm picture smithderekm on 19 Dec 2017
👍1

Same problem as vickeybird here.
Webpart not showing up and after removal there where several files in the recyclebin, one of those is 0kB.
And that one can't be removed.

Edit:
/_api/web/GetClientSideWebParts doesn't show the desired webpart
appcatalog/Lists/ComponentManifests/AllItems.aspx shows the correct manifest

Denloof picture Denloof on 19 Dec 2017

Ok, after an update in sharepoint (??, recyclebin look/behaves differently) things seem to be working again.
Was now able to remove the item and reinstall, now webpart shows up.

Denloof picture Denloof on 20 Dec 2017

@smithderekm

I did exactly what you did but it's still not showing up :( This is my package-solution.json

{
  "solution": {
    "name": "our-applications-client-side-solution",
    "id": "c23661a1-50a2-4b69-b8f2-9b7a7a5db2b1",
    "version": "1.0.2.9",
    "features": [
      {
        "id": "3be4d3fd-963b-4a1b-9607-cddb02c4cf16",
        "title": "Our Applications Web part feature",
        "description": "A feature which activates the Client-Side WebPart named Our Applications",
        "version": "1.0.2.9"
      },
      {
      "title": "our-applications-client-side-solution",
      "description": "our-applications-client-side-solution",
      "id": "523fe887-ced5-4036-b564-8dad5c6c6e24",
      "version": "1.0.2.9",
      "assets": {
        "elementManifests": [
          "elements.xml"
        ],
        "elementFiles":[
          "schema.xml"
        ]
      }
    }]
  },
  "paths": {
    "zippedPackage": "solution/our-applications.sppkg"
  }
}
paigeflourin picture paigeflourin on 18 Jan 2018

I have the same problem again...
Update an existing webaprt (updated the version in package-solution.json)
Update sppkg file in appcatalog (overwrite), shows new version number.
Go to sitecolletion where the existing webapart was working, update to new version and nothing works...
The webaprt isn't showing up anymore.

/_api/web/GetClientSideWebParts doesn't show the desired webpart
appcatalog/Lists/ComponentManifests/AllItems.aspx shows the correct manifest

Removig reinstalling doesn't work, same result.

Am I missing something or is this just buggy?

Denloof picture Denloof on 25 Jan 2018
👍1

I also have this problem again now - but only on some sites. This seems to be really buggy and fragile.

Please advice!

Leif-Frederiksen picture Leif-Frederiksen on 26 Jan 2018

I am also experiencing this issue. Any update would be great. When I first created the solution, I was able to add the new webpart to a modern page. I made some changes, updated the package in the AppCatalog and tried adding to a new site I was working on and now it won't show up at all.

It does NOT appear when I go to "_api/web/GetClientSideWebParts" on the site I am working on.
It does appear when I go to "/Lists/ComponentManifests/Allitems.aspx".

smithbrianscott picture smithbrianscott on 29 Jan 2018

Did you approve / activate the updated package?

From: Brian Smith notifications@github.com
Sent: Monday, January 29, 2018 11:36:06 AM
To: SharePoint/sp-dev-docs
Cc: Pat Miller (SHAREPOINT); Mention
Subject: Re: [SharePoint/sp-dev-docs] SpFx Helloworld webpart does not show up under modern Page toolbox (#775)

I am also experiencing this issue. Any update would be great. When I first created the solution, I was able to add the new webpart to a modern page. I made some changes, updated the package in the AppCatalog and tried adding to a new site I was working on and now it won't show up at all.

It does NOT appear when I go to "_api/web/GetClientSideWebParts" on the site I am working on.
It does appear when I go to "/Lists/ComponentManifests/Allitems.aspx".

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHubhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FSharePoint%2Fsp-dev-docs%2Fissues%2F775%23issuecomment-361360663&data=02%7C01%7CPat.Miller%40microsoft.com%7C1c347abf444d44d3d67008d5674f8b1c%7Cee3303d7fb734b0c8589bcd847f1c277%7C1%7C0%7C636528513684536533&sdata=FYYZHkNmdqSS3BW4rReHcJL6UmNKzIkv%2FEPDCxbKmsA%3D&reserved=0, or mute the threadhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FADl-SYKi_JvSD2JdGgQ0xWooGHjdJLnuks5tPh2mgaJpZM4OyQo6&data=02%7C01%7CPat.Miller%40microsoft.com%7C1c347abf444d44d3d67008d5674f8b1c%7Cee3303d7fb734b0c8589bcd847f1c277%7C1%7C0%7C636528513684536533&sdata=agP%2F0LU2UIXx%2Bwls4VQc6qBFZYYBGjE07MaXQXxUFZI%3D&reserved=0.

patmill picture patmill on 29 Jan 2018

@patmill To be honest, I am not sure what you mean by approve / activate. When I drag and drop the solution into the app catalog. I am given a prompt to deploy the solution. Which may be what you are meaning by approve, right? Any site I go to, when I click on add an app, my web parts appear and I can add them. I just don't see them in the web part section when editing a page. I do see the web part app in site contents.

smithbrianscott picture smithbrianscott on 29 Jan 2018

Sorry – yes, “Deploy”. Do you happen to know what your preconfigured entries section looks like in your manifest?

There have been some updates to the toolbox that are rolling out. I’ll follow up with that team as well.

Thanks.

From: Brian Smith [mailto:[email protected]]
Sent: Monday, January 29, 2018 11:54 AM
To: SharePoint/sp-dev-docs sp-dev-docs@noreply.github.com
Cc: Pat Miller (SHAREPOINT) Pat.Miller@microsoft.com; Mention mention@noreply.github.com
Subject: Re: [SharePoint/sp-dev-docs] SpFx Helloworld webpart does not show up under modern Page toolbox (#775)

@patmillhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fpatmill&data=02%7C01%7CPat.Miller%40microsoft.com%7Cb74f454780414e79bcf508d5675216b4%7Cee3303d7fb734b0c8589bcd847f1c277%7C1%7C0%7C636528524696864754&sdata=QJ4F2fc3RMqVoUgvC86606XFbNUemgkWn1Rg8EXzPDc%3D&reserved=0 To be honest, I am not sure what you mean by approve / activate. When I drag and drop the solution into the app catalog. I am given a prompt to deploy the solution. Which may be what you are meaning by approve, right? Any site I go to, when I click on add an app, my web parts appear and I can add them. I just don't see them in the web part section when editing a page. I do see the web part app in site contents.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHubhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FSharePoint%2Fsp-dev-docs%2Fissues%2F775%23issuecomment-361366075&data=02%7C01%7CPat.Miller%40microsoft.com%7Cb74f454780414e79bcf508d5675216b4%7Cee3303d7fb734b0c8589bcd847f1c277%7C1%7C0%7C636528524696864754&sdata=h1jqLoJbm4rCV9ck89AgUTMcFMilWA0FSNeMlFAGpQM%3D&reserved=0, or mute the threadhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FADl-SZyTMxZGv4W1i6tOFxP5UzkW6sWlks5tPiHrgaJpZM4OyQo6&data=02%7C01%7CPat.Miller%40microsoft.com%7Cb74f454780414e79bcf508d5675216b4%7Cee3303d7fb734b0c8589bcd847f1c277%7C1%7C0%7C636528524696864754&sdata=9OLcQTmHb75cDf0PsPDqzdujS6mT4xFbTtu7NX2UVZw%3D&reserved=0.

patmill picture patmill on 29 Jan 2018

@patmill Here is my preconfiguredEntries. The change I made are

  • added a few properties for defaults
  • removed officeFabricFontIconName and added iconImageUrl

image

smithbrianscott picture smithbrianscott on 29 Jan 2018

My observation of the problem is that the webpart shows up on some sites and on other sites it does not. Sites within the same tenant!
Really strange and something I need to get sorted out real soon.
Can we get some insight into what the REST call that shows the available webparts actually do?

Regards
Leif

Leif-Frederiksen picture Leif-Frederiksen on 29 Jan 2018

Reopening for ensuring that would not get hidden as closed issue.

VesaJuvonen picture VesaJuvonen on 30 Jan 2018

I'll just post my WebPart manifest file here, if it's any help in debugging this issue:

{
  "$schema": "../../../node_modules/@microsoft/sp-module-interfaces/lib/manifestSchemas/jsonSchemas/client-side-component-manifest.schema.json",

  "id": "2fd7e645-afd2-44f9-b243-87d461e2cbd1",
  "alias": "LedelsessystemWebPart",
  "componentType": "WebPart",

  // The "*" signifies that the version should be taken from the package.json
  "version": "*",
  "manifestVersion": 2,

  // If true, the component can only be installed on sites where Custom Script is allowed.
  // Components that allow authors to embed arbitrary script code should set this to true.
  // https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f
  "requiresCustomScript": false,

  "preconfiguredEntries": [
    {
      "groupId": "6737645a-4443-4210-a70e-e5e2a219133a",
      "group": { "default": "MTH" },
      "title": { "default": "MT Højgaard: Ledelsessystem" },
      "description": { "default": "Navigation til Ledelsessystemet." },
      "iconImageUrl": "https://sometenant.sharepoint.com/sites/SPFx/Bundles/SPFxMTHicon.png",
      "properties": {
        "description": "Ledelsessystem",
        "processLibraryName": "Pages",
        "toolsLibraryName": "Documents",
        "termSetName": "QMS Navigation",
        "resultSource": "578b90fb-655b-4b93-897c-f67a00c3029b"
      }
    },
    {
      "groupId": "6737645a-4443-4210-a70e-e5e2a219133a",
      "group": { "default": "MTH" },
      "title": { "default": "Ajos: Ledelsessystem" },
      "description": { "default": "Navigation til Ledelsessystemet." },
      "iconImageUrl": "https://sometenant.sharepoint.com/sites/SPFx/Bundles/SPFxMTHicon.png",
      "properties": {
        "description": "Ledelsessystem",
        "processLibraryName": "Sider",
        "toolsLibraryName": "Dokumenter",
        "termSetName": "QMS Navigation Ajos",
        "resultSource": "8eeb918e-c59d-4209-b7ed-e055a2821e38",
        "groupProcessLibraryName": "Pages",
        "groupToolsLibraryName": "Documents"
      }
    }
  ]
}
Leif-Frederiksen picture Leif-Frederiksen on 30 Jan 2018

I was able to get it working again. But as @Leif-Frederiksen mentioned earlier, its fragile and buggy.. Steps I took to get it to work again without making any changes to the actual webpart.

  1. Delete app from app catalog.
  2. Go to recycle bin and delete the app package again there.
  3. Go to second stage recycle bin and delete the app package again there.
  4. Upload the solution package to the app catalog.
  5. Go to the site and FULLY delete the app if it is still there. (First Stage and Second Stage).
  6. Install app again.

This got it working for me. But I would hate to have to follow that process every time for each update as I have to fix the webpart on all sites/pages that it is being used...

smithbrianscott picture smithbrianscott on 30 Jan 2018
👍2

Thanks Brian. We will continue to look into what's going on here.

Get Outlook for iOShttps://aka.ms/o0ukef

From: Brian Smith notifications@github.com
Sent: Tuesday, January 30, 2018 12:30:29 PM
To: SharePoint/sp-dev-docs
Cc: Pat Miller (SHAREPOINT); Mention
Subject: Re: [SharePoint/sp-dev-docs] SpFx Helloworld webpart does not show up under modern Page toolbox (#775)

I was able to get it working again. But as @Leif-Frederiksenhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fleif-frederiksen&data=02%7C01%7CPat.Miller%40microsoft.com%7Cf294e00cf86a4cf4c82a08d568204dd8%7Cee3303d7fb734b0c8589bcd847f1c277%7C1%7C0%7C636529410406628263&sdata=z1cKSuhaFUw8bKpRCvBIOge%2FzPLMiURkNv2b1UB074I%3D&reserved=0 mentioned earlier, its fragile and buggy.. Steps I took to get it to work again without making any changes to the actual webpart.

  1. Delete app from app catalog.
  2. Go to recycle bin and delete the app package again there.
  3. Go to second stage recycle bin and delete the app package again there.
  4. Upload the solution package to the app catalog.
  5. Go to the site and FULLY delete the app if it is still there. (First Stage and Second Stage).
  6. Install app again.

This got it working for me. But I would hate to have to follow that process every time for each update as I have to fix the webpart on all sites/pages that it is being used...

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHubhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FSharePoint%2Fsp-dev-docs%2Fissues%2F775%23issuecomment-361724436&data=02%7C01%7CPat.Miller%40microsoft.com%7Cf294e00cf86a4cf4c82a08d568204dd8%7Cee3303d7fb734b0c8589bcd847f1c277%7C1%7C0%7C636529410406628263&sdata=u75mWigabPZaXBKQkpSdjTEGrU4tpbQJM%2FyYpVlNmXw%3D&reserved=0, or mute the threadhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FADl-Salt8qmoqLuMHbC8cZXSVBTuvOieks5tP3vlgaJpZM4OyQo6&data=02%7C01%7CPat.Miller%40microsoft.com%7Cf294e00cf86a4cf4c82a08d568204dd8%7Cee3303d7fb734b0c8589bcd847f1c277%7C1%7C0%7C636529410406628263&sdata=6NVaeUeROpuACZqvFI9QJ9iz5GX41%2FvljoppDP55KJc%3D&reserved=0.

patmill picture patmill on 30 Jan 2018

Mine also worked when i fully removed the package from the appcatalog and redeployed it again.

paigeflourin picture paigeflourin on 31 Jan 2018

If it happens again, and you know how to get the information, could you find the correlation ID for the network request that populates the toolbox? We can pull logs and see if anything shows up (or at least add additional logging to help track it down).

From: Page Flourin Tangalin notifications@github.com
Sent: Tuesday, January 30, 2018 4:05:54 PM
To: SharePoint/sp-dev-docs
Cc: Pat Miller (SHAREPOINT); Mention
Subject: Re: [SharePoint/sp-dev-docs] SpFx Helloworld webpart does not show up under modern Page toolbox (#775)

Mine also worked when i fully removed the package from the appcatalog and redeployed it again.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHubhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FSharePoint%2Fsp-dev-docs%2Fissues%2F775%23issuecomment-361777748&data=02%7C01%7CPat.Miller%40microsoft.com%7Cb8ebdb175ef44e44166b08d5683e6675%7Cee3303d7fb734b0c8589bcd847f1c277%7C1%7C0%7C636529539575394547&sdata=zM3fu9hdXQqki7vpWbsXMXPkS%2BPNFXbasUsaabANWI8%3D&reserved=0, or mute the threadhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FADl-SfEySMRdAt4ZS7joYsDO1JhSW5f6ks5tP65igaJpZM4OyQo6&data=02%7C01%7CPat.Miller%40microsoft.com%7Cb8ebdb175ef44e44166b08d5683e6675%7Cee3303d7fb734b0c8589bcd847f1c277%7C1%7C0%7C636529539575404556&sdata=QDbIwMpI36RYD4BaH567IvdRrL4sTfItEl2A19nMQS0%3D&reserved=0.

patmill picture patmill on 31 Jan 2018

I have a pretty consistent scenario where the webpart appears in the toolbox on one site, but is missing on other sites in the same tenant.

Can we use this to gather something for debugging this issue? Please instruct on how I can deliver something useful.

NB: The site where it is actually working is a production site, so I'm not really up for the "remove from app catalog and add again" approach, since I will lose the config of the webpart on all pages where it is used.

Regards
Leif

Leif-Frederiksen picture Leif-Frederiksen on 31 Jan 2018

Same issue here as Leif, the remove/re-deploy worked for some but not others, these subsites are all under the same collection.

Also am unable to delete the app from recycle bin of a site, I get the error message:
Correlation ID: 2809469e-a0ad-5000-1cdd-8f9373bdf938
image

For the sites that worked, it worked after I repackaged the web part and updated the version number. I'm not certain the version number is what made a difference.

Also thought the "Site Features" might be an indicator, then that isn't true when a site with the app as "Active" in Site Feature still can't see the app in web parts gallery.
image

If there's anything else I can try, please do share, thanks in advance!

bubbleswap picture bubbleswap on 31 Jan 2018

@bubbleswap - for the error of not being able to delete from the recycle bin please open a new issue
@Leif-Frederiksen - please see below, for instructions on gathering a correlation ID.

Thanks for all the feedback. It actually looks like there are 2 classes of issues here:

  1. The webpart never shows up being available anywhere.
  2. The webpart is available on some sites but not others.

For case 1, the problem has a temporary fix. Basically anytime an exception was thrown during deployment we would mark the package as deployed and eat the exception. This is obviously bad and has been fixed by no longer eating the exception and marking the package as not deployed. Also, we update error field to include the correlation ID of the deployment. Our logging will help us determine what the root cause is, and we should be able to create a fix once we see this happen again (it has only rolled out to 75% of production, and just started on Sunday, but I don't see any instances of this yet).

For case 2, I am more interested as this is a new problem I have not seen before and am unsure of what is wrong. We would like more information on this in order to help us diagnose what the issue is. @Leif-Frederiksen - please follow these steps to capture a correlation ID:

  1. Load developer tools and start a network trace (F12)
  2. Load a modern page
  3. Put it in edit mode.
  4. Click the "+" to add a webpart
  5. View your network trace in the developer tools, you will see a request to GetClientSideWebParts
  6. Look at the response header sprequestguid and respond here with that, as well as your tenant domain
  7. If you know what webpart is missing, please include the details of it such as name/component id.

Thank you for helping us track down this issue,
Graham

GrahamMcMynn picture GrahamMcMynn on 1 Feb 2018

Hi Graham,

Here is the info:

sprequestguid: b426469e-5065-5000-a684-b9581c831c38
Tenant domain: mthportal.sharepoint.com

I am uncertain about the component id. I have the following Id's
Solution: 7858eb79-bf7e-4481-8b3c-ceb6ad854d82
Webpart: 2fd7e645-afd2-44f9-b243-87d461e2cbd1
Group id of preconfigured entries: 6737645a-4443-4210-a70e-e5e2a219133a

To give you the full picture I post the content of the configuration files below - please let me know if I can provide more info.

package-solution.json:

{
    "solution": {
        "name": "MTH Ledelsessystem",
        "id": "7858eb79-bf7e-4481-8b3c-ceb6ad854d82",
        "version": "1.16.21.0",
        "iconPath": "Images/AppMTHicon.png",
        "skipFeatureDeployment": false
    },
    "paths": {
        "zippedPackage": "solution/MTH.Ledelsessystem.sppkg"
    }
}

webpartmanifest.json:

{
  "$schema": "../../../node_modules/@microsoft/sp-module-interfaces/lib/manifestSchemas/jsonSchemas/client-side-component-manifest.schema.json",

  "id": "2fd7e645-afd2-44f9-b243-87d461e2cbd1",
  "alias": "LedelsessystemWebPart",
  "componentType": "WebPart",

  // The "*" signifies that the version should be taken from the package.json
  "version": "*",
  "manifestVersion": 2,

  // If true, the component can only be installed on sites where Custom Script is allowed.
  // Components that allow authors to embed arbitrary script code should set this to true.
  // https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f
  "requiresCustomScript": false,

  "preconfiguredEntries": [
    {
      "groupId": "6737645a-4443-4210-a70e-e5e2a219133a",
      "group": { "default": "MTH" },
      "title": { "default": "MT Højgaard: Ledelsessystem" },
      "description": { "default": "Navigation til Ledelsessystemet." },
      "iconImageUrl": "https://mthportal.sharepoint.com/sites/SPFx/Bundles/SPFxMTHicon.png",
      "properties": {
        "description": "Ledelsessystem",
        "processLibraryName": "Pages",
        "toolsLibraryName": "Documents",
        "termSetName": "QMS Navigation",
        "resultSource": "578b90fb-655b-4b93-897c-f67a00c3029b"
      }
    },
    {
      "groupId": "6737645a-4443-4210-a70e-e5e2a219133a",
      "group": { "default": "MTH" },
      "title": { "default": "Ajos: Ledelsessystem" },
      "description": { "default": "Navigation til Ledelsessystemet." },
      "iconImageUrl": "https://mthportal.sharepoint.com/sites/SPFx/Bundles/SPFxMTHicon.png",
      "properties": {
        "description": "Ledelsessystem",
        "processLibraryName": "Sider",
        "toolsLibraryName": "Dokumenter",
        "termSetName": "QMS Navigation Ajos",
        "resultSource": "8eeb918e-c59d-4209-b7ed-e055a2821e38",
        "groupProcessLibraryName": "Pages",
        "groupToolsLibraryName": "Documents"
      }
    }
  ]
}
Leif-Frederiksen picture Leif-Frederiksen on 1 Feb 2018

Also having this issue alot: @smithbrianscott 's suggestions worked though!

will101 picture will101 on 1 Feb 2018

@Leif-Frederiksen - thank you for sending that, I can't fetch the logs until Monday, but I will take a look then.

GrahamMcMynn picture GrahamMcMynn on 1 Feb 2018

That sounds good @mcmynn83. I'm curious as to what you can see from the logs on Monday. Have a nice weekend until then :-)

Regards
Leif

Leif-Frederiksen picture Leif-Frederiksen on 2 Feb 2018

Same problem. I try sample "react-script-editor" on site with specific site collection app catalog.
NO show on modern page (also already remove all and reinstall but nothing happen).
It's show in "features" list and also in "/Lists/ComponentManifests/AllItems.aspx" .
If try in workbench it's works all fine.

paololec picture paololec on 2 Feb 2018

There is an advisory SP128660 in Office Admin Center, which titled "Can't install or activate add-ins or modern SharePoint packages". Is this issue related to that advisory??

tsekityam picture tsekityam on 5 Feb 2018

Hmmm I think I met this issue last week when the webpart show up on first time deployment but after that every app upgrading will cause it to disappear from the Web Parts toolbox.
Later then I found out that there is an issue with the "includeClientSideAssets" in the package-solution.json

I CREATED ANOTHER PROJECT with that "includeClientSideAssets" set to false and using the CDN URL instead and things are working now even after upgrading the app.

But I do recall that once it has disappeared then even set the "includeClientSideAssets" to false and re-deploy won't make it show up again.

Now I'm facing the issue with the app keep saying " The App is installing..." and just hang there forever without any errors.

OverkillTV picture OverkillTV on 5 Feb 2018

I was also facing this issue , the only workaround i found was to delete the app packages from the site collections and from the app catalog and then redeploy everything. Is is working now as expected in all sites except one

telmocruz picture telmocruz on 5 Feb 2018
👍1

Hi @mcmynn83 - did you get a look at the logs?

Leif-Frederiksen picture Leif-Frederiksen on 6 Feb 2018

I had the same issue. Increasing the version number in package-solution.json and deploying again to the app catalog then upgrading and/or re-installing multiple times would never work. Removing from the app catalog and recycle bin 2nd stage did the trick.

I did notice something else, if I added another web part using the yeoman generator, only the new web part would show up if I upgraded the solution without removing from the app catalog. However, as soon as I increased the version number and upgraded again, my recently added web part would also disappear.

Hope this helps.

pedro-pedrosa picture pedro-pedrosa on 8 Feb 2018

I noticed on my tenant that */CLIENTSIDEASSETS was not added to to public CDN origins event thou CDN was enabled. Added that manually, removed app from AppCatalog and from sites and the webpart showed up. (this happened on Classic SP)

poikjo picture poikjo on 8 Feb 2018

Hi @mcmynn83 - any success with looking into the logs?

Regards
Leif

Leif-Frederiksen picture Leif-Frederiksen on 12 Feb 2018

I logged this case as a Severity B premier support ticket. MS CS team told me that their engineer will contact me tomorrow at 9am (HKT)

BTW, I am using Azure CDN, but I still experience the issue. I don't think that it is a SharePoint CDN config issue.

tsekityam picture tsekityam on 12 Feb 2018

That sounds great @tsekityam - looking forward to hearing what they find :-)

Leif-Frederiksen picture Leif-Frederiksen on 12 Feb 2018

I am experiencing this today on multiple tenants. Thanks for the research on this all. I will try the suggested workaround of completely reinstalling from app catalog.

edit: reinstalling app package to tenant and then reinstalling to site collections resolved the issue.

pdemro picture pdemro on 12 Feb 2018

@telmocruz the same is with me now, the deletion from second recycle bin 'fixed' it for site collections created directly from SP Admin. But the recycling bin trick is not working for a site collection generated by O365 group. Was the one that didn't work for you also a site from O365 group?

bubbleswap picture bubbleswap on 13 Feb 2018

Sorry about going silent here. @Leif-Frederiksen - I looked at your logs and it looks like there is an issue. Still investigating a fix. Will keep the thread updated.

GrahamMcMynn picture GrahamMcMynn on 13 Feb 2018

Just to update the thread and give a little more context... I can't tell you why everybodies is failing, or if it is the same reason. However, the reason @Leif-Frederiksen is not seeing the webparts is that when he installed the app package the feature did not end up activated. I'm currently trying to determine why that happened. If anybody else is seeing this problem if you could send me correlation ids both for your call to add an app (when you install the spfx feature on the site), as well as the correlation ID for a call to getting webparts which doesn't show your webparts that would be super helpful. Lastly, I would also need the URL of the site collection. Thanks!

GrahamMcMynn picture GrahamMcMynn on 13 Feb 2018

The cause of the problem has been identified and we will be rolling out a fix for it shortly. Unfortunately the problem is in the generator which means packages have been created that cause this problem and will continue to cause problems. In order to fix the problem after the fix is applied you will have to do the following:

  1. Uninstall the app from a site collection
  2. The app will have to be deleted from the app catalog
  3. The new version of the app (built with the new generator) will have to be uploaded to the app catalog
  4. Then the app will have to be added back to the site collection.

This process will work on todays solutions as well, however, it will have to be re-done after the fix is rolled out.

Sorry for the trouble has caused and thank you for helping us diagnose the issue.

GrahamMcMynn picture GrahamMcMynn on 14 Feb 2018
👍6

I had an issue where the manifest in /Lists/ComponentManifests/AllItems.aspx was stuck at v.0.0.1 while my latest wp was 1.4.0. Seems uploading a new version does not always overwrite the component manifest list. Deleting the manifest entry, editing the props of the app made it all work again.

cc @patmill

wobba picture wobba on 14 Feb 2018

@wobba - Could you open a new thread for that issue? Also, if possible could you send the SPRequestGuid (from the response headers) for when you upload your new solution that doesn't actually trigger an update to your component manifests?

GrahamMcMynn picture GrahamMcMynn on 14 Feb 2018

Hi,
I'll try to reproduce it later and log an issue if I'm able to. This was a
customers tenant so I had to make it work pretty quickly.

-mikaek

ons. 14. feb. 2018 kl. 19:09 skrev GrahaMc notifications@github.com:

@wobba https://github.com/wobba - Could you open a new thread for that
issue? Also, if possible could you send the SPRequestGuid (from the
response headers) for when you upload your new solution that doesn't
actually trigger an update to your component manifests?

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/SharePoint/sp-dev-docs/issues/775#issuecomment-365694794,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AADHoLVBHWeMAeHncNI_JE4LDqcF5Fm4ks5tUyFHgaJpZM4OyQo6
.

wobba picture wobba on 14 Feb 2018

Excellent thanks, and sorry that it's causing you problems.

GrahamMcMynn picture GrahamMcMynn on 14 Feb 2018

Just quick update. We are looking to get the fix out as part of the upcoming SPFx Yeoman package v1.4.1 release. ETA for this release is hours / days... so coming soon. Will close the issue, when fix is out.

VesaJuvonen picture VesaJuvonen on 15 Feb 2018
👍4

@VesaJuvonen so this means you have been able to repro the issue and figured out the problem? Could you elaborate on the actual issue causing this?

wobba picture wobba on 15 Feb 2018

This is now fixed. We have a solid repro and have fixed the underlying issue as part of the v1.4.1 release. This was related to false behavior in Yeoman template solution packaging, which caused feature ID to get updated on a newer version of the package. ´

Unfortunately fixing this from existing environments will require some extra work and you should be upgrading to v1.4.1 as soon as possible. Here's a direct quote from the 1.4.1 release notes.

Fixed issue in the generator that prevented activation of new versions of SPFx packages.

Symptoms - You deploy a new version of SharePoint Framework packages and you no longer see your web parts in web part picker.

Issue reported here: https://github.com/SharePoint/sp-dev-docs/issues/775

Fix - To be able to fully successfully fix this issue, you will need to perform following steps in your SharePoint Online tenants.

  1. Remove all instances of existing SharePoint Framework solutions from site level
  2. Remove SharePoint Framework solution from app catalog
  3. Upload new SharePoint Framework solution built with 1.4.1 version to your app catalog
  4. Install SharePoint Framework solutions back to sites.

Notice that this issue is not happening for tenant-scoped SharePoint Framework solutions and it's not happening for SharePoint add-ins.

You might potentially take advantage of the SharePoint ALM APIs or SharePoint PnP PowerShell cmdlets for add-ins to automate this needed process.

VesaJuvonen picture VesaJuvonen on 15 Feb 2018
🎉2 👍1

Thank you. My issue was different then as I'm using tenant scoped parts. I
will update to 1.4.1 for my two parts, bump their version number in
package.json and manifest, rebuild and update the part on sites they are
used to verify if the show up or not.

-Mikael

tor. 15. feb. 2018 kl. 21:09 skrev Vesa Juvonen notifications@github.com:

This is now fixed. We have a solid repro and have fixed the underlying
issue as part of the v1.4.1 release. This was related to false behavior in
Yeoman template solution packaging, which caused feature ID to get updated
on a newer version of the package. ´

Unfortunately fixing this from existing environments will require some
extra work and you should be upgrading to v1.4.1 as soon as possible.
Here's a direct quote from the 1.4.1 release notes
https://github.com/SharePoint/sp-dev-docs/wiki/Release-Notes-for-SPFx-Package-Version-1.4.1
.

Fixed issue in the generator that prevented activation of new versions of
SPFx packages.

Symptoms - You deploy a new version of SharePoint Framework packages
and you no longer see your web parts in web part picker.

Issue reported here: #775
https://github.com/SharePoint/sp-dev-docs/issues/775

Fix - To be able to fully successfully fix this issue, you will need to
perform following steps in your SharePoint Online tenants.

  1. Remove all instances of existing SharePoint Framework solutions
    from site level
  2. Remove SharePoint Framework solution from app catalog
  3. Upload new SharePoint Framework solution built with 1.4.1 version
    to your app catalog
  4. Install SharePoint Framework solutions back to sites.

Notice that this issue is not happening for tenant-scoped SharePoint
Framework solutions and it's not happening for SharePoint add-ins.

You might potentially take advantage of the SharePoint ALM APIs
https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins
or SharePoint PnP PowerShell cmdlets for add-ins
https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins#sharepoint-pnp-powershell-cmdlets-to-programmatically-add-and-deploy-sharepoint-apps
to automate this needed process.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/SharePoint/sp-dev-docs/issues/775#issuecomment-366046517,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AADHoKDyx0pfIQcl1E7meTNY5qWfLLaiks5tVI7qgaJpZM4OyQo6
.

wobba picture wobba on 15 Feb 2018

@wobba - Please submit a new issue if needed, so that we can track that with repro steps and web part configuration setup. Thx. Otherwise, it's impossible for us to track the tasks in VSO - as all of these issues are automatically synced for internal processing for our team.

VesaJuvonen picture VesaJuvonen on 16 Feb 2018

I'm still having issues although I ran these steps:

To be able to fully successfully fix this issue, you will need to perform following steps in your SharePoint Online tenants.

Remove all instances of existing SharePoint Framework solutions from site level
Remove SharePoint Framework solution from app catalog
Upload new SharePoint Framework solution built with 1.4.1 version to your app catalog
Install SharePoint Framework solutions back to sites.

The webpart still isn't selectable in the toolbox...

EDIT: Nevermind. It looks like an administrator disabled the O365 CDN... and that results in the same issue. Either way, a transition to the Azure CDN seemed the solution for me.

Laskewitz picture Laskewitz on 21 Feb 2018

This one got me now as well. My SPFx 1.4.1 tenant scoped webpart had includeClientSideAssets set to true and same as @poikjo, I had the Office 365 CDN enabled on the tenant but did not have the */CLIENTSIDEASSETS origin added.

So the solution was to add the origin and the webpart started to appear in the "add new webpart" dialog.

(You can also turn off the Office 365 CDN in which case the web part should appear as well. The JS files will then be served from the app catalog)

vman picture vman on 3 Mar 2018

Yep - few things to notice here.

  • @Laskewitz - If you are using the standard URL in the write-manifests.json as "cdnBasePath": "<!-- PATH TO CDN -->"- and you use asset packaging - then it does not matter if the CDN is enabled or not... If CDN is enabled, we'll load the web part from CDN, if not, we load it directly from app catalog... without any changes needed by the developers.
  • @vman - This is indeed something to notice. If you used CDN before CLIENTASSETS origin being there, you'll need to add that origin there manually or reactivate CDN

Not seeing any actual new issues here, so not reopening... if there are similar issues, please do open a new issue with sufficient details.

VesaJuvonen picture VesaJuvonen on 4 Mar 2018

Hi,

I'm experiencing similar issue here.
I have a site collection with about 20-25 subsites.
I've installed the app at site collection catalog.
I'm using the 1.4.1 version.
For most of the subsites the webparts are available, but for some of them I can't see them.
Same app & same site collection.

Any idea or suggestion?
Thanks!

agamadrid picture agamadrid on 22 Mar 2018

I can confirm this issue is still lingering. To resolve the issue prior, I updated my solution to use 1.4.1. Then upon deployment seemed to be fine. Now performing some changes and redeployed the web part is no longer visible to add to the page onto the page.

EDIT I can confirm that the old version of the app was still installed in the app catalog. My newest 1.4.1 solution was installed over top of it (different tenant). Completely removing the app from the catalog and the site collections and installing again made it visible again.

Cyan005 picture Cyan005 on 28 Mar 2018

@Cyan005 Check my post http://www.techmikael.com/2018/02/alternative-way-to-solve-issue-where.html or the release notes at https://github.com/SharePoint/sp-dev-docs/wiki/Release-Notes-for-SPFx-Package-Version-1.4.1#other-relevant-fixes on how to resolve this.

wobba picture wobba on 28 Mar 2018

I have been struggling with this issue where deploying the react-script-editor (https://github.com/SharePoint/sp-dev-fx-webparts/tree/master/samples/react-script-editor) and it is not showing in the toolbox of Site Pages in modern team site and communication site. I cloned the repo 2 weeks ago which means I have the newest 1.4.1 spfx as I see it referenced in package.json.

I followed the many suggestions in this thread I can say I removed from Site Collection and Tenant App Catalog countless times and redeployed manually and via PnP Powershell.

I have tested even across 2 different tenants which are more cleaner than my primary dev tenant.

My general approach is
1) Create private CDN such as \sites\CDN\siteassets\ and PnP PowerShell to set the CDN origin
2) Deploy to tenant App Catalog. SkipFeatureDeployment is TRUE so that it is deployed to all sites
3) Go to either a modern team site, communication site, or classic site to attempt to find and add the Modern Script Editor web part.
4) Issue: I only can see this web part in toolbox for 3-5 classic sites among 3 different tenants.
I am able to to see add/publish 1 other SPFX sample web parts from this repo.

I am particularly interested in using the react-script-editor webpart. And I only changed the cdnbasePath and skipfeaturedeployment settings in the .json. No other code changes. gulp --ship and gulp package-solution -ship

Appreciate any advice.

RoyKimYYZ picture RoyKimYYZ on 15 Apr 2018

I believe the modern script editor web part is configured to require a site to have noscript disabled (the add/customize page permission is allowed) for security reasons. By default, self-service sites (sites that are created outside of tenant admin) do not allow this.

Get Outlook for iOShttps://aka.ms/o0ukef

From: Roy Kim (MVP) notifications@github.com
Sent: Saturday, April 14, 2018 6:12:20 PM
To: SharePoint/sp-dev-docs
Cc: Pat Miller (SHAREPOINT); Mention
Subject: Re: [SharePoint/sp-dev-docs] SpFx Helloworld webpart does not show up under modern Page toolbox (#775)

I have been struggling with this issue where deploying the react-script-editor (https://github.com/SharePoint/sp-dev-fx-webparts/tree/master/samples/react-script-editor) and it is not showing in the toolbox of Site Pages in modern team site and communication site. I cloned the repo 2 weeks ago which means I have the newest 1.4.1 spfx as I see it referenced in package.json.

I followed the many suggestions in this thread I can say I removed from Site Collection and Tenant App Catalog countless times and redeployed manually and via PnP Powershell.

I have tested even across 2 different tenants which are more cleaner than my primary dev tenant.

My general approach is

  1. Create private CDN such as \sites\CDN\siteassets\ and PnP PowerShell to set the CDN origin
  2. Deploy to tenant App Catalog. SkipFeatureDeployment is TRUE so that it is deployed to all sites
  3. Go to either a modern team site, communication site, or classic site to attempt to find and add the Modern Script Editor web part.
  4. Issue: I only can see this web part in toolbox for 3-5 classic sites among 3 different tenants.
    I am able to to see add/publish 1 other SPFX sample web parts from this repo.

I am particularly interested in using the react-script-editor webpart. And I only changed the cdnbasePath and skipfeaturedeployment settings in the .json. No other code changes. gulp --ship and gulp package-solution -ship

Appreciate any advice.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHubhttps://github.com/SharePoint/sp-dev-docs/issues/775#issuecomment-381372718, or mute the threadhttps://github.com/notifications/unsubscribe-auth/ADl-SXoDk30ioxGmQ5SN_WBku1J0sUb4ks5top50gaJpZM4OyQo6.

patmill picture patmill on 15 Apr 2018

Thanks @patmill . I just used some powershell to disable powershell. Thought it be something simple that I missed. Much appreciated for the guidance!!

RoyKimYYZ picture RoyKimYYZ on 15 Apr 2018

@RoyKimYYZ as @patmill said, default settings are to require a script enabled site. At the bottom of https://github.com/SharePoint/sp-dev-fx-webparts/tree/master/samples/react-script-editor the readme has notes how to deploy to noscript sites or tenant wide.

wobba picture wobba on 15 Apr 2018

@wobba Thanks for pointing that out. I guess I didn't read it more carefully and should have played around the requiresCustomScript setting. By this web part "not being allowed", I just thought it would error out in App Catalog or when Adding App to the site. Nevertheless, I'm still learning the nitty gritty details of the multi-step process of install,deploy,activate multiplied by various config setting options. Appreciate your hard work and guidance!

RoyKimYYZ picture RoyKimYYZ on 15 Apr 2018
👍1

Anybody having issues emptying the recycle bin to remove the app do this:
After removing the app in the classic mode (which is the only mode you can remove an app in), change back to modern mode (there should be a link below the side navigation) and open the recycle bin in the modern mode. this mode allows to delete the package from the recycle bin.

frevds picture frevds on 17 Apr 2018
👍1

In my case, I found that when I added my own feature definition in the package-solutions file for provisioning, it was essentially overwriting the feature for the web part. The tooling generates the feature behind the scenes but never reveals it (annoying!) so my hand-entered feature caused the conflict.

The fix was to ensure that the package-solution file has 2 features with different IDs - one for the web part, and one for the provisioning. Once I did that, then the installation of the app put everything in the right place and the web part re-appeared in the gallery to place on a page.

Here's a sample package-solution.json to illustrate. You'll need to generate new guids for your solution/features.

{
  "$schema": "https://dev.office.com/json-schemas/spfx-build/package-solution.schema.json",
  "solution": {
    "name": "Hello World",
    "id": "300ecbc4-f139-459e-bb2d-bc3b1445a12c",
    "version": "1.0.0.0",
    "features": [
      {
        "id": "3be4d3fd-963b-4a1b-9607-cddb02c4cf16",
        "title": "Hello World Web part feature",
        "description": "A feature which activates the Client-Side WebPart named Hello World",
        "version": "1.0.0.0"
      },
      {
        "title": "Hello World Provisioning",
        "description": "Adds site columns, content types, lists for Hello World items.",
        "id": "f1c4625d-e32a-4960-8166-7610cdcb24d1",
        "version": "1.0.0.0",
        "assets": {
          "elementManifests": [
            "elements.xml"
          ]
          // ,
          // "elementFiles": [
          //   "schema.xml"
          // ]
        }
      }
    ]
  },
  "paths": {
    "zippedPackage": "solution/hello-world-webpart.sppkg"
  }
}

Thanks! This works for me. One thing to be noticed is that the id of web part feature must be the same as the id used in your XXXXWebPart.manifest.json

TylerLu picture TylerLu on 25 Jan 2019

in my case, I have several webparts in the same project (e.g. 4 webparts in total):

  • In the workbench, all webparts are displayed properly in the toolbox to be added into the page.
  • In the modern page, only the first 2 created webparts are displayed in the toolbox, and the latest 2 webparts were NOT displayed in the toolbox.

Troubleshooting: I ensured that Description and Short Description have values in the App Properties, but the latest 2 webparts were not found anywhere (also checked in https://yourtenant.sharepoint.com/sites/yoursite/_api/web/GetClientSideWebParts and https://yourtenant.sharepoint.com/sites/yourappcatalog/Lists/ComponentManifests/AllItems.aspx )

Solution:
I need to delete the app in the Site Contents and re-added the app back. My highlight is that we have a retention policy enabled in the tenant, and we must change the version of the app at Visual Studio Code (config\package-solution.json) so that we can re-add the same app (with a newer version) back to the Site Contents of the site.

anthonynhn picture anthonynhn on 3 May 2019

I've also encountered this problem + found a solution that worked for me:

I am also experiencing this issue. Any update would be great. When I first created the solution, I was able to add the new webpart to a modern page. I made some changes, updated the package in the AppCatalog and tried adding to a new site I was working on and now it won't show up at all.

It does NOT appear when I go to "_api/web/GetClientSideWebParts" on the site I am working on.
It does appear when I go to "/Lists/ComponentManifests/Allitems.aspx".

My solution (for an SPFx solution NOT deployed to the entire tenant in one go):
Step 1: (preferrably) remove the apps on the site collections where you installed them. Do it like this: from site contents, remove. As a site collection admin (or global admin), go to the recycle bin. There is an error indeed when attempting to remove it there. However, change the url: _layouts/15/RecycleBin.aspx to _layouts/15/AdminRecycleBin.aspx. There, remove the app. Also, go to the second stage recycle bin (_layouts/15/AdminRecycleBin.aspx?View=2) and remove it there. Now the app is completely removed from your site collection.

Step 2: remove the spfx app from the app catalog. Repeat the steps with the admin recycle bin to make sure this item is completely gone from the app catalog site collection.

Step 3: re-add your spfx package to the app catalog. I did not have to alter any ids to get it to work.

Step 4: re-add your app to the site collection where you want to add your web part.

Step 5: find your web part in the toolbox ! You can now also check the following endpoints to see your web part listed:
_api/web/GetClientSideWebParts
/Lists/ComponentManifests/Allitems.aspx

PieterHeemeryck picture PieterHeemeryck on 24 May 2019
👍2

1253 Related issue

PieterHeemeryck picture PieterHeemeryck on 24 May 2019

Issues that have been closed & had no follow-up activity for at least 7 days are automatically locked. Please refer to our wiki for more details, including how to remediate this action if you feel this was done prematurely or in error: Issue List: Our approach to locked issues

msft-github-bot picture msft-github-bot on 29 Jan 2020
Was this page helpful?
0 / 5 - 0 ratings

Related issues

SteIvanov picture SteIvanov  ·  3Comments
Ralms picture Ralms  ·  3Comments
christianbueschi picture christianbueschi  ·  3Comments
patrick-rodgers picture patrick-rodgers  ·  3Comments
waldekmastykarz picture waldekmastykarz  ·  3Comments