-
Notifications
You must be signed in to change notification settings - Fork 1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
SpFx Helloworld webpart does not show up under modern Page toolbox #775
Comments
Silly question, but can you scroll down in the modern page toolbox and see it lower? |
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? |
Hello Patmill, Did you get your part working on your local workbench and / or hosted workbench before uploading it to the app catalog? 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? |
It started working now.
Thank you for your guidance Patmill. |
Glad you got it sorted out. |
@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. |
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 IClientSideWebPartManifest.d.ts.txt I do see, the 'description' is not optional in the file, but could be bug in mappings. P.S I have added '.txt' extension to the file as the file type is not supported by git hub comments. |
@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 , Myself picked the 'short description' from app catalog. Please ignore 'short description'. |
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 |
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. |
I'm facing the same issue as @paigeflourin . |
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.
|
Same problem as vickeybird here. Edit: |
Ok, after an update in sharepoint (??, recyclebin look/behaves differently) things seem to be working again. |
I did exactly what you did but it's still not showing up :( This is my package-solution.json
|
I have the same problem again... /_api/web/GetClientSideWebParts doesn't show the desired webpart Removig reinstalling doesn't work, same result. Am I missing something or is this just buggy? |
I also have this problem again now - but only on some sites. This seems to be really buggy and fragile. Please advice! |
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. |
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 GitHub<https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgit.luolix.top%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 thread<https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgit.luolix.top%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 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. |
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:notifications@github.com]
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)
@patmill<https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgit.luolix.top%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 GitHub<https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgit.luolix.top%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 thread<https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgit.luolix.top%2Fnotifications%2Funsubscribe-auth%2FADl-SZyTMxZGv4W1i6tOFxP5UzkW6sWlks5tPiHrgaJpZM4OyQo6&data=02%7C01%7CPat.Miller%40microsoft.com%7Cb74f454780414e79bcf508d5675216b4%7Cee3303d7fb734b0c8589bcd847f1c277%7C1%7C0%7C636528524696864754&sdata=9OLcQTmHb75cDf0PsPDqzdujS6mT4xFbTtu7NX2UVZw%3D&reserved=0>.
|
@patmill Here is my preconfiguredEntries. The change I made are
|
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
|
Reopening for ensuring that would not get hidden as closed issue. |
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"
}
}
]
} |
@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? |
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: #775 Fix - To be able to fully successfully fix this issue, you will need to perform following steps in your SharePoint Online tenants.
You might potentially take advantage of the SharePoint ALM APIs or SharePoint PnP PowerShell cmdlets for add-ins to automate this needed process. |
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
<#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
<#775 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AADHoKDyx0pfIQcl1E7meTNY5qWfLLaiks5tVI7qgaJpZM4OyQo6>
.
|
@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. |
I'm still having issues although I ran these steps:
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. |
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) |
Yep - few things to notice here.
Not seeing any actual new issues here, so not reopening... if there are similar issues, please do open a new issue with sufficient details. |
Hi, I'm experiencing similar issue here. Any idea or suggestion? |
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 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. |
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
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. |
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 iOS<https://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 GitHub<#775 (comment)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/ADl-SXoDk30ioxGmQ5SN_WBku1J0sUb4ks5top50gaJpZM4OyQo6>.
|
Thanks @patmill . I just used some powershell to disable powershell. Thought it be something simple that I missed. Much appreciated for the guidance!! |
@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 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! |
Anybody having issues emptying the recycle bin to remove the app do this: |
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 |
in my case, I have several webparts in the same project (e.g. 4 webparts in total):
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've also encountered this problem + found a solution that worked for me:
My solution (for an SPFx solution NOT deployed to the entire tenant in one go): 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: |
#1253 Related issue |
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 |
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
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.
The text was updated successfully, but these errors were encountered: