Repository navigation
package.json in guide/elements download #31332
Description
📚 Docs or angular.io bug report
Description
In the guide about angular/elements there is an example, the issue is related to the code available for download in the end of the session https://angular.io/guide/elements#example-a-popup-service.
While the code itself works, the package.json needs to be updated.
🔬 Minimal Reproduction
- Download the code from the the link int the page, pointing to https://angular.io/generated/zips/elements/elements.zip.
- Extract the zip in a new folder.
- npm install
- ng serve
The package @angular/elements is missing.
the package
"angular-in-memory-web-api": "github:brandonroberts/in-memory-web-api-bazel#50a34d8"
require versions < 8.0.0 of some angular packages, it seems that in the mean time the package was added to npm, and now it can be changed to
"angular-in-memory-web-api": "0.8.0"
What's the affected URL?**
https://angular.io/guide/elementsI have noticed a comment in the github source about needing polyfills but in the page it was not clear if any additional step would be required after downloading. Since it is a guide it is supposed to be followed by beginners, and I believed it was something that worth to report.
Activity
gkalpak commentedon Jun 28, 2019
Good catch, @o-alexandre-felipe 👍 Thx for reporting!
Indeed, according to #31198 (comment), we need to update the dependency in aio/tools/examples/shared/package.json. Would you be interested in making this change and submitting a pull request?
o-alexandre-felipe commentedon Jun 30, 2019
Ok @sparshag21, I wish you a good contribution :)-
kapunahelewong commentedon Aug 2, 2019
@sparshag21, if you're still planning on doing this, will you tag me?
Armor-cn commentedon Oct 12, 2019
Upgrade the "angular-in-memory-web-api" version to 0.9.
gkalpak commentedon Oct 12, 2019
Reading the issue description again, I now realize there are two issues discussed here:
angular-in-memory-web-apiin the examples'package.json.@angular/elementsdependency missing from theelements' example'spackage.json`.The first issue has already been fixed (see 393398e6f#diff-835d685609901b14699e46f15601e9f0).
For the second, we need to introduce a new
elementsexample type and specify that theelementsexample is of that type. We actually had such a type in the past, but it was removed in 661a57d. So, we basically need to re-introduce it.It is likely not a good first contribution candidate, but if anyone wants to take a stub at it, we basically need similar changes to 1c533c9 (the commit that introduced it originally), except that instead of a custom
aio/tools/examples/boilerplate/element/tsconfig.jsonwe now need a customaio/tools/examples/boilerplate/element/package.json(which lists@angular/elementsas a dependency). This would be very similar to thepackage.jsonforservice-workerexample type (except that we would have@angular/elementsinstead of@angular/service-worker).yallen011 commentedon Oct 23, 2019
Can I take a stab at the
@angular/elementsdependency fix. The explanation given by @gkalpak of what needs to be done seems clear and I would love to do this as my first open source contribution, as well as for Hacktoberfest 😄gkalpak commentedon Oct 23, 2019
Sure, go for it, @yallen011. (fyi @kapunahelewong (who's currently assigned) to avoid duplication of work)
@yallen011, feel free to ping @kapunahelewong or me if you have questions/run into difficulties.
yallen011 commentedon Oct 25, 2019
@gkalpak @kapunahelewong ok, great. working on it
fix(docs-infra): add boilerplate path and project type for elements e…
fix(docs-infra): add boilerplate path and project type for elements e…
angular-automatic-lock-bot commentedon Apr 11, 2020
This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.
Read more about our automatic conversation locking policy.
This action has been performed automatically by a bot.