@zxncij2390/monorepo3 3.18.0
Sign up to get free protection for your applications and to get access to all the features.
- package/.eslintignore +16 -0
- package/.eslintrc.cjs +150 -0
- package/.github/ISSUE_TEMPLATE/bug-report.yml +178 -0
- package/.github/ISSUE_TEMPLATE/enhancement.yml +99 -0
- package/.github/ISSUE_TEMPLATE/question.yml +72 -0
- package/.github/ISSUE_TEMPLATE.md +39 -0
- package/.github/PULL_REQUEST_TEMPLATE.md +24 -0
- package/.github/workflows/lock.yml +18 -0
- package/.github/workflows/publish-buildsystem.yml +34 -0
- package/.github/workflows/publish-docs.yml +21 -0
- package/.github/workflows/publish.yml +40 -0
- package/.github/workflows/pull_request.yaml +28 -0
- package/.github/workflows/push.yaml +32 -0
- package/.github/workflows/v3-nightly.yml +40 -0
- package/.mocharc.cjs +68 -0
- package/.vscode/launch.json +103 -0
- package/.vscode/settings.json +17 -0
- package/.vscode/tasks.json +124 -0
- package/AUTHORS +13 -0
- package/CHANGELOG.md +33 -0
- package/CODE_OF_CONDUCT.md +6 -0
- package/CONTRIBUTING.md +9 -0
- package/LICENSE +25 -0
- package/README.md +66 -0
- package/buildsystem-config.ts +146 -0
- package/debug/launch/graph.ts +20 -0
- package/debug/launch/main.ts +38 -0
- package/debug/launch/setup.ts +50 -0
- package/debug/launch/sp.ts +21 -0
- package/debug/launch/tsconfig.json +27 -0
- package/debug/serve/main.ts +47 -0
- package/debug/serve/plumbing/local-module-resolver-plugin.ts +68 -0
- package/debug/serve/plumbing/run.ts +24 -0
- package/debug/serve/plumbing/serve.ts +27 -0
- package/debug/serve/plumbing/webpack.config.ts +43 -0
- package/debug/serve/spa.html +12 -0
- package/debug/serve/tsconfig.json +15 -0
- package/debug/spfx/.eslintrc.js +352 -0
- package/debug/spfx/README.md +73 -0
- package/debug/spfx/package-lock.json +57299 -0
- package/debug/spfx/package.json +38 -0
- package/debug/spfx/pnpjs-local-debug-start.js +19 -0
- package/debug/spfx/teams/f4c0e5ff-c402-46b7-8073-8cc506808d06_color.png +0 -0
- package/debug/spfx/teams/f4c0e5ff-c402-46b7-8073-8cc506808d06_outline.png +0 -0
- package/docs/_theme/main.html +5 -0
- package/docs/azidjsclient/index.md +36 -0
- package/docs/concepts/adv-clientside-pages.md +169 -0
- package/docs/concepts/auth-browser.md +42 -0
- package/docs/concepts/auth-nodejs.md +101 -0
- package/docs/concepts/auth-spfx.md +76 -0
- package/docs/concepts/authentication.md +42 -0
- package/docs/concepts/batching-caching.md +77 -0
- package/docs/concepts/batching.md +257 -0
- package/docs/concepts/calling-other-endpoints.md +213 -0
- package/docs/concepts/custom-bundle.md +15 -0
- package/docs/concepts/error-handling.md +245 -0
- package/docs/concepts/invokable.md +7 -0
- package/docs/concepts/nightly-builds.md +19 -0
- package/docs/concepts/project-preset.md +123 -0
- package/docs/concepts/selective-imports.md +106 -0
- package/docs/concepts/typings.md +23 -0
- package/docs/contributing/debug-tests.md +76 -0
- package/docs/contributing/debugging.md +135 -0
- package/docs/contributing/documentation.md +34 -0
- package/docs/contributing/extending-the-library.md +223 -0
- package/docs/contributing/index.md +22 -0
- package/docs/contributing/local-debug-configuration.md +28 -0
- package/docs/contributing/npm-scripts.md +148 -0
- package/docs/contributing/pull-requests.md +27 -0
- package/docs/contributing/settings.md +98 -0
- package/docs/contributing/setup-dev-machine.md +36 -0
- package/docs/core/behavior-recipes.md +199 -0
- package/docs/core/behaviors.md +179 -0
- package/docs/core/moments.md +215 -0
- package/docs/core/observers.md +100 -0
- package/docs/core/storage.md +90 -0
- package/docs/core/timeline.md +190 -0
- package/docs/core/util.md +191 -0
- package/docs/css/extra.css +33 -0
- package/docs/getting-started.md +361 -0
- package/docs/graph/behaviors.md +267 -0
- package/docs/graph/bookings.md +180 -0
- package/docs/graph/calendars.md +270 -0
- package/docs/graph/cloud-communications.md +40 -0
- package/docs/graph/columns.md +125 -0
- package/docs/graph/contacts.md +298 -0
- package/docs/graph/content-types.md +193 -0
- package/docs/graph/directoryobjects.md +106 -0
- package/docs/graph/groups.md +164 -0
- package/docs/graph/insights.md +151 -0
- package/docs/graph/invitations.md +22 -0
- package/docs/graph/items.md +38 -0
- package/docs/graph/lists.md +87 -0
- package/docs/graph/messages.md +20 -0
- package/docs/graph/onedrive.md +614 -0
- package/docs/graph/outlook.md +82 -0
- package/docs/graph/photos.md +71 -0
- package/docs/graph/planner.md +249 -0
- package/docs/graph/search.md +25 -0
- package/docs/graph/shares.md +44 -0
- package/docs/graph/sites.md +47 -0
- package/docs/graph/subscriptions.md +79 -0
- package/docs/graph/teams.md +293 -0
- package/docs/graph/users.md +134 -0
- package/docs/img/ConsoleListenerColors.png +0 -0
- package/docs/img/Logo.png +0 -0
- package/docs/img/PnPJS_FluentAPI.gif +0 -0
- package/docs/img/SPFx-On-Premesis-2016-1.png +0 -0
- package/docs/img/TimelineArchitecture.jpg +0 -0
- package/docs/img/csp_copyccvalue.png +0 -0
- package/docs/img/csp_networktab.png +0 -0
- package/docs/img/office365-header-icon.png +0 -0
- package/docs/img/usage-2020-eoy.png +0 -0
- package/docs/img/usage-2021-eoy.png +0 -0
- package/docs/img/usage-2022-eoy.png +0 -0
- package/docs/index.md +56 -0
- package/docs/logging/index.md +262 -0
- package/docs/msaljsclient/index.md +33 -0
- package/docs/news/2020-year-in-review.md +162 -0
- package/docs/news/2021-year-in-review.md +148 -0
- package/docs/news/2022-year-in-review.md +122 -0
- package/docs/nodejs/behaviors.md +164 -0
- package/docs/nodejs/sp-extensions.md +99 -0
- package/docs/packages.md +53 -0
- package/docs/queryable/behaviors.md +496 -0
- package/docs/queryable/extensions.md +204 -0
- package/docs/queryable/queryable.md +385 -0
- package/docs/sp/alias-parameters.md +76 -0
- package/docs/sp/alm.md +139 -0
- package/docs/sp/attachments.md +157 -0
- package/docs/sp/behaviors.md +142 -0
- package/docs/sp/clientside-pages.md +1048 -0
- package/docs/sp/column-defaults.md +241 -0
- package/docs/sp/comments-likes.md +302 -0
- package/docs/sp/content-types.md +131 -0
- package/docs/sp/context-info.md +67 -0
- package/docs/sp/favorites.md +91 -0
- package/docs/sp/features.md +83 -0
- package/docs/sp/fields.md +668 -0
- package/docs/sp/files.md +559 -0
- package/docs/sp/folders.md +532 -0
- package/docs/sp/forms.md +22 -0
- package/docs/sp/groupSiteManager.md +40 -0
- package/docs/sp/hubsites.md +140 -0
- package/docs/sp/items.md +601 -0
- package/docs/sp/lists.md +572 -0
- package/docs/sp/navigation.md +171 -0
- package/docs/sp/permissions.md +82 -0
- package/docs/sp/profiles.md +407 -0
- package/docs/sp/publishing-sitepageservice.md +16 -0
- package/docs/sp/recycle-bin.md +72 -0
- package/docs/sp/regional-settings.md +108 -0
- package/docs/sp/related-items.md +136 -0
- package/docs/sp/search.md +207 -0
- package/docs/sp/security.md +196 -0
- package/docs/sp/sharing.md +273 -0
- package/docs/sp/site-designs.md +117 -0
- package/docs/sp/site-groups.md +144 -0
- package/docs/sp/site-scripts.md +123 -0
- package/docs/sp/site-users.md +211 -0
- package/docs/sp/sites.md +269 -0
- package/docs/sp/social.md +182 -0
- package/docs/sp/sp-utilities-utility.md +159 -0
- package/docs/sp/subscriptions.md +79 -0
- package/docs/sp/taxonomy.md +470 -0
- package/docs/sp/tenant-properties.md +55 -0
- package/docs/sp/user-custom-actions.md +95 -0
- package/docs/sp/views.md +226 -0
- package/docs/sp/webs.md +947 -0
- package/docs/sp-admin/index.md +139 -0
- package/docs/transition-guide.md +87 -0
- package/docs/v1/404.html +1611 -0
- package/docs/v1/assets/fonts/font-awesome.css +4 -0
- package/docs/v1/assets/fonts/material-icons.css +13 -0
- package/docs/v1/assets/fonts/specimen/FontAwesome.ttf +0 -0
- package/docs/v1/assets/fonts/specimen/FontAwesome.woff +0 -0
- package/docs/v1/assets/fonts/specimen/FontAwesome.woff2 +0 -0
- package/docs/v1/assets/fonts/specimen/MaterialIcons-Regular.ttf +0 -0
- package/docs/v1/assets/fonts/specimen/MaterialIcons-Regular.woff +0 -0
- package/docs/v1/assets/fonts/specimen/MaterialIcons-Regular.woff2 +0 -0
- package/docs/v1/assets/images/favicon.png +0 -0
- package/docs/v1/assets/images/icons/bitbucket.1b09e088.svg +20 -0
- package/docs/v1/assets/images/icons/github.f0b8504a.svg +18 -0
- package/docs/v1/assets/images/icons/gitlab.6dd19c00.svg +38 -0
- package/docs/v1/assets/javascripts/application.583bbe55.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.da.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.de.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.du.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.es.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.fi.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.fr.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.hu.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.it.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.jp.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.multi.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.no.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.pt.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.ro.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.ru.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.stemmer.support.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.sv.js +1 -0
- package/docs/v1/assets/javascripts/lunr/lunr.tr.js +1 -0
- package/docs/v1/assets/javascripts/lunr/tinyseg.js +1 -0
- package/docs/v1/assets/javascripts/modernizr.1aa3b519.js +1 -0
- package/docs/v1/assets/stylesheets/application-palette.22915126.css +1176 -0
- package/docs/v1/assets/stylesheets/application.451f80e5.css +2552 -0
- package/docs/v1/common/docs/adalclient/index.html +1994 -0
- package/docs/v1/common/docs/collections/index.html +1786 -0
- package/docs/v1/common/docs/custom-httpclientimpl/index.html +1798 -0
- package/docs/v1/common/docs/index.html +1787 -0
- package/docs/v1/common/docs/libconfig/index.html +1930 -0
- package/docs/v1/common/docs/netutil/index.html +1860 -0
- package/docs/v1/common/docs/storage/index.html +1850 -0
- package/docs/v1/common/docs/util/index.html +2058 -0
- package/docs/v1/config-store/docs/configuration/index.html +1730 -0
- package/docs/v1/config-store/docs/index.html +1761 -0
- package/docs/v1/config-store/docs/providers/index.html +1782 -0
- package/docs/v1/documentation/SPFx-On-Premesis-2016/index.html +1720 -0
- package/docs/v1/documentation/beta-versions/index.html +1742 -0
- package/docs/v1/documentation/css/extra.css +33 -0
- package/docs/v1/documentation/debugging/index.html +2098 -0
- package/docs/v1/documentation/deployment/index.html +1972 -0
- package/docs/v1/documentation/documentation/index.html +1760 -0
- package/docs/v1/documentation/getting-started/index.html +2280 -0
- package/docs/v1/documentation/getting-started-dev/index.html +1799 -0
- package/docs/v1/documentation/gulp-commands/index.html +2100 -0
- package/docs/v1/documentation/img/Logo.png +0 -0
- package/docs/v1/documentation/img/PnPJS_FluentAPI.gif +0 -0
- package/docs/v1/documentation/img/SPFx-On-Premesis-2016-1.png +0 -0
- package/docs/v1/documentation/img/office365-header-icon.png +0 -0
- package/docs/v1/documentation/img/pnpjs-common-uml.svg +220 -0
- package/docs/v1/documentation/img/pnpjs-config-store-uml.svg +56 -0
- package/docs/v1/documentation/img/pnpjs-graph-uml.svg +602 -0
- package/docs/v1/documentation/img/pnpjs-logging-uml.svg +59 -0
- package/docs/v1/documentation/img/pnpjs-nodejs-uml.svg +85 -0
- package/docs/v1/documentation/img/pnpjs-odata-uml.svg +253 -0
- package/docs/v1/documentation/img/pnpjs-sp-addinhelpers-uml.svg +48 -0
- package/docs/v1/documentation/img/pnpjs-sp-clientsvc-uml.svg +167 -0
- package/docs/v1/documentation/img/pnpjs-sp-taxonomy-uml.svg +458 -0
- package/docs/v1/documentation/img/pnpjs-sp-uml.svg +2833 -0
- package/docs/v1/documentation/package-structure/index.html +1875 -0
- package/docs/v1/documentation/packages/index.html +1741 -0
- package/docs/v1/documentation/polyfill/index.html +1877 -0
- package/docs/v1/documentation/theme/main.html +5 -0
- package/docs/v1/documentation/transition-guide/index.html +1977 -0
- package/docs/v1/graph/docs/contacts/index.html +2080 -0
- package/docs/v1/graph/docs/directoryobjects/index.html +1865 -0
- package/docs/v1/graph/docs/index.html +1858 -0
- package/docs/v1/graph/docs/insights/index.html +1698 -0
- package/docs/v1/graph/docs/invitations/index.html +1742 -0
- package/docs/v1/graph/docs/onedrive/index.html +2086 -0
- package/docs/v1/graph/docs/people/index.html +1664 -0
- package/docs/v1/graph/docs/planner/index.html +2097 -0
- package/docs/v1/graph/docs/security/index.html +1692 -0
- package/docs/v1/graph/docs/sites/index.html +2043 -0
- package/docs/v1/graph/docs/subscriptions/index.html +1835 -0
- package/docs/v1/graph/docs/teams/index.html +2097 -0
- package/docs/v1/index.html +1889 -0
- package/docs/v1/logging/docs/index.html +2045 -0
- package/docs/v1/nodejs/docs/adal-certificate-fetch-client/index.html +1676 -0
- package/docs/v1/nodejs/docs/adal-fetch-client/index.html +1713 -0
- package/docs/v1/nodejs/docs/bearer-token-fetch-client/index.html +1712 -0
- package/docs/v1/nodejs/docs/index.html +1764 -0
- package/docs/v1/nodejs/docs/provider-hosted-app/index.html +1725 -0
- package/docs/v1/nodejs/docs/proxy/index.html +1699 -0
- package/docs/v1/nodejs/docs/sp-fetch-client/index.html +1895 -0
- package/docs/v1/odata/docs/caching/index.html +1988 -0
- package/docs/v1/odata/docs/core/index.html +1829 -0
- package/docs/v1/odata/docs/index.html +1781 -0
- package/docs/v1/odata/docs/odata-batch/index.html +1755 -0
- package/docs/v1/odata/docs/parsers/index.html +1862 -0
- package/docs/v1/odata/docs/pipeline/index.html +1811 -0
- package/docs/v1/odata/docs/queryable/index.html +1967 -0
- package/docs/v1/pnpjs/docs/index.html +1814 -0
- package/docs/v1/search/search_index.json +1 -0
- package/docs/v1/sitemap.xml +428 -0
- package/docs/v1/sitemap.xml.gz +0 -0
- package/docs/v1/sp/docs/alias-parameters/index.html +1830 -0
- package/docs/v1/sp/docs/alm/index.html +1920 -0
- package/docs/v1/sp/docs/attachments/index.html +1998 -0
- package/docs/v1/sp/docs/client-side-pages/index.html +2031 -0
- package/docs/v1/sp/docs/comments-likes/index.html +1958 -0
- package/docs/v1/sp/docs/content-types/index.html +1758 -0
- package/docs/v1/sp/docs/entity-merging/index.html +1838 -0
- package/docs/v1/sp/docs/features/index.html +1824 -0
- package/docs/v1/sp/docs/fields/index.html +2031 -0
- package/docs/v1/sp/docs/files/index.html +2178 -0
- package/docs/v1/sp/docs/index.html +1894 -0
- package/docs/v1/sp/docs/items/index.html +2362 -0
- package/docs/v1/sp/docs/navigation-service/index.html +1791 -0
- package/docs/v1/sp/docs/permissions/index.html +1860 -0
- package/docs/v1/sp/docs/profiles/index.html +1794 -0
- package/docs/v1/sp/docs/related-items/index.html +1886 -0
- package/docs/v1/sp/docs/search/index.html +1830 -0
- package/docs/v1/sp/docs/sharing/index.html +2058 -0
- package/docs/v1/sp/docs/sitedesigns/index.html +1851 -0
- package/docs/v1/sp/docs/sites/index.html +2186 -0
- package/docs/v1/sp/docs/social/index.html +2011 -0
- package/docs/v1/sp/docs/sp-utilities-utility/index.html +2061 -0
- package/docs/v1/sp/docs/tenant-properties/index.html +1795 -0
- package/docs/v1/sp/docs/views/index.html +1869 -0
- package/docs/v1/sp/docs/webs/index.html +1972 -0
- package/docs/v1/sp-addinhelpers/docs/index.html +1771 -0
- package/docs/v1/sp-addinhelpers/docs/sp-request-executor-client/index.html +1760 -0
- package/docs/v1/sp-addinhelpers/docs/sp-rest-addin/index.html +1711 -0
- package/docs/v1/sp-clientsvc/docs/index.html +1736 -0
- package/docs/v1/sp-taxonomy/docs/index.html +1887 -0
- package/docs/v1/sp-taxonomy/docs/labels/index.html +1827 -0
- package/docs/v1/sp-taxonomy/docs/term-groups/index.html +1875 -0
- package/docs/v1/sp-taxonomy/docs/term-sets/index.html +1946 -0
- package/docs/v1/sp-taxonomy/docs/term-stores/index.html +2111 -0
- package/docs/v1/sp-taxonomy/docs/terms/index.html +2036 -0
- package/docs/v1/sp-taxonomy/docs/utilities/index.html +1783 -0
- package/docs/v2/404.html +2108 -0
- package/docs/v2/SPFx-on-premises/index.html +2278 -0
- package/docs/v2/_theme/main.html +5 -0
- package/docs/v2/adaljsclient/adalclient/index.html +15 -0
- package/docs/v2/adaljsclient/index.html +15 -0
- package/docs/v2/assets/images/favicon.png +0 -0
- package/docs/v2/assets/javascripts/bundle.9554a270.min.js +2 -0
- package/docs/v2/assets/javascripts/bundle.9554a270.min.js.map +1 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.ar.min.js +1 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.da.min.js +18 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.de.min.js +18 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.du.min.js +18 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.es.min.js +18 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.fi.min.js +18 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.fr.min.js +18 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.hu.min.js +18 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.it.min.js +18 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.ja.min.js +1 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.jp.min.js +1 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.multi.min.js +1 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.nl.min.js +18 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.no.min.js +18 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.pt.min.js +18 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.ro.min.js +18 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.ru.min.js +18 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.stemmer.support.min.js +1 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.sv.min.js +18 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.tr.min.js +18 -0
- package/docs/v2/assets/javascripts/lunr/min/lunr.vi.min.js +1 -0
- package/docs/v2/assets/javascripts/lunr/tinyseg.min.js +1 -0
- package/docs/v2/assets/javascripts/vendor.77e55a48.min.js +30 -0
- package/docs/v2/assets/javascripts/vendor.77e55a48.min.js.map +1 -0
- package/docs/v2/assets/javascripts/worker/search.4ac00218.min.js +59 -0
- package/docs/v2/assets/javascripts/worker/search.4ac00218.min.js.map +1 -0
- package/docs/v2/assets/stylesheets/main.38780c08.min.css +3 -0
- package/docs/v2/assets/stylesheets/main.38780c08.min.css.map +1 -0
- package/docs/v2/assets/stylesheets/palette.3f72e892.min.css +3 -0
- package/docs/v2/assets/stylesheets/palette.3f72e892.min.css.map +1 -0
- package/docs/v2/authentication/adaljsclient/index.html +2510 -0
- package/docs/v2/authentication/bearertokenclient/index.html +2251 -0
- package/docs/v2/authentication/client-spa/index.html +2206 -0
- package/docs/v2/authentication/client-spfx/index.html +2397 -0
- package/docs/v2/authentication/index.html +2307 -0
- package/docs/v2/authentication/lambdaclient/index.html +2304 -0
- package/docs/v2/authentication/msaljsclient/index.html +2413 -0
- package/docs/v2/authentication/server-nodejs/index.html +2404 -0
- package/docs/v2/authentication/sp-app-registration/index.html +2273 -0
- package/docs/v2/common/collections/index.html +2277 -0
- package/docs/v2/common/custom-httpclientimpl/index.html +2300 -0
- package/docs/v2/common/index.html +2262 -0
- package/docs/v2/common/libconfig/index.html +2413 -0
- package/docs/v2/common/netutil/index.html +2350 -0
- package/docs/v2/common/storage/index.html +2339 -0
- package/docs/v2/common/util/index.html +2638 -0
- package/docs/v2/concepts/configuration/index.html +2685 -0
- package/docs/v2/concepts/custom-bundle/index.html +2279 -0
- package/docs/v2/concepts/error-handling/index.html +2539 -0
- package/docs/v2/concepts/ie11-mode/index.html +2278 -0
- package/docs/v2/concepts/invokable/index.html +2254 -0
- package/docs/v2/concepts/polyfill/index.html +2401 -0
- package/docs/v2/concepts/selective-imports/index.html +2360 -0
- package/docs/v2/concepts/settings/index.html +2551 -0
- package/docs/v2/config-store/configuration/index.html +2226 -0
- package/docs/v2/config-store/index.html +2239 -0
- package/docs/v2/config-store/providers/index.html +2275 -0
- package/docs/v2/contributing/debug-tests/index.html +2323 -0
- package/docs/v2/contributing/debugging/index.html +2514 -0
- package/docs/v2/contributing/documentation/index.html +2291 -0
- package/docs/v2/contributing/extending-the-library/index.html +2521 -0
- package/docs/v2/contributing/index.html +2270 -0
- package/docs/v2/contributing/local-debug-configuration/index.html +2284 -0
- package/docs/v2/contributing/pull-requests/index.html +2261 -0
- package/docs/v2/contributing/setup-dev-machine/index.html +2284 -0
- package/docs/v2/css/extra.css +33 -0
- package/docs/v2/debug-tests/index.html +15 -0
- package/docs/v2/debugging/index.html +15 -0
- package/docs/v2/documentation/index.html +15 -0
- package/docs/v2/getting-started/index.html +2789 -0
- package/docs/v2/getting-started-dev/index.html +15 -0
- package/docs/v2/graph/calendars/index.html +2569 -0
- package/docs/v2/graph/contacts/index.html +2673 -0
- package/docs/v2/graph/directoryobjects/index.html +2402 -0
- package/docs/v2/graph/groups/index.html +2488 -0
- package/docs/v2/graph/index.html +2333 -0
- package/docs/v2/graph/insights/index.html +2478 -0
- package/docs/v2/graph/invitations/index.html +2273 -0
- package/docs/v2/graph/onedrive/index.html +2617 -0
- package/docs/v2/graph/outlook/index.html +2363 -0
- package/docs/v2/graph/photos/index.html +2351 -0
- package/docs/v2/graph/planner/index.html +2628 -0
- package/docs/v2/graph/search/index.html +2264 -0
- package/docs/v2/graph/subscriptions/index.html +2333 -0
- package/docs/v2/graph/teams/index.html +2619 -0
- package/docs/v2/graph/users/index.html +2461 -0
- package/docs/v2/img/ConsoleListenerColors.png +0 -0
- package/docs/v2/img/Logo.png +0 -0
- package/docs/v2/img/PnPJS_FluentAPI.gif +0 -0
- package/docs/v2/img/SPFx-On-Premesis-2016-1.png +0 -0
- package/docs/v2/img/office365-header-icon.png +0 -0
- package/docs/v2/img/usage-2020-eoy.png +0 -0
- package/docs/v2/index.html +2410 -0
- package/docs/v2/logging/index.html +2622 -0
- package/docs/v2/news/2020-year-in-review/index.html +2525 -0
- package/docs/v2/nodejs/adal-fetch-client/index.html +2204 -0
- package/docs/v2/nodejs/bearer-token-fetch-client/index.html +2203 -0
- package/docs/v2/nodejs/index.html +2261 -0
- package/docs/v2/nodejs/provider-hosted-app/index.html +2220 -0
- package/docs/v2/nodejs/proxy/index.html +2238 -0
- package/docs/v2/nodejs/sp-extensions/index.html +2362 -0
- package/docs/v2/nodejs/sp-fetch-client/index.html +2294 -0
- package/docs/v2/nodejs-support/index.html +2398 -0
- package/docs/v2/npm-scripts/index.html +2521 -0
- package/docs/v2/odata/caching/index.html +2465 -0
- package/docs/v2/odata/core/index.html +2322 -0
- package/docs/v2/odata/debug/index.html +2358 -0
- package/docs/v2/odata/extensions/index.html +2581 -0
- package/docs/v2/odata/index.html +2259 -0
- package/docs/v2/odata/odata-batch/index.html +2250 -0
- package/docs/v2/odata/parsers/index.html +2355 -0
- package/docs/v2/odata/pipeline/index.html +2297 -0
- package/docs/v2/odata/queryable/index.html +2455 -0
- package/docs/v2/packages/index.html +2251 -0
- package/docs/v2/pnpjs/index.html +2281 -0
- package/docs/v2/search/search_index.json +1 -0
- package/docs/v2/sitemap.xml +483 -0
- package/docs/v2/sitemap.xml.gz +0 -0
- package/docs/v2/sp/alias-parameters/index.html +2330 -0
- package/docs/v2/sp/alm/index.html +2433 -0
- package/docs/v2/sp/attachments/index.html +2504 -0
- package/docs/v2/sp/clientside-pages/index.html +3477 -0
- package/docs/v2/sp/column-defaults/index.html +2540 -0
- package/docs/v2/sp/comments-likes/index.html +2646 -0
- package/docs/v2/sp/content-types/index.html +2462 -0
- package/docs/v2/sp/custom-irequestclient/index.html +2339 -0
- package/docs/v2/sp/entity-merging/index.html +2325 -0
- package/docs/v2/sp/features/index.html +2440 -0
- package/docs/v2/sp/fields/index.html +3103 -0
- package/docs/v2/sp/files/index.html +2949 -0
- package/docs/v2/sp/folders/index.html +2968 -0
- package/docs/v2/sp/forms/index.html +2289 -0
- package/docs/v2/sp/hubsites/index.html +2485 -0
- package/docs/v2/sp/index.html +2328 -0
- package/docs/v2/sp/items/index.html +2974 -0
- package/docs/v2/sp/lists/index.html +3387 -0
- package/docs/v2/sp/navigation/index.html +2535 -0
- package/docs/v2/sp/permissions/index.html +2338 -0
- package/docs/v2/sp/profiles/index.html +2806 -0
- package/docs/v2/sp/regional-settings/index.html +2394 -0
- package/docs/v2/sp/related-items/index.html +2417 -0
- package/docs/v2/sp/search/index.html +2474 -0
- package/docs/v2/sp/security/index.html +2432 -0
- package/docs/v2/sp/sharing/index.html +2589 -0
- package/docs/v2/sp/site-designs/index.html +2414 -0
- package/docs/v2/sp/site-groups/index.html +2504 -0
- package/docs/v2/sp/site-scripts/index.html +2433 -0
- package/docs/v2/sp/site-users/index.html +2641 -0
- package/docs/v2/sp/sites/index.html +2727 -0
- package/docs/v2/sp/social/index.html +2517 -0
- package/docs/v2/sp/sp-utilities-utility/index.html +2460 -0
- package/docs/v2/sp/subscriptions/index.html +2395 -0
- package/docs/v2/sp/taxonomy/index.html +2565 -0
- package/docs/v2/sp/tenant-properties/index.html +2286 -0
- package/docs/v2/sp/user-custom-actions/index.html +2424 -0
- package/docs/v2/sp/views/index.html +2652 -0
- package/docs/v2/sp/webs/index.html +4190 -0
- package/docs/v2/sp-addinhelpers/index.html +2274 -0
- package/docs/v2/sp-addinhelpers/sp-request-executor-client/index.html +2253 -0
- package/docs/v2/sp-addinhelpers/sp-rest-addin/index.html +2206 -0
- package/docs/v2/transition-guide/index.html +2435 -0
- package/mkdocs-requirements.txt +2 -0
- package/mkdocs.yml +188 -0
- package/package.json +96 -0
- package/packages/azidjsclient/index.ts +68 -0
- package/packages/azidjsclient/package.json +13 -0
- package/packages/azidjsclient/tsconfig.json +12 -0
- package/packages/core/behaviors/assign-from.ts +17 -0
- package/packages/core/behaviors/copy-from.ts +58 -0
- package/packages/core/extendable.ts +193 -0
- package/packages/core/index.ts +11 -0
- package/packages/core/moments.ts +117 -0
- package/packages/core/package.json +10 -0
- package/packages/core/storage.ts +274 -0
- package/packages/core/timeline.ts +387 -0
- package/packages/core/tsconfig.json +10 -0
- package/packages/core/util.ts +169 -0
- package/packages/graph/attachments/conversations.ts +14 -0
- package/packages/graph/attachments/index.ts +8 -0
- package/packages/graph/attachments/types.ts +37 -0
- package/packages/graph/batching.ts +408 -0
- package/packages/graph/behaviors/consistency-level.ts +17 -0
- package/packages/graph/behaviors/defaults.ts +41 -0
- package/packages/graph/behaviors/endpoint.ts +22 -0
- package/packages/graph/behaviors/graphbrowser.ts +38 -0
- package/packages/graph/behaviors/paged.ts +109 -0
- package/packages/graph/behaviors/spfx.ts +46 -0
- package/packages/graph/behaviors/telemetry.ts +19 -0
- package/packages/graph/bookings/funcs.ts +18 -0
- package/packages/graph/bookings/index.ts +62 -0
- package/packages/graph/bookings/types.ts +352 -0
- package/packages/graph/calendars/funcs.ts +58 -0
- package/packages/graph/calendars/groups.ts +19 -0
- package/packages/graph/calendars/index.ts +18 -0
- package/packages/graph/calendars/types.ts +73 -0
- package/packages/graph/calendars/users.ts +28 -0
- package/packages/graph/cloud-communications/index.ts +24 -0
- package/packages/graph/cloud-communications/types.ts +32 -0
- package/packages/graph/cloud-communications/users.ts +15 -0
- package/packages/graph/columns/addColumns.ts +28 -0
- package/packages/graph/columns/content-types.ts +44 -0
- package/packages/graph/columns/index.ts +14 -0
- package/packages/graph/columns/lists.ts +33 -0
- package/packages/graph/columns/sites.ts +32 -0
- package/packages/graph/columns/types.ts +24 -0
- package/packages/graph/contacts/index.ts +14 -0
- package/packages/graph/contacts/types.ts +126 -0
- package/packages/graph/contacts/users.ts +17 -0
- package/packages/graph/content-types/index.ts +11 -0
- package/packages/graph/content-types/lists.ts +44 -0
- package/packages/graph/content-types/sites.ts +70 -0
- package/packages/graph/content-types/types.ts +112 -0
- package/packages/graph/conversations/groups.ts +20 -0
- package/packages/graph/conversations/index.ts +19 -0
- package/packages/graph/conversations/types.ts +147 -0
- package/packages/graph/decorators.ts +164 -0
- package/packages/graph/directory-objects/index.ts +24 -0
- package/packages/graph/directory-objects/types.ts +94 -0
- package/packages/graph/fi.ts +46 -0
- package/packages/graph/graphqueryable.ts +193 -0
- package/packages/graph/groups/index.ts +25 -0
- package/packages/graph/groups/types.ts +130 -0
- package/packages/graph/index.ts +21 -0
- package/packages/graph/insights/index.ts +20 -0
- package/packages/graph/insights/types.ts +105 -0
- package/packages/graph/insights/users.ts +14 -0
- package/packages/graph/invitations/index.ts +22 -0
- package/packages/graph/invitations/types.ts +41 -0
- package/packages/graph/lists/drive.ts +21 -0
- package/packages/graph/lists/index.ts +10 -0
- package/packages/graph/lists/sites.ts +16 -0
- package/packages/graph/lists/types.ts +47 -0
- package/packages/graph/members/groups.ts +17 -0
- package/packages/graph/members/index.ts +8 -0
- package/packages/graph/members/types.ts +40 -0
- package/packages/graph/messages/index.ts +14 -0
- package/packages/graph/messages/types.ts +46 -0
- package/packages/graph/messages/users.ts +27 -0
- package/packages/graph/onedrive/funcs.ts +40 -0
- package/packages/graph/onedrive/groups.ts +33 -0
- package/packages/graph/onedrive/index.ts +48 -0
- package/packages/graph/onedrive/sites.ts +35 -0
- package/packages/graph/onedrive/types.ts +482 -0
- package/packages/graph/onedrive/users.ts +56 -0
- package/packages/graph/onenote/index.ts +16 -0
- package/packages/graph/onenote/types.ts +119 -0
- package/packages/graph/onenote/users.ts +14 -0
- package/packages/graph/operations.ts +22 -0
- package/packages/graph/outlook/index.ts +11 -0
- package/packages/graph/outlook/types.ts +58 -0
- package/packages/graph/outlook/users.ts +14 -0
- package/packages/graph/package.json +16 -0
- package/packages/graph/photos/groups.ts +14 -0
- package/packages/graph/photos/index.ts +7 -0
- package/packages/graph/photos/types.ts +33 -0
- package/packages/graph/photos/users.ts +14 -0
- package/packages/graph/planner/groups.ts +14 -0
- package/packages/graph/planner/index.ts +42 -0
- package/packages/graph/planner/types.ts +213 -0
- package/packages/graph/planner/users.ts +14 -0
- package/packages/graph/post-install.cjs +20 -0
- package/packages/graph/presets/all.ts +42 -0
- package/packages/graph/search/index.ts +18 -0
- package/packages/graph/search/types.ts +20 -0
- package/packages/graph/shares/index.ts +23 -0
- package/packages/graph/shares/types.ts +47 -0
- package/packages/graph/sites/group.ts +14 -0
- package/packages/graph/sites/index.ts +25 -0
- package/packages/graph/sites/types.ts +45 -0
- package/packages/graph/subscriptions/index.ts +24 -0
- package/packages/graph/subscriptions/types.ts +59 -0
- package/packages/graph/teams/index.ts +68 -0
- package/packages/graph/teams/types.ts +333 -0
- package/packages/graph/teams/users.ts +14 -0
- package/packages/graph/tsconfig.json +16 -0
- package/packages/graph/users/index.ts +34 -0
- package/packages/graph/users/types.ts +56 -0
- package/packages/graph/utils/type.ts +3 -0
- package/packages/logging/index.ts +145 -0
- package/packages/logging/listeners.ts +134 -0
- package/packages/logging/package.json +10 -0
- package/packages/logging/tsconfig.json +7 -0
- package/packages/msaljsclient/index.ts +40 -0
- package/packages/msaljsclient/package.json +12 -0
- package/packages/msaljsclient/tsconfig.json +12 -0
- package/packages/nodejs/behaviors/fetch.ts +130 -0
- package/packages/nodejs/behaviors/graphdefault.ts +50 -0
- package/packages/nodejs/behaviors/msal.ts +24 -0
- package/packages/nodejs/behaviors/spdefault.ts +45 -0
- package/packages/nodejs/behaviors/stream-parse.ts +7 -0
- package/packages/nodejs/index.ts +33 -0
- package/packages/nodejs/package.json +17 -0
- package/packages/nodejs/sp-extensions/stream.ts +136 -0
- package/packages/nodejs/tsconfig.json +28 -0
- package/packages/queryable/add-prop.ts +18 -0
- package/packages/queryable/behaviors/bearer-token.ts +15 -0
- package/packages/queryable/behaviors/browser-fetch.ts +131 -0
- package/packages/queryable/behaviors/caching-pessimistic.ts +67 -0
- package/packages/queryable/behaviors/caching.ts +149 -0
- package/packages/queryable/behaviors/cancelable.ts +264 -0
- package/packages/queryable/behaviors/inject-headers.ts +23 -0
- package/packages/queryable/behaviors/parsers.ts +134 -0
- package/packages/queryable/behaviors/resolvers.ts +28 -0
- package/packages/queryable/behaviors/timeout.ts +24 -0
- package/packages/queryable/index.ts +19 -0
- package/packages/queryable/invokable.ts +42 -0
- package/packages/queryable/operations.ts +32 -0
- package/packages/queryable/package.json +11 -0
- package/packages/queryable/queryable-factory.ts +19 -0
- package/packages/queryable/queryable.ts +239 -0
- package/packages/queryable/request-builders.ts +20 -0
- package/packages/queryable/tsconfig.json +11 -0
- package/packages/readme.md +21 -0
- package/packages/sp/appcatalog/index.ts +35 -0
- package/packages/sp/appcatalog/types.ts +176 -0
- package/packages/sp/appcatalog/web.ts +19 -0
- package/packages/sp/attachments/index.ts +11 -0
- package/packages/sp/attachments/item.ts +17 -0
- package/packages/sp/attachments/types.ts +95 -0
- package/packages/sp/batching.ts +483 -0
- package/packages/sp/behaviors/defaults.ts +38 -0
- package/packages/sp/behaviors/request-digest.ts +78 -0
- package/packages/sp/behaviors/spbrowser.ts +40 -0
- package/packages/sp/behaviors/spfx.ts +83 -0
- package/packages/sp/behaviors/telemetry.ts +35 -0
- package/packages/sp/clientside-pages/funcs.ts +27 -0
- package/packages/sp/clientside-pages/index.ts +27 -0
- package/packages/sp/clientside-pages/types.ts +1661 -0
- package/packages/sp/clientside-pages/web.ts +93 -0
- package/packages/sp/column-defaults/folder.ts +89 -0
- package/packages/sp/column-defaults/index.ts +8 -0
- package/packages/sp/column-defaults/list.ts +219 -0
- package/packages/sp/column-defaults/types.ts +19 -0
- package/packages/sp/comments/clientside-page.ts +120 -0
- package/packages/sp/comments/index.ts +14 -0
- package/packages/sp/comments/item.ts +77 -0
- package/packages/sp/comments/types.ts +160 -0
- package/packages/sp/content-types/index.ts +17 -0
- package/packages/sp/content-types/item.ts +17 -0
- package/packages/sp/content-types/list.ts +17 -0
- package/packages/sp/content-types/types.ts +181 -0
- package/packages/sp/content-types/web.ts +17 -0
- package/packages/sp/context-info/index.ts +40 -0
- package/packages/sp/decorators.ts +18 -0
- package/packages/sp/favorites/index.ts +32 -0
- package/packages/sp/favorites/types.ts +187 -0
- package/packages/sp/features/index.ts +11 -0
- package/packages/sp/features/site.ts +17 -0
- package/packages/sp/features/types.ts +73 -0
- package/packages/sp/features/web.ts +17 -0
- package/packages/sp/fi.ts +46 -0
- package/packages/sp/fields/index.ts +22 -0
- package/packages/sp/fields/list.ts +17 -0
- package/packages/sp/fields/types.ts +648 -0
- package/packages/sp/fields/web.ts +23 -0
- package/packages/sp/files/folder.ts +17 -0
- package/packages/sp/files/index.ts +25 -0
- package/packages/sp/files/item.ts +17 -0
- package/packages/sp/files/readable-file.ts +40 -0
- package/packages/sp/files/types.ts +771 -0
- package/packages/sp/files/web.ts +46 -0
- package/packages/sp/folders/index.ts +19 -0
- package/packages/sp/folders/item.ts +16 -0
- package/packages/sp/folders/list.ts +17 -0
- package/packages/sp/folders/types.ts +439 -0
- package/packages/sp/folders/web.ts +50 -0
- package/packages/sp/forms/index.ts +9 -0
- package/packages/sp/forms/list.ts +14 -0
- package/packages/sp/forms/types.ts +41 -0
- package/packages/sp/groupsitemanager/index.ts +18 -0
- package/packages/sp/groupsitemanager/types.ts +433 -0
- package/packages/sp/hubsites/index.ts +31 -0
- package/packages/sp/hubsites/site.ts +43 -0
- package/packages/sp/hubsites/types.ts +71 -0
- package/packages/sp/hubsites/web.ts +38 -0
- package/packages/sp/index.ts +24 -0
- package/packages/sp/items/get-all.ts +52 -0
- package/packages/sp/items/index.ts +18 -0
- package/packages/sp/items/list.ts +14 -0
- package/packages/sp/items/types.ts +405 -0
- package/packages/sp/lists/index.ts +23 -0
- package/packages/sp/lists/types.ts +851 -0
- package/packages/sp/lists/web.ts +68 -0
- package/packages/sp/navigation/index.ts +35 -0
- package/packages/sp/navigation/types.ts +243 -0
- package/packages/sp/navigation/web.ts +19 -0
- package/packages/sp/operations.ts +33 -0
- package/packages/sp/package.json +15 -0
- package/packages/sp/post-install.cjs +20 -0
- package/packages/sp/presets/all.ts +75 -0
- package/packages/sp/profiles/index.ts +30 -0
- package/packages/sp/profiles/types.ts +595 -0
- package/packages/sp/publishing-sitepageservice/index.ts +22 -0
- package/packages/sp/publishing-sitepageservice/types.ts +18 -0
- package/packages/sp/recycle-bin/index.ts +36 -0
- package/packages/sp/recycle-bin/types.ts +113 -0
- package/packages/sp/regional-settings/content-type.ts +11 -0
- package/packages/sp/regional-settings/field.ts +11 -0
- package/packages/sp/regional-settings/funcs.ts +10 -0
- package/packages/sp/regional-settings/index.ts +18 -0
- package/packages/sp/regional-settings/list.ts +11 -0
- package/packages/sp/regional-settings/types.ts +159 -0
- package/packages/sp/regional-settings/user-custom-actions.ts +11 -0
- package/packages/sp/regional-settings/web.ts +21 -0
- package/packages/sp/related-items/index.ts +7 -0
- package/packages/sp/related-items/types.ts +194 -0
- package/packages/sp/related-items/web.ts +22 -0
- package/packages/sp/search/index.ts +48 -0
- package/packages/sp/search/query.ts +254 -0
- package/packages/sp/search/suggest.ts +130 -0
- package/packages/sp/search/types.ts +480 -0
- package/packages/sp/security/funcs.ts +94 -0
- package/packages/sp/security/index.ts +21 -0
- package/packages/sp/security/item.ts +29 -0
- package/packages/sp/security/list.ts +29 -0
- package/packages/sp/security/types.ts +440 -0
- package/packages/sp/security/web.ts +34 -0
- package/packages/sp/sharing/file.ts +75 -0
- package/packages/sp/sharing/folder.ts +69 -0
- package/packages/sp/sharing/funcs.ts +258 -0
- package/packages/sp/sharing/index.ts +27 -0
- package/packages/sp/sharing/item.ts +53 -0
- package/packages/sp/sharing/types.ts +626 -0
- package/packages/sp/sharing/web.ts +109 -0
- package/packages/sp/site-designs/index.ts +29 -0
- package/packages/sp/site-designs/types.ts +456 -0
- package/packages/sp/site-designs/web.ts +41 -0
- package/packages/sp/site-groups/index.ts +11 -0
- package/packages/sp/site-groups/types.ts +133 -0
- package/packages/sp/site-groups/web.ts +73 -0
- package/packages/sp/site-scripts/index.ts +27 -0
- package/packages/sp/site-scripts/list.ts +27 -0
- package/packages/sp/site-scripts/types.ts +243 -0
- package/packages/sp/site-scripts/web.ts +24 -0
- package/packages/sp/site-users/index.ts +12 -0
- package/packages/sp/site-users/types.ts +195 -0
- package/packages/sp/site-users/web.ts +56 -0
- package/packages/sp/sites/index.ts +26 -0
- package/packages/sp/sites/types.ts +422 -0
- package/packages/sp/social/index.ts +33 -0
- package/packages/sp/social/types.ts +381 -0
- package/packages/sp/spqueryable.ts +244 -0
- package/packages/sp/sputilities/index.ts +23 -0
- package/packages/sp/sputilities/types.ts +197 -0
- package/packages/sp/subscriptions/index.ts +10 -0
- package/packages/sp/subscriptions/list.ts +18 -0
- package/packages/sp/subscriptions/types.ts +107 -0
- package/packages/sp/taxonomy/index.ts +50 -0
- package/packages/sp/taxonomy/types.ts +508 -0
- package/packages/sp/tsconfig.json +16 -0
- package/packages/sp/types.ts +283 -0
- package/packages/sp/user-custom-actions/index.ts +15 -0
- package/packages/sp/user-custom-actions/list.ts +18 -0
- package/packages/sp/user-custom-actions/site.ts +18 -0
- package/packages/sp/user-custom-actions/types.ts +133 -0
- package/packages/sp/user-custom-actions/web.ts +21 -0
- package/packages/sp/utils/encode-path-str.ts +29 -0
- package/packages/sp/utils/extract-web-url.ts +21 -0
- package/packages/sp/utils/file-names.ts +35 -0
- package/packages/sp/utils/metadata.ts +5 -0
- package/packages/sp/utils/odata-url-from.ts +42 -0
- package/packages/sp/utils/to-resource-path.ts +9 -0
- package/packages/sp/views/index.ts +14 -0
- package/packages/sp/views/list.ts +33 -0
- package/packages/sp/views/types.ts +210 -0
- package/packages/sp/webparts/file.ts +21 -0
- package/packages/sp/webparts/index.ts +11 -0
- package/packages/sp/webparts/types.ts +141 -0
- package/packages/sp/webs/index.ts +32 -0
- package/packages/sp/webs/types.ts +350 -0
- package/packages/sp-admin/index.ts +46 -0
- package/packages/sp-admin/office-tenant.ts +567 -0
- package/packages/sp-admin/package.json +13 -0
- package/packages/sp-admin/site-properties.ts +45 -0
- package/packages/sp-admin/tenant.ts +595 -0
- package/packages/sp-admin/tsconfig.json +20 -0
- package/packages/sp-admin/types.ts +1679 -0
- package/packages/tsconfig-watch.json +9 -0
- package/packages/tsconfig.json +37 -0
- package/pre-install.cjs +1 -0
- package/samples/custom-bundle-webpack/index.ts +33 -0
- package/samples/custom-bundle-webpack/package-lock.json +4601 -0
- package/samples/custom-bundle-webpack/package.json +18 -0
- package/samples/custom-bundle-webpack/readme.md +102 -0
- package/samples/custom-bundle-webpack/tsconfig.json +12 -0
- package/samples/custom-bundle-webpack/webpack.config.js +27 -0
- package/samples/nodejs-app/.vscode/launch.json +27 -0
- package/samples/nodejs-app/.vscode/settings.json +10 -0
- package/samples/nodejs-app/.vscode/tasks.json +22 -0
- package/samples/nodejs-app/index.ts +63 -0
- package/samples/nodejs-app/package-lock.json +259 -0
- package/samples/nodejs-app/package.json +21 -0
- package/samples/nodejs-app/readme.md +140 -0
- package/samples/nodejs-app/tsconfig.json +14 -0
- package/samples/nodejs-commonjs/package-lock.json +702 -0
- package/samples/nodejs-commonjs/package.json +21 -0
- package/samples/nodejs-commonjs/readme.md +58 -0
- package/samples/nodejs-commonjs/src/index.ts +23 -0
- package/samples/nodejs-commonjs/src/settings.ts +35 -0
- package/samples/nodejs-commonjs/tsconfig.json +35 -0
- package/samples/project-preset/README.md +73 -0
- package/samples/project-preset/package-lock.json +21097 -0
- package/samples/project-preset/package.json +29 -0
- package/samples/project-preset/teams/4530a515-8ba7-45bb-9a27-be06b33c59d4_color.png +0 -0
- package/samples/project-preset/teams/4530a515-8ba7-45bb-9a27-be06b33c59d4_outline.png +0 -0
- package/samples/readme.md +16 -0
- package/settings.example.js +57 -0
- package/test/args.ts +107 -0
- package/test/clean-subsite.ts +36 -0
- package/test/core/assumptions.ts +99 -0
- package/test/core/storage.ts +60 -0
- package/test/core/timeline.ts +205 -0
- package/test/core/util.ts +205 -0
- package/test/graph/assets/testconvert.docx +0 -0
- package/test/graph/batch.ts +125 -0
- package/test/graph/calendars.ts +234 -0
- package/test/graph/columns.ts +247 -0
- package/test/graph/contacts.ts +254 -0
- package/test/graph/content-types.ts +206 -0
- package/test/graph/directoryobjects.ts +115 -0
- package/test/graph/groups.ts +130 -0
- package/test/graph/lists.ts +72 -0
- package/test/graph/onedrive.ts +365 -0
- package/test/graph/outlook.ts +95 -0
- package/test/graph/paging.ts +91 -0
- package/test/graph/planner.ts +160 -0
- package/test/graph/querable.ts +97 -0
- package/test/graph/search.ts +4 -0
- package/test/graph/shares.ts +26 -0
- package/test/graph/sites.ts +40 -0
- package/test/graph/teams.ts +76 -0
- package/test/graph/utilities/getTestingGraphSPSite.ts +27 -0
- package/test/graph/utilities/getValidUser.ts +37 -0
- package/test/load-settings.ts +103 -0
- package/test/logging/logging.ts +86 -0
- package/test/mocha-root-hooks.ts +227 -0
- package/test/nodejs/sp-extensions.ts +86 -0
- package/test/pnp-test.ts +60 -0
- package/test/queryable/add-prop.ts +24 -0
- package/test/queryable/behaviors.ts +188 -0
- package/test/queryable/invokable.ts +35 -0
- package/test/queryable/queryable.ts +118 -0
- package/test/sp/alias.ts +46 -0
- package/test/sp/appcatalog.ts +142 -0
- package/test/sp/assets/helloworld.sppkg +0 -0
- package/test/sp/assets/sample_file.jpg +0 -0
- package/test/sp/attachments.ts +134 -0
- package/test/sp/batch.ts +362 -0
- package/test/sp/clientside-pages.ts +426 -0
- package/test/sp/column-defaults.ts +225 -0
- package/test/sp/comments.ts +202 -0
- package/test/sp/content-types.ts +68 -0
- package/test/sp/favorites.ts +2 -0
- package/test/sp/features.ts +201 -0
- package/test/sp/fields.ts +396 -0
- package/test/sp/files.ts +338 -0
- package/test/sp/folders.ts +242 -0
- package/test/sp/forms.ts +22 -0
- package/test/sp/groupsitemanager.ts +88 -0
- package/test/sp/hubsites.ts +41 -0
- package/test/sp/items.ts +179 -0
- package/test/sp/lists.ts +319 -0
- package/test/sp/navigation.ts +167 -0
- package/test/sp/profiles.ts +2 -0
- package/test/sp/query-escaping.ts +94 -0
- package/test/sp/recycle-bin.ts +1 -0
- package/test/sp/regional-settings.ts +58 -0
- package/test/sp/related-items.ts +94 -0
- package/test/sp/search.ts +39 -0
- package/test/sp/security.ts +90 -0
- package/test/sp/sharing.ts +313 -0
- package/test/sp/site-designs.ts +224 -0
- package/test/sp/site-groups.ts +98 -0
- package/test/sp/site-scripts.ts +162 -0
- package/test/sp/site-users.ts +93 -0
- package/test/sp/sites.ts +156 -0
- package/test/sp/social.ts +2 -0
- package/test/sp/spfx.ts +52 -0
- package/test/sp/sputilities.ts +78 -0
- package/test/sp/subscriptions.ts +64 -0
- package/test/sp/taxonomy.ts +178 -0
- package/test/sp/user-custom-actions.ts +31 -0
- package/test/sp/views.ts +117 -0
- package/test/sp/webparts.ts +38 -0
- package/test/sp/webs.ts +249 -0
- package/test/test-invokable-props.ts +35 -0
- package/test/test-props.ts +90 -0
- package/test/test-recording.ts +171 -0
- package/test/tsconfig.json +18 -0
- package/tools/buildsystem/package-lock.json +4404 -0
- package/tools/buildsystem/package.json +56 -0
- package/tools/buildsystem/readme.md +23 -0
- package/tools/config.js +34 -0
- package/tools/local-module-resolver/cjs.ts +33 -0
- package/tools/local-module-resolver/esm-debug.ts +2 -0
- package/tools/local-module-resolver/esm-test.ts +2 -0
- package/tools/local-module-resolver/esm.ts +112 -0
- package/tools/local-module-resolver/readme.md +8 -0
- package/tsconfig.buildsystem.json +17 -0
- package/tsconfig.json +42 -0
@@ -0,0 +1,2031 @@
|
|
1
|
+
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
<!DOCTYPE html>
|
6
|
+
<html lang="en" class="no-js">
|
7
|
+
<head>
|
8
|
+
|
9
|
+
<meta charset="utf-8">
|
10
|
+
<meta name="viewport" content="width=device-width,initial-scale=1">
|
11
|
+
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
12
|
+
|
13
|
+
|
14
|
+
<link rel="canonical" href="https://pnp.github.io/pnpjs/sp/docs/client-side-pages/">
|
15
|
+
|
16
|
+
|
17
|
+
|
18
|
+
<meta name="lang:clipboard.copy" content="Copy to clipboard">
|
19
|
+
|
20
|
+
<meta name="lang:clipboard.copied" content="Copied to clipboard">
|
21
|
+
|
22
|
+
<meta name="lang:search.language" content="en">
|
23
|
+
|
24
|
+
<meta name="lang:search.pipeline.stopwords" content="True">
|
25
|
+
|
26
|
+
<meta name="lang:search.pipeline.trimmer" content="True">
|
27
|
+
|
28
|
+
<meta name="lang:search.result.none" content="No matching documents">
|
29
|
+
|
30
|
+
<meta name="lang:search.result.one" content="1 matching document">
|
31
|
+
|
32
|
+
<meta name="lang:search.result.other" content="# matching documents">
|
33
|
+
|
34
|
+
<meta name="lang:search.tokenizer" content="[\s\-]+">
|
35
|
+
|
36
|
+
<link rel="shortcut icon" href="../../../assets/images/favicon.png">
|
37
|
+
<meta name="generator" content="mkdocs-1.0.1, mkdocs-material-3.0.3">
|
38
|
+
|
39
|
+
|
40
|
+
|
41
|
+
<title>Client-side Pages - PnP/PnPjs</title>
|
42
|
+
|
43
|
+
|
44
|
+
|
45
|
+
<link rel="stylesheet" href="../../../assets/stylesheets/application.451f80e5.css">
|
46
|
+
|
47
|
+
<link rel="stylesheet" href="../../../assets/stylesheets/application-palette.22915126.css">
|
48
|
+
|
49
|
+
|
50
|
+
|
51
|
+
|
52
|
+
<meta name="theme-color" content="#2196f3">
|
53
|
+
|
54
|
+
|
55
|
+
|
56
|
+
<script src="../../../assets/javascripts/modernizr.1aa3b519.js"></script>
|
57
|
+
|
58
|
+
|
59
|
+
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
|
60
|
+
|
61
|
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
|
62
|
+
<style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
|
63
|
+
|
64
|
+
|
65
|
+
<link rel="stylesheet" href="../../../assets/fonts/material-icons.css">
|
66
|
+
|
67
|
+
<link rel="stylesheet" href="../../../documentation/css/extra.css">
|
68
|
+
|
69
|
+
|
70
|
+
</head>
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
<body dir="ltr" data-md-color-primary="blue" data-md-color-accent="">
|
75
|
+
|
76
|
+
<svg class="md-svg">
|
77
|
+
<defs>
|
78
|
+
|
79
|
+
|
80
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448"
|
81
|
+
viewBox="0 0 416 448" id="__github">
|
82
|
+
<path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125
|
83
|
+
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5
|
84
|
+
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75
|
85
|
+
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19
|
86
|
+
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360
|
87
|
+
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25
|
88
|
+
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8
|
89
|
+
38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0
|
90
|
+
37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25
|
91
|
+
82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75
|
92
|
+
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75
|
93
|
+
0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25
|
94
|
+
30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5
|
95
|
+
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34
|
96
|
+
99.5z" />
|
97
|
+
</svg>
|
98
|
+
|
99
|
+
</defs>
|
100
|
+
</svg>
|
101
|
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
102
|
+
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
103
|
+
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
|
104
|
+
|
105
|
+
<a href="../../../#pnpspclientsidepages" tabindex="1" class="md-skip">
|
106
|
+
Skip to content
|
107
|
+
</a>
|
108
|
+
|
109
|
+
|
110
|
+
<header class="md-header" data-md-component="header">
|
111
|
+
<nav class="md-header-nav md-grid">
|
112
|
+
<div class="md-flex">
|
113
|
+
<div class="md-flex__cell md-flex__cell--shrink">
|
114
|
+
<a href="https://pnp.github.io/pnpjs/" title="PnP/PnPjs" class="md-header-nav__button md-logo">
|
115
|
+
|
116
|
+
<img src="../../../documentation/img/Logo.png" width="24" height="24">
|
117
|
+
|
118
|
+
</a>
|
119
|
+
</div>
|
120
|
+
<div class="md-flex__cell md-flex__cell--shrink">
|
121
|
+
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
|
122
|
+
</div>
|
123
|
+
<div class="md-flex__cell md-flex__cell--stretch">
|
124
|
+
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
|
125
|
+
|
126
|
+
|
127
|
+
<span class="md-header-nav__topic">
|
128
|
+
PnP/PnPjs
|
129
|
+
</span>
|
130
|
+
<span class="md-header-nav__topic">
|
131
|
+
Client-side Pages
|
132
|
+
</span>
|
133
|
+
|
134
|
+
|
135
|
+
</div>
|
136
|
+
</div>
|
137
|
+
<div class="md-flex__cell md-flex__cell--shrink">
|
138
|
+
|
139
|
+
|
140
|
+
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
|
141
|
+
|
142
|
+
<div class="md-search" data-md-component="search" role="dialog">
|
143
|
+
<label class="md-search__overlay" for="__search"></label>
|
144
|
+
<div class="md-search__inner" role="search">
|
145
|
+
<form class="md-search__form" name="search">
|
146
|
+
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
|
147
|
+
<label class="md-icon md-search__icon" for="__search"></label>
|
148
|
+
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
|
149
|
+

|
150
|
+
</button>
|
151
|
+
</form>
|
152
|
+
<div class="md-search__output">
|
153
|
+
<div class="md-search__scrollwrap" data-md-scrollfix>
|
154
|
+
<div class="md-search-result" data-md-component="result">
|
155
|
+
<div class="md-search-result__meta">
|
156
|
+
Type to start searching
|
157
|
+
</div>
|
158
|
+
<ol class="md-search-result__list"></ol>
|
159
|
+
</div>
|
160
|
+
</div>
|
161
|
+
</div>
|
162
|
+
</div>
|
163
|
+
</div>
|
164
|
+
|
165
|
+
|
166
|
+
</div>
|
167
|
+
|
168
|
+
<div class="md-flex__cell md-flex__cell--shrink">
|
169
|
+
<div class="md-header-nav__source">
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
<a href="http://github.com/pnp/pnpjs/" title="Go to repository" class="md-source" data-md-source="github">
|
177
|
+
|
178
|
+
<div class="md-source__icon">
|
179
|
+
<svg viewBox="0 0 24 24" width="24" height="24">
|
180
|
+
<use xlink:href="#__github" width="24" height="24"></use>
|
181
|
+
</svg>
|
182
|
+
</div>
|
183
|
+
|
184
|
+
<div class="md-source__repository">
|
185
|
+
GitHub
|
186
|
+
</div>
|
187
|
+
</a>
|
188
|
+
|
189
|
+
</div>
|
190
|
+
</div>
|
191
|
+
|
192
|
+
</div>
|
193
|
+
</nav>
|
194
|
+
</header>
|
195
|
+
|
196
|
+
<div class="md-container">
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
<nav class="md-tabs md-tabs--active" data-md-component="tabs">
|
206
|
+
<div class="md-tabs__inner md-grid">
|
207
|
+
<ul class="md-tabs__list">
|
208
|
+
|
209
|
+
|
210
|
+
<li class="md-tabs__item">
|
211
|
+
|
212
|
+
<a href="../../.." title="Home" class="md-tabs__link">
|
213
|
+
Home
|
214
|
+
</a>
|
215
|
+
|
216
|
+
</li>
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
<li class="md-tabs__item">
|
227
|
+
|
228
|
+
<a href="../../../documentation/getting-started/" title="General" class="md-tabs__link">
|
229
|
+
General
|
230
|
+
</a>
|
231
|
+
|
232
|
+
</li>
|
233
|
+
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
<li class="md-tabs__item">
|
240
|
+
|
241
|
+
<a href="../../../documentation/packages/" title="Packages" class="md-tabs__link md-tabs__link--active">
|
242
|
+
Packages
|
243
|
+
</a>
|
244
|
+
|
245
|
+
</li>
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
</ul>
|
250
|
+
</div>
|
251
|
+
</nav>
|
252
|
+
|
253
|
+
<main class="md-main">
|
254
|
+
<div class="md-main__inner md-grid" data-md-component="container">
|
255
|
+
|
256
|
+
|
257
|
+
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
|
258
|
+
<div class="md-sidebar__scrollwrap">
|
259
|
+
<div class="md-sidebar__inner">
|
260
|
+
<nav class="md-nav md-nav--primary" data-md-level="0">
|
261
|
+
<label class="md-nav__title md-nav__title--site" for="__drawer">
|
262
|
+
<a href="https://pnp.github.io/pnpjs/" title="PnP/PnPjs" class="md-nav__button md-logo">
|
263
|
+
|
264
|
+
<img src="../../../documentation/img/Logo.png" width="48" height="48">
|
265
|
+
|
266
|
+
</a>
|
267
|
+
PnP/PnPjs
|
268
|
+
</label>
|
269
|
+
|
270
|
+
<div class="md-nav__source">
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
<a href="http://github.com/pnp/pnpjs/" title="Go to repository" class="md-source" data-md-source="github">
|
278
|
+
|
279
|
+
<div class="md-source__icon">
|
280
|
+
<svg viewBox="0 0 24 24" width="24" height="24">
|
281
|
+
<use xlink:href="#__github" width="24" height="24"></use>
|
282
|
+
</svg>
|
283
|
+
</div>
|
284
|
+
|
285
|
+
<div class="md-source__repository">
|
286
|
+
GitHub
|
287
|
+
</div>
|
288
|
+
</a>
|
289
|
+
|
290
|
+
</div>
|
291
|
+
|
292
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
|
297
|
+
|
298
|
+
|
299
|
+
<li class="md-nav__item">
|
300
|
+
<a href="../../.." title="Home" class="md-nav__link">
|
301
|
+
Home
|
302
|
+
</a>
|
303
|
+
</li>
|
304
|
+
|
305
|
+
|
306
|
+
|
307
|
+
|
308
|
+
|
309
|
+
|
310
|
+
|
311
|
+
<li class="md-nav__item">
|
312
|
+
<a href="../../../documentation/getting-started/" title="Getting Started" class="md-nav__link">
|
313
|
+
Getting Started
|
314
|
+
</a>
|
315
|
+
</li>
|
316
|
+
|
317
|
+
|
318
|
+
|
319
|
+
|
320
|
+
|
321
|
+
|
322
|
+
|
323
|
+
<li class="md-nav__item">
|
324
|
+
<a href="../../../documentation/transition-guide/" title="Transition Guide" class="md-nav__link">
|
325
|
+
Transition Guide
|
326
|
+
</a>
|
327
|
+
</li>
|
328
|
+
|
329
|
+
|
330
|
+
|
331
|
+
|
332
|
+
|
333
|
+
|
334
|
+
|
335
|
+
<li class="md-nav__item md-nav__item--nested">
|
336
|
+
|
337
|
+
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
|
338
|
+
|
339
|
+
<label class="md-nav__link" for="nav-4">
|
340
|
+
General
|
341
|
+
</label>
|
342
|
+
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
343
|
+
<label class="md-nav__title" for="nav-4">
|
344
|
+
General
|
345
|
+
</label>
|
346
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
347
|
+
|
348
|
+
|
349
|
+
|
350
|
+
|
351
|
+
|
352
|
+
|
353
|
+
|
354
|
+
<li class="md-nav__item">
|
355
|
+
<a href="../../../documentation/getting-started/" title="Getting Started" class="md-nav__link">
|
356
|
+
Getting Started
|
357
|
+
</a>
|
358
|
+
</li>
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
|
363
|
+
|
364
|
+
|
365
|
+
|
366
|
+
<li class="md-nav__item">
|
367
|
+
<a href="../../../documentation/getting-started-dev/" title="Getting Started Contributing" class="md-nav__link">
|
368
|
+
Getting Started Contributing
|
369
|
+
</a>
|
370
|
+
</li>
|
371
|
+
|
372
|
+
|
373
|
+
|
374
|
+
|
375
|
+
|
376
|
+
|
377
|
+
|
378
|
+
<li class="md-nav__item">
|
379
|
+
<a href="../../../documentation/gulp-commands/" title="Gulp Commands" class="md-nav__link">
|
380
|
+
Gulp Commands
|
381
|
+
</a>
|
382
|
+
</li>
|
383
|
+
|
384
|
+
|
385
|
+
|
386
|
+
|
387
|
+
|
388
|
+
|
389
|
+
|
390
|
+
<li class="md-nav__item">
|
391
|
+
<a href="../../../documentation/debugging/" title="Debugging" class="md-nav__link">
|
392
|
+
Debugging
|
393
|
+
</a>
|
394
|
+
</li>
|
395
|
+
|
396
|
+
|
397
|
+
|
398
|
+
|
399
|
+
|
400
|
+
|
401
|
+
|
402
|
+
<li class="md-nav__item">
|
403
|
+
<a href="../../../documentation/documentation/" title="Building Docs" class="md-nav__link">
|
404
|
+
Building Docs
|
405
|
+
</a>
|
406
|
+
</li>
|
407
|
+
|
408
|
+
|
409
|
+
|
410
|
+
|
411
|
+
|
412
|
+
|
413
|
+
|
414
|
+
<li class="md-nav__item">
|
415
|
+
<a href="../../../documentation/deployment/" title="Deployment" class="md-nav__link">
|
416
|
+
Deployment
|
417
|
+
</a>
|
418
|
+
</li>
|
419
|
+
|
420
|
+
|
421
|
+
|
422
|
+
|
423
|
+
|
424
|
+
|
425
|
+
|
426
|
+
<li class="md-nav__item">
|
427
|
+
<a href="../../../documentation/beta-versions/" title="Install Beta Versions" class="md-nav__link">
|
428
|
+
Install Beta Versions
|
429
|
+
</a>
|
430
|
+
</li>
|
431
|
+
|
432
|
+
|
433
|
+
|
434
|
+
|
435
|
+
|
436
|
+
|
437
|
+
|
438
|
+
<li class="md-nav__item">
|
439
|
+
<a href="../../../documentation/polyfill/" title="Polyfills" class="md-nav__link">
|
440
|
+
Polyfills
|
441
|
+
</a>
|
442
|
+
</li>
|
443
|
+
|
444
|
+
|
445
|
+
|
446
|
+
|
447
|
+
|
448
|
+
|
449
|
+
|
450
|
+
<li class="md-nav__item">
|
451
|
+
<a href="../../../documentation/package-structure/" title="Package Structure" class="md-nav__link">
|
452
|
+
Package Structure
|
453
|
+
</a>
|
454
|
+
</li>
|
455
|
+
|
456
|
+
|
457
|
+
|
458
|
+
|
459
|
+
|
460
|
+
|
461
|
+
|
462
|
+
<li class="md-nav__item">
|
463
|
+
<a href="../../../documentation/SPFx-On-Premesis-2016/" title="SPFx On-Premises 2016" class="md-nav__link">
|
464
|
+
SPFx On-Premises 2016
|
465
|
+
</a>
|
466
|
+
</li>
|
467
|
+
|
468
|
+
|
469
|
+
|
470
|
+
|
471
|
+
|
472
|
+
|
473
|
+
|
474
|
+
<li class="md-nav__item">
|
475
|
+
<a href="../../../documentation/transition-guide/" title="Transition Guide" class="md-nav__link">
|
476
|
+
Transition Guide
|
477
|
+
</a>
|
478
|
+
</li>
|
479
|
+
|
480
|
+
|
481
|
+
</ul>
|
482
|
+
</nav>
|
483
|
+
</li>
|
484
|
+
|
485
|
+
|
486
|
+
|
487
|
+
|
488
|
+
|
489
|
+
|
490
|
+
|
491
|
+
|
492
|
+
|
493
|
+
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
494
|
+
|
495
|
+
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" checked>
|
496
|
+
|
497
|
+
<label class="md-nav__link" for="nav-5">
|
498
|
+
Packages
|
499
|
+
</label>
|
500
|
+
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
501
|
+
<label class="md-nav__title" for="nav-5">
|
502
|
+
Packages
|
503
|
+
</label>
|
504
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
505
|
+
|
506
|
+
|
507
|
+
|
508
|
+
|
509
|
+
|
510
|
+
|
511
|
+
|
512
|
+
<li class="md-nav__item">
|
513
|
+
<a href="../../../documentation/packages/" title="Packages" class="md-nav__link">
|
514
|
+
Packages
|
515
|
+
</a>
|
516
|
+
</li>
|
517
|
+
|
518
|
+
|
519
|
+
|
520
|
+
|
521
|
+
|
522
|
+
|
523
|
+
|
524
|
+
<li class="md-nav__item md-nav__item--nested">
|
525
|
+
|
526
|
+
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-2" type="checkbox" id="nav-5-2">
|
527
|
+
|
528
|
+
<label class="md-nav__link" for="nav-5-2">
|
529
|
+
common
|
530
|
+
</label>
|
531
|
+
<nav class="md-nav" data-md-component="collapsible" data-md-level="2">
|
532
|
+
<label class="md-nav__title" for="nav-5-2">
|
533
|
+
common
|
534
|
+
</label>
|
535
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
536
|
+
|
537
|
+
|
538
|
+
|
539
|
+
|
540
|
+
|
541
|
+
|
542
|
+
|
543
|
+
<li class="md-nav__item">
|
544
|
+
<a href="../../../common/docs/" title="common" class="md-nav__link">
|
545
|
+
common
|
546
|
+
</a>
|
547
|
+
</li>
|
548
|
+
|
549
|
+
|
550
|
+
|
551
|
+
|
552
|
+
|
553
|
+
|
554
|
+
|
555
|
+
<li class="md-nav__item">
|
556
|
+
<a href="../../../common/docs/adalclient/" title="adalclient" class="md-nav__link">
|
557
|
+
adalclient
|
558
|
+
</a>
|
559
|
+
</li>
|
560
|
+
|
561
|
+
|
562
|
+
|
563
|
+
|
564
|
+
|
565
|
+
|
566
|
+
|
567
|
+
<li class="md-nav__item">
|
568
|
+
<a href="../../../common/docs/blobutil.md" title="blobutil" class="md-nav__link">
|
569
|
+
blobutil
|
570
|
+
</a>
|
571
|
+
</li>
|
572
|
+
|
573
|
+
|
574
|
+
|
575
|
+
|
576
|
+
|
577
|
+
|
578
|
+
|
579
|
+
<li class="md-nav__item">
|
580
|
+
<a href="../../../common/docs/collections/" title="collections" class="md-nav__link">
|
581
|
+
collections
|
582
|
+
</a>
|
583
|
+
</li>
|
584
|
+
|
585
|
+
|
586
|
+
|
587
|
+
|
588
|
+
|
589
|
+
|
590
|
+
|
591
|
+
<li class="md-nav__item">
|
592
|
+
<a href="../../../common/docs/custom-httpclientimpl/" title="Custom HttpClientImpl" class="md-nav__link">
|
593
|
+
Custom HttpClientImpl
|
594
|
+
</a>
|
595
|
+
</li>
|
596
|
+
|
597
|
+
|
598
|
+
|
599
|
+
|
600
|
+
|
601
|
+
|
602
|
+
|
603
|
+
<li class="md-nav__item">
|
604
|
+
<a href="../../../common/docs/libconfig/" title="libconfig" class="md-nav__link">
|
605
|
+
libconfig
|
606
|
+
</a>
|
607
|
+
</li>
|
608
|
+
|
609
|
+
|
610
|
+
|
611
|
+
|
612
|
+
|
613
|
+
|
614
|
+
|
615
|
+
<li class="md-nav__item">
|
616
|
+
<a href="../../../common/docs/netutil/" title="netutil" class="md-nav__link">
|
617
|
+
netutil
|
618
|
+
</a>
|
619
|
+
</li>
|
620
|
+
|
621
|
+
|
622
|
+
|
623
|
+
|
624
|
+
|
625
|
+
|
626
|
+
|
627
|
+
<li class="md-nav__item">
|
628
|
+
<a href="../../../common/docs/storage/" title="storage" class="md-nav__link">
|
629
|
+
storage
|
630
|
+
</a>
|
631
|
+
</li>
|
632
|
+
|
633
|
+
|
634
|
+
|
635
|
+
|
636
|
+
|
637
|
+
|
638
|
+
|
639
|
+
<li class="md-nav__item">
|
640
|
+
<a href="../../../common/docs/util/" title="util" class="md-nav__link">
|
641
|
+
util
|
642
|
+
</a>
|
643
|
+
</li>
|
644
|
+
|
645
|
+
|
646
|
+
</ul>
|
647
|
+
</nav>
|
648
|
+
</li>
|
649
|
+
|
650
|
+
|
651
|
+
|
652
|
+
|
653
|
+
|
654
|
+
|
655
|
+
|
656
|
+
<li class="md-nav__item md-nav__item--nested">
|
657
|
+
|
658
|
+
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-3" type="checkbox" id="nav-5-3">
|
659
|
+
|
660
|
+
<label class="md-nav__link" for="nav-5-3">
|
661
|
+
config-store
|
662
|
+
</label>
|
663
|
+
<nav class="md-nav" data-md-component="collapsible" data-md-level="2">
|
664
|
+
<label class="md-nav__title" for="nav-5-3">
|
665
|
+
config-store
|
666
|
+
</label>
|
667
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
668
|
+
|
669
|
+
|
670
|
+
|
671
|
+
|
672
|
+
|
673
|
+
|
674
|
+
|
675
|
+
<li class="md-nav__item">
|
676
|
+
<a href="../../../config-store/docs/" title="config-store" class="md-nav__link">
|
677
|
+
config-store
|
678
|
+
</a>
|
679
|
+
</li>
|
680
|
+
|
681
|
+
|
682
|
+
|
683
|
+
|
684
|
+
|
685
|
+
|
686
|
+
|
687
|
+
<li class="md-nav__item">
|
688
|
+
<a href="../../../config-store/docs/configuration/" title="configuration" class="md-nav__link">
|
689
|
+
configuration
|
690
|
+
</a>
|
691
|
+
</li>
|
692
|
+
|
693
|
+
|
694
|
+
|
695
|
+
|
696
|
+
|
697
|
+
|
698
|
+
|
699
|
+
<li class="md-nav__item">
|
700
|
+
<a href="../../../config-store/docs/providers/" title="providers" class="md-nav__link">
|
701
|
+
providers
|
702
|
+
</a>
|
703
|
+
</li>
|
704
|
+
|
705
|
+
|
706
|
+
</ul>
|
707
|
+
</nav>
|
708
|
+
</li>
|
709
|
+
|
710
|
+
|
711
|
+
|
712
|
+
|
713
|
+
|
714
|
+
|
715
|
+
|
716
|
+
<li class="md-nav__item md-nav__item--nested">
|
717
|
+
|
718
|
+
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-4" type="checkbox" id="nav-5-4">
|
719
|
+
|
720
|
+
<label class="md-nav__link" for="nav-5-4">
|
721
|
+
graph
|
722
|
+
</label>
|
723
|
+
<nav class="md-nav" data-md-component="collapsible" data-md-level="2">
|
724
|
+
<label class="md-nav__title" for="nav-5-4">
|
725
|
+
graph
|
726
|
+
</label>
|
727
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
728
|
+
|
729
|
+
|
730
|
+
|
731
|
+
|
732
|
+
|
733
|
+
|
734
|
+
|
735
|
+
<li class="md-nav__item">
|
736
|
+
<a href="../../../graph/docs/" title="graph" class="md-nav__link">
|
737
|
+
graph
|
738
|
+
</a>
|
739
|
+
</li>
|
740
|
+
|
741
|
+
|
742
|
+
|
743
|
+
|
744
|
+
|
745
|
+
|
746
|
+
|
747
|
+
<li class="md-nav__item">
|
748
|
+
<a href="../../../graph/docs/contacts/" title="contacts" class="md-nav__link">
|
749
|
+
contacts
|
750
|
+
</a>
|
751
|
+
</li>
|
752
|
+
|
753
|
+
|
754
|
+
|
755
|
+
|
756
|
+
|
757
|
+
|
758
|
+
|
759
|
+
<li class="md-nav__item">
|
760
|
+
<a href="../../../graph/docs/directoryobjects/" title="directory objects" class="md-nav__link">
|
761
|
+
directory objects
|
762
|
+
</a>
|
763
|
+
</li>
|
764
|
+
|
765
|
+
|
766
|
+
|
767
|
+
|
768
|
+
|
769
|
+
|
770
|
+
|
771
|
+
<li class="md-nav__item">
|
772
|
+
<a href="../../../graph/docs/invitations/" title="invitations" class="md-nav__link">
|
773
|
+
invitations
|
774
|
+
</a>
|
775
|
+
</li>
|
776
|
+
|
777
|
+
|
778
|
+
|
779
|
+
|
780
|
+
|
781
|
+
|
782
|
+
|
783
|
+
<li class="md-nav__item">
|
784
|
+
<a href="../../../graph/docs/onedrive/" title="onedrive" class="md-nav__link">
|
785
|
+
onedrive
|
786
|
+
</a>
|
787
|
+
</li>
|
788
|
+
|
789
|
+
|
790
|
+
|
791
|
+
|
792
|
+
|
793
|
+
|
794
|
+
|
795
|
+
<li class="md-nav__item">
|
796
|
+
<a href="../../../graph/docs/planner/" title="planner" class="md-nav__link">
|
797
|
+
planner
|
798
|
+
</a>
|
799
|
+
</li>
|
800
|
+
|
801
|
+
|
802
|
+
|
803
|
+
|
804
|
+
|
805
|
+
|
806
|
+
|
807
|
+
<li class="md-nav__item">
|
808
|
+
<a href="../../../graph/docs/subscriptions/" title="subscriptions" class="md-nav__link">
|
809
|
+
subscriptions
|
810
|
+
</a>
|
811
|
+
</li>
|
812
|
+
|
813
|
+
|
814
|
+
|
815
|
+
|
816
|
+
|
817
|
+
|
818
|
+
|
819
|
+
<li class="md-nav__item">
|
820
|
+
<a href="../../../graph/docs/teams/" title="teams" class="md-nav__link">
|
821
|
+
teams
|
822
|
+
</a>
|
823
|
+
</li>
|
824
|
+
|
825
|
+
|
826
|
+
</ul>
|
827
|
+
</nav>
|
828
|
+
</li>
|
829
|
+
|
830
|
+
|
831
|
+
|
832
|
+
|
833
|
+
|
834
|
+
|
835
|
+
|
836
|
+
<li class="md-nav__item">
|
837
|
+
<a href="../../../logging/docs/" title="logging" class="md-nav__link">
|
838
|
+
logging
|
839
|
+
</a>
|
840
|
+
</li>
|
841
|
+
|
842
|
+
|
843
|
+
|
844
|
+
|
845
|
+
|
846
|
+
|
847
|
+
|
848
|
+
<li class="md-nav__item md-nav__item--nested">
|
849
|
+
|
850
|
+
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-6" type="checkbox" id="nav-5-6">
|
851
|
+
|
852
|
+
<label class="md-nav__link" for="nav-5-6">
|
853
|
+
nodejs
|
854
|
+
</label>
|
855
|
+
<nav class="md-nav" data-md-component="collapsible" data-md-level="2">
|
856
|
+
<label class="md-nav__title" for="nav-5-6">
|
857
|
+
nodejs
|
858
|
+
</label>
|
859
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
860
|
+
|
861
|
+
|
862
|
+
|
863
|
+
|
864
|
+
|
865
|
+
|
866
|
+
|
867
|
+
<li class="md-nav__item">
|
868
|
+
<a href="../../../nodejs/docs/" title="nodejs" class="md-nav__link">
|
869
|
+
nodejs
|
870
|
+
</a>
|
871
|
+
</li>
|
872
|
+
|
873
|
+
|
874
|
+
|
875
|
+
|
876
|
+
|
877
|
+
|
878
|
+
|
879
|
+
<li class="md-nav__item">
|
880
|
+
<a href="../../../nodejs/docs/adal-fetch-client/" title="AdalFetchClient" class="md-nav__link">
|
881
|
+
AdalFetchClient
|
882
|
+
</a>
|
883
|
+
</li>
|
884
|
+
|
885
|
+
|
886
|
+
|
887
|
+
|
888
|
+
|
889
|
+
|
890
|
+
|
891
|
+
<li class="md-nav__item">
|
892
|
+
<a href="../../../nodejs/docs/sp-fetch-client/" title="SPFetchClient" class="md-nav__link">
|
893
|
+
SPFetchClient
|
894
|
+
</a>
|
895
|
+
</li>
|
896
|
+
|
897
|
+
|
898
|
+
|
899
|
+
|
900
|
+
|
901
|
+
|
902
|
+
|
903
|
+
<li class="md-nav__item">
|
904
|
+
<a href="../../../nodejs/docs/bearer-token-fetch-client/" title="BearerTokenFetchClient" class="md-nav__link">
|
905
|
+
BearerTokenFetchClient
|
906
|
+
</a>
|
907
|
+
</li>
|
908
|
+
|
909
|
+
|
910
|
+
|
911
|
+
|
912
|
+
|
913
|
+
|
914
|
+
|
915
|
+
<li class="md-nav__item">
|
916
|
+
<a href="../../../nodejs/docs/provider-hosted-app/" title="ProviderHostedRequestContext" class="md-nav__link">
|
917
|
+
ProviderHostedRequestContext
|
918
|
+
</a>
|
919
|
+
</li>
|
920
|
+
|
921
|
+
|
922
|
+
</ul>
|
923
|
+
</nav>
|
924
|
+
</li>
|
925
|
+
|
926
|
+
|
927
|
+
|
928
|
+
|
929
|
+
|
930
|
+
|
931
|
+
|
932
|
+
<li class="md-nav__item md-nav__item--nested">
|
933
|
+
|
934
|
+
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-7" type="checkbox" id="nav-5-7">
|
935
|
+
|
936
|
+
<label class="md-nav__link" for="nav-5-7">
|
937
|
+
odata
|
938
|
+
</label>
|
939
|
+
<nav class="md-nav" data-md-component="collapsible" data-md-level="2">
|
940
|
+
<label class="md-nav__title" for="nav-5-7">
|
941
|
+
odata
|
942
|
+
</label>
|
943
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
944
|
+
|
945
|
+
|
946
|
+
|
947
|
+
|
948
|
+
|
949
|
+
|
950
|
+
|
951
|
+
<li class="md-nav__item">
|
952
|
+
<a href="../../../queryable/docs/" title="odata" class="md-nav__link">
|
953
|
+
odata
|
954
|
+
</a>
|
955
|
+
</li>
|
956
|
+
|
957
|
+
|
958
|
+
|
959
|
+
|
960
|
+
|
961
|
+
|
962
|
+
|
963
|
+
<li class="md-nav__item">
|
964
|
+
<a href="../../../queryable/docs/caching/" title="caching" class="md-nav__link">
|
965
|
+
caching
|
966
|
+
</a>
|
967
|
+
</li>
|
968
|
+
|
969
|
+
|
970
|
+
|
971
|
+
|
972
|
+
|
973
|
+
|
974
|
+
|
975
|
+
<li class="md-nav__item">
|
976
|
+
<a href="../../../queryable/docs/core/" title="core" class="md-nav__link">
|
977
|
+
core
|
978
|
+
</a>
|
979
|
+
</li>
|
980
|
+
|
981
|
+
|
982
|
+
|
983
|
+
|
984
|
+
|
985
|
+
|
986
|
+
|
987
|
+
<li class="md-nav__item">
|
988
|
+
<a href="../../../queryable/docs/odata-batch/" title="OData Batching" class="md-nav__link">
|
989
|
+
OData Batching
|
990
|
+
</a>
|
991
|
+
</li>
|
992
|
+
|
993
|
+
|
994
|
+
|
995
|
+
|
996
|
+
|
997
|
+
|
998
|
+
|
999
|
+
<li class="md-nav__item">
|
1000
|
+
<a href="../../../queryable/docs/parsers/" title="Parsers" class="md-nav__link">
|
1001
|
+
Parsers
|
1002
|
+
</a>
|
1003
|
+
</li>
|
1004
|
+
|
1005
|
+
|
1006
|
+
|
1007
|
+
|
1008
|
+
|
1009
|
+
|
1010
|
+
|
1011
|
+
<li class="md-nav__item">
|
1012
|
+
<a href="../../../queryable/docs/pipeline/" title="Pipeline" class="md-nav__link">
|
1013
|
+
Pipeline
|
1014
|
+
</a>
|
1015
|
+
</li>
|
1016
|
+
|
1017
|
+
|
1018
|
+
|
1019
|
+
|
1020
|
+
|
1021
|
+
|
1022
|
+
|
1023
|
+
<li class="md-nav__item">
|
1024
|
+
<a href="../../../queryable/docs/queryable/" title="Queryable" class="md-nav__link">
|
1025
|
+
Queryable
|
1026
|
+
</a>
|
1027
|
+
</li>
|
1028
|
+
|
1029
|
+
|
1030
|
+
</ul>
|
1031
|
+
</nav>
|
1032
|
+
</li>
|
1033
|
+
|
1034
|
+
|
1035
|
+
|
1036
|
+
|
1037
|
+
|
1038
|
+
|
1039
|
+
|
1040
|
+
<li class="md-nav__item">
|
1041
|
+
<a href="../../../pnpjs/docs/" title="pnpjs" class="md-nav__link">
|
1042
|
+
pnpjs
|
1043
|
+
</a>
|
1044
|
+
</li>
|
1045
|
+
|
1046
|
+
|
1047
|
+
|
1048
|
+
|
1049
|
+
|
1050
|
+
|
1051
|
+
|
1052
|
+
|
1053
|
+
|
1054
|
+
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
1055
|
+
|
1056
|
+
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-9" type="checkbox" id="nav-5-9" checked>
|
1057
|
+
|
1058
|
+
<label class="md-nav__link" for="nav-5-9">
|
1059
|
+
sp
|
1060
|
+
</label>
|
1061
|
+
<nav class="md-nav" data-md-component="collapsible" data-md-level="2">
|
1062
|
+
<label class="md-nav__title" for="nav-5-9">
|
1063
|
+
sp
|
1064
|
+
</label>
|
1065
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
1066
|
+
|
1067
|
+
|
1068
|
+
|
1069
|
+
|
1070
|
+
|
1071
|
+
|
1072
|
+
|
1073
|
+
<li class="md-nav__item">
|
1074
|
+
<a href="../" title="sp" class="md-nav__link">
|
1075
|
+
sp
|
1076
|
+
</a>
|
1077
|
+
</li>
|
1078
|
+
|
1079
|
+
|
1080
|
+
|
1081
|
+
|
1082
|
+
|
1083
|
+
|
1084
|
+
|
1085
|
+
<li class="md-nav__item">
|
1086
|
+
<a href="../alias-parameters/" title="Alias Parameters" class="md-nav__link">
|
1087
|
+
Alias Parameters
|
1088
|
+
</a>
|
1089
|
+
</li>
|
1090
|
+
|
1091
|
+
|
1092
|
+
|
1093
|
+
|
1094
|
+
|
1095
|
+
|
1096
|
+
|
1097
|
+
<li class="md-nav__item">
|
1098
|
+
<a href="../alm/" title="ALM api" class="md-nav__link">
|
1099
|
+
ALM api
|
1100
|
+
</a>
|
1101
|
+
</li>
|
1102
|
+
|
1103
|
+
|
1104
|
+
|
1105
|
+
|
1106
|
+
|
1107
|
+
|
1108
|
+
|
1109
|
+
<li class="md-nav__item">
|
1110
|
+
<a href="../attachments/" title="Attachments" class="md-nav__link">
|
1111
|
+
Attachments
|
1112
|
+
</a>
|
1113
|
+
</li>
|
1114
|
+
|
1115
|
+
|
1116
|
+
|
1117
|
+
|
1118
|
+
|
1119
|
+
|
1120
|
+
|
1121
|
+
|
1122
|
+
|
1123
|
+
<li class="md-nav__item md-nav__item--active">
|
1124
|
+
|
1125
|
+
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
|
1126
|
+
|
1127
|
+
|
1128
|
+
|
1129
|
+
|
1130
|
+
<label class="md-nav__link md-nav__link--active" for="__toc">
|
1131
|
+
Client-side Pages
|
1132
|
+
</label>
|
1133
|
+
|
1134
|
+
<a href="./" title="Client-side Pages" class="md-nav__link md-nav__link--active">
|
1135
|
+
Client-side Pages
|
1136
|
+
</a>
|
1137
|
+
|
1138
|
+
|
1139
|
+
<nav class="md-nav md-nav--secondary">
|
1140
|
+
|
1141
|
+
|
1142
|
+
|
1143
|
+
|
1144
|
+
|
1145
|
+
<label class="md-nav__title" for="__toc">Table of contents</label>
|
1146
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
1147
|
+
|
1148
|
+
<li class="md-nav__item">
|
1149
|
+
<a href="#add-client-side-page" title="Add Client-side page" class="md-nav__link">
|
1150
|
+
Add Client-side page
|
1151
|
+
</a>
|
1152
|
+
|
1153
|
+
</li>
|
1154
|
+
|
1155
|
+
<li class="md-nav__item">
|
1156
|
+
<a href="#load-client-side-page" title="Load Client-side page" class="md-nav__link">
|
1157
|
+
Load Client-side page
|
1158
|
+
</a>
|
1159
|
+
|
1160
|
+
</li>
|
1161
|
+
|
1162
|
+
<li class="md-nav__item">
|
1163
|
+
<a href="#add-controls" title="Add Controls" class="md-nav__link">
|
1164
|
+
Add Controls
|
1165
|
+
</a>
|
1166
|
+
|
1167
|
+
</li>
|
1168
|
+
|
1169
|
+
<li class="md-nav__item">
|
1170
|
+
<a href="#add-client-side-web-parts" title="Add Client-side Web Parts" class="md-nav__link">
|
1171
|
+
Add Client-side Web Parts
|
1172
|
+
</a>
|
1173
|
+
|
1174
|
+
</li>
|
1175
|
+
|
1176
|
+
<li class="md-nav__item">
|
1177
|
+
<a href="#find-controls" title="Find Controls" class="md-nav__link">
|
1178
|
+
Find Controls
|
1179
|
+
</a>
|
1180
|
+
|
1181
|
+
</li>
|
1182
|
+
|
1183
|
+
<li class="md-nav__item">
|
1184
|
+
<a href="#control-comments" title="Control Comments" class="md-nav__link">
|
1185
|
+
Control Comments
|
1186
|
+
</a>
|
1187
|
+
|
1188
|
+
</li>
|
1189
|
+
|
1190
|
+
<li class="md-nav__item">
|
1191
|
+
<a href="#likeunlike-client-side-page-get-like-information-about-page" title="Like/Unlike Client-side page, get like information about page" class="md-nav__link">
|
1192
|
+
Like/Unlike Client-side page, get like information about page
|
1193
|
+
</a>
|
1194
|
+
|
1195
|
+
</li>
|
1196
|
+
|
1197
|
+
<li class="md-nav__item">
|
1198
|
+
<a href="#sample" title="Sample" class="md-nav__link">
|
1199
|
+
Sample
|
1200
|
+
</a>
|
1201
|
+
|
1202
|
+
</li>
|
1203
|
+
|
1204
|
+
|
1205
|
+
|
1206
|
+
|
1207
|
+
|
1208
|
+
</ul>
|
1209
|
+
|
1210
|
+
</nav>
|
1211
|
+
|
1212
|
+
</li>
|
1213
|
+
|
1214
|
+
|
1215
|
+
|
1216
|
+
|
1217
|
+
|
1218
|
+
|
1219
|
+
|
1220
|
+
<li class="md-nav__item">
|
1221
|
+
<a href="../content-types/" title="Content Types" class="md-nav__link">
|
1222
|
+
Content Types
|
1223
|
+
</a>
|
1224
|
+
</li>
|
1225
|
+
|
1226
|
+
|
1227
|
+
|
1228
|
+
|
1229
|
+
|
1230
|
+
|
1231
|
+
|
1232
|
+
<li class="md-nav__item">
|
1233
|
+
<a href="../entity-merging/" title="Entity Merging" class="md-nav__link">
|
1234
|
+
Entity Merging
|
1235
|
+
</a>
|
1236
|
+
</li>
|
1237
|
+
|
1238
|
+
|
1239
|
+
|
1240
|
+
|
1241
|
+
|
1242
|
+
|
1243
|
+
|
1244
|
+
<li class="md-nav__item">
|
1245
|
+
<a href="../features/" title="Features" class="md-nav__link">
|
1246
|
+
Features
|
1247
|
+
</a>
|
1248
|
+
</li>
|
1249
|
+
|
1250
|
+
|
1251
|
+
|
1252
|
+
|
1253
|
+
|
1254
|
+
|
1255
|
+
|
1256
|
+
<li class="md-nav__item">
|
1257
|
+
<a href="../fields/" title="Fields" class="md-nav__link">
|
1258
|
+
Fields
|
1259
|
+
</a>
|
1260
|
+
</li>
|
1261
|
+
|
1262
|
+
|
1263
|
+
|
1264
|
+
|
1265
|
+
|
1266
|
+
|
1267
|
+
|
1268
|
+
<li class="md-nav__item">
|
1269
|
+
<a href="../files/" title="Files" class="md-nav__link">
|
1270
|
+
Files
|
1271
|
+
</a>
|
1272
|
+
</li>
|
1273
|
+
|
1274
|
+
|
1275
|
+
|
1276
|
+
|
1277
|
+
|
1278
|
+
|
1279
|
+
|
1280
|
+
<li class="md-nav__item">
|
1281
|
+
<a href="../items/" title="List Items" class="md-nav__link">
|
1282
|
+
List Items
|
1283
|
+
</a>
|
1284
|
+
</li>
|
1285
|
+
|
1286
|
+
|
1287
|
+
|
1288
|
+
|
1289
|
+
|
1290
|
+
|
1291
|
+
|
1292
|
+
<li class="md-nav__item">
|
1293
|
+
<a href="../navigation-service/" title="Navigation Service" class="md-nav__link">
|
1294
|
+
Navigation Service
|
1295
|
+
</a>
|
1296
|
+
</li>
|
1297
|
+
|
1298
|
+
|
1299
|
+
|
1300
|
+
|
1301
|
+
|
1302
|
+
|
1303
|
+
|
1304
|
+
<li class="md-nav__item">
|
1305
|
+
<a href="../permissions/" title="Permissions" class="md-nav__link">
|
1306
|
+
Permissions
|
1307
|
+
</a>
|
1308
|
+
</li>
|
1309
|
+
|
1310
|
+
|
1311
|
+
|
1312
|
+
|
1313
|
+
|
1314
|
+
|
1315
|
+
|
1316
|
+
<li class="md-nav__item">
|
1317
|
+
<a href="../profiles/" title="Profiles" class="md-nav__link">
|
1318
|
+
Profiles
|
1319
|
+
</a>
|
1320
|
+
</li>
|
1321
|
+
|
1322
|
+
|
1323
|
+
|
1324
|
+
|
1325
|
+
|
1326
|
+
|
1327
|
+
|
1328
|
+
<li class="md-nav__item">
|
1329
|
+
<a href="../related-items/" title="Related Items" class="md-nav__link">
|
1330
|
+
Related Items
|
1331
|
+
</a>
|
1332
|
+
</li>
|
1333
|
+
|
1334
|
+
|
1335
|
+
|
1336
|
+
|
1337
|
+
|
1338
|
+
|
1339
|
+
|
1340
|
+
<li class="md-nav__item">
|
1341
|
+
<a href="../search/" title="Search" class="md-nav__link">
|
1342
|
+
Search
|
1343
|
+
</a>
|
1344
|
+
</li>
|
1345
|
+
|
1346
|
+
|
1347
|
+
|
1348
|
+
|
1349
|
+
|
1350
|
+
|
1351
|
+
|
1352
|
+
<li class="md-nav__item">
|
1353
|
+
<a href="../sharing/" title="Sharing" class="md-nav__link">
|
1354
|
+
Sharing
|
1355
|
+
</a>
|
1356
|
+
</li>
|
1357
|
+
|
1358
|
+
|
1359
|
+
|
1360
|
+
|
1361
|
+
|
1362
|
+
|
1363
|
+
|
1364
|
+
<li class="md-nav__item">
|
1365
|
+
<a href="../sites/" title="Sites" class="md-nav__link">
|
1366
|
+
Sites
|
1367
|
+
</a>
|
1368
|
+
</li>
|
1369
|
+
|
1370
|
+
|
1371
|
+
|
1372
|
+
|
1373
|
+
|
1374
|
+
|
1375
|
+
|
1376
|
+
<li class="md-nav__item">
|
1377
|
+
<a href="../sitedesigns/" title="Site Designs" class="md-nav__link">
|
1378
|
+
Site Designs
|
1379
|
+
</a>
|
1380
|
+
</li>
|
1381
|
+
|
1382
|
+
|
1383
|
+
|
1384
|
+
|
1385
|
+
|
1386
|
+
|
1387
|
+
|
1388
|
+
<li class="md-nav__item">
|
1389
|
+
<a href="../social/" title="Social" class="md-nav__link">
|
1390
|
+
Social
|
1391
|
+
</a>
|
1392
|
+
</li>
|
1393
|
+
|
1394
|
+
|
1395
|
+
|
1396
|
+
|
1397
|
+
|
1398
|
+
|
1399
|
+
|
1400
|
+
<li class="md-nav__item">
|
1401
|
+
<a href="../sp-utilities-utility/" title="SP.Utilities.Utility" class="md-nav__link">
|
1402
|
+
SP.Utilities.Utility
|
1403
|
+
</a>
|
1404
|
+
</li>
|
1405
|
+
|
1406
|
+
|
1407
|
+
|
1408
|
+
|
1409
|
+
|
1410
|
+
|
1411
|
+
|
1412
|
+
<li class="md-nav__item">
|
1413
|
+
<a href="../tenant-properties/" title="Tenant Properties" class="md-nav__link">
|
1414
|
+
Tenant Properties
|
1415
|
+
</a>
|
1416
|
+
</li>
|
1417
|
+
|
1418
|
+
|
1419
|
+
|
1420
|
+
|
1421
|
+
|
1422
|
+
|
1423
|
+
|
1424
|
+
<li class="md-nav__item">
|
1425
|
+
<a href="../views/" title="Views" class="md-nav__link">
|
1426
|
+
Views
|
1427
|
+
</a>
|
1428
|
+
</li>
|
1429
|
+
|
1430
|
+
|
1431
|
+
|
1432
|
+
|
1433
|
+
|
1434
|
+
|
1435
|
+
|
1436
|
+
<li class="md-nav__item">
|
1437
|
+
<a href="../webs/" title="Webs" class="md-nav__link">
|
1438
|
+
Webs
|
1439
|
+
</a>
|
1440
|
+
</li>
|
1441
|
+
|
1442
|
+
|
1443
|
+
|
1444
|
+
|
1445
|
+
|
1446
|
+
|
1447
|
+
|
1448
|
+
<li class="md-nav__item">
|
1449
|
+
<a href="../comments-likes/" title="Comments and Likes" class="md-nav__link">
|
1450
|
+
Comments and Likes
|
1451
|
+
</a>
|
1452
|
+
</li>
|
1453
|
+
|
1454
|
+
|
1455
|
+
</ul>
|
1456
|
+
</nav>
|
1457
|
+
</li>
|
1458
|
+
|
1459
|
+
|
1460
|
+
|
1461
|
+
|
1462
|
+
|
1463
|
+
|
1464
|
+
|
1465
|
+
<li class="md-nav__item md-nav__item--nested">
|
1466
|
+
|
1467
|
+
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-10" type="checkbox" id="nav-5-10">
|
1468
|
+
|
1469
|
+
<label class="md-nav__link" for="nav-5-10">
|
1470
|
+
sp-addinhelpers
|
1471
|
+
</label>
|
1472
|
+
<nav class="md-nav" data-md-component="collapsible" data-md-level="2">
|
1473
|
+
<label class="md-nav__title" for="nav-5-10">
|
1474
|
+
sp-addinhelpers
|
1475
|
+
</label>
|
1476
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
1477
|
+
|
1478
|
+
|
1479
|
+
|
1480
|
+
|
1481
|
+
|
1482
|
+
|
1483
|
+
|
1484
|
+
<li class="md-nav__item">
|
1485
|
+
<a href="../../../sp-addinhelpers/docs/" title="sp-addinhelpers" class="md-nav__link">
|
1486
|
+
sp-addinhelpers
|
1487
|
+
</a>
|
1488
|
+
</li>
|
1489
|
+
|
1490
|
+
|
1491
|
+
|
1492
|
+
|
1493
|
+
|
1494
|
+
|
1495
|
+
|
1496
|
+
<li class="md-nav__item">
|
1497
|
+
<a href="../../../sp-addinhelpers/docs/sp-request-executor-client/" title="SPRequestExecutorClient" class="md-nav__link">
|
1498
|
+
SPRequestExecutorClient
|
1499
|
+
</a>
|
1500
|
+
</li>
|
1501
|
+
|
1502
|
+
|
1503
|
+
|
1504
|
+
|
1505
|
+
|
1506
|
+
|
1507
|
+
|
1508
|
+
<li class="md-nav__item">
|
1509
|
+
<a href="../../../sp-addinhelpers/docs/sp-rest-addin/" title="SPRestAddIn" class="md-nav__link">
|
1510
|
+
SPRestAddIn
|
1511
|
+
</a>
|
1512
|
+
</li>
|
1513
|
+
|
1514
|
+
|
1515
|
+
</ul>
|
1516
|
+
</nav>
|
1517
|
+
</li>
|
1518
|
+
|
1519
|
+
|
1520
|
+
|
1521
|
+
|
1522
|
+
|
1523
|
+
|
1524
|
+
|
1525
|
+
<li class="md-nav__item">
|
1526
|
+
<a href="../../../sp-clientsvc/docs/" title="sp-clientsvc" class="md-nav__link">
|
1527
|
+
sp-clientsvc
|
1528
|
+
</a>
|
1529
|
+
</li>
|
1530
|
+
|
1531
|
+
|
1532
|
+
|
1533
|
+
|
1534
|
+
|
1535
|
+
|
1536
|
+
|
1537
|
+
<li class="md-nav__item md-nav__item--nested">
|
1538
|
+
|
1539
|
+
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-12" type="checkbox" id="nav-5-12">
|
1540
|
+
|
1541
|
+
<label class="md-nav__link" for="nav-5-12">
|
1542
|
+
sp-taxonomy
|
1543
|
+
</label>
|
1544
|
+
<nav class="md-nav" data-md-component="collapsible" data-md-level="2">
|
1545
|
+
<label class="md-nav__title" for="nav-5-12">
|
1546
|
+
sp-taxonomy
|
1547
|
+
</label>
|
1548
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
1549
|
+
|
1550
|
+
|
1551
|
+
|
1552
|
+
|
1553
|
+
|
1554
|
+
|
1555
|
+
|
1556
|
+
<li class="md-nav__item">
|
1557
|
+
<a href="../../../sp-taxonomy/docs/" title="sp-taxonomy" class="md-nav__link">
|
1558
|
+
sp-taxonomy
|
1559
|
+
</a>
|
1560
|
+
</li>
|
1561
|
+
|
1562
|
+
|
1563
|
+
|
1564
|
+
|
1565
|
+
|
1566
|
+
|
1567
|
+
|
1568
|
+
<li class="md-nav__item">
|
1569
|
+
<a href="../../../sp-taxonomy/docs/term-stores/" title="Term Stores" class="md-nav__link">
|
1570
|
+
Term Stores
|
1571
|
+
</a>
|
1572
|
+
</li>
|
1573
|
+
|
1574
|
+
|
1575
|
+
|
1576
|
+
|
1577
|
+
|
1578
|
+
|
1579
|
+
|
1580
|
+
<li class="md-nav__item">
|
1581
|
+
<a href="../../../sp-taxonomy/docs/term-groups/" title="Term Groups" class="md-nav__link">
|
1582
|
+
Term Groups
|
1583
|
+
</a>
|
1584
|
+
</li>
|
1585
|
+
|
1586
|
+
|
1587
|
+
|
1588
|
+
|
1589
|
+
|
1590
|
+
|
1591
|
+
|
1592
|
+
<li class="md-nav__item">
|
1593
|
+
<a href="../../../sp-taxonomy/docs/term-sets/" title="Term Sets" class="md-nav__link">
|
1594
|
+
Term Sets
|
1595
|
+
</a>
|
1596
|
+
</li>
|
1597
|
+
|
1598
|
+
|
1599
|
+
|
1600
|
+
|
1601
|
+
|
1602
|
+
|
1603
|
+
|
1604
|
+
<li class="md-nav__item">
|
1605
|
+
<a href="../../../sp-taxonomy/docs/terms/" title="Terms" class="md-nav__link">
|
1606
|
+
Terms
|
1607
|
+
</a>
|
1608
|
+
</li>
|
1609
|
+
|
1610
|
+
|
1611
|
+
|
1612
|
+
|
1613
|
+
|
1614
|
+
|
1615
|
+
|
1616
|
+
<li class="md-nav__item">
|
1617
|
+
<a href="../../../sp-taxonomy/docs/labels/" title="Labels" class="md-nav__link">
|
1618
|
+
Labels
|
1619
|
+
</a>
|
1620
|
+
</li>
|
1621
|
+
|
1622
|
+
|
1623
|
+
|
1624
|
+
|
1625
|
+
|
1626
|
+
|
1627
|
+
|
1628
|
+
<li class="md-nav__item">
|
1629
|
+
<a href="../../../sp-taxonomy/docs/utilities/" title="Utilities" class="md-nav__link">
|
1630
|
+
Utilities
|
1631
|
+
</a>
|
1632
|
+
</li>
|
1633
|
+
|
1634
|
+
|
1635
|
+
</ul>
|
1636
|
+
</nav>
|
1637
|
+
</li>
|
1638
|
+
|
1639
|
+
|
1640
|
+
</ul>
|
1641
|
+
</nav>
|
1642
|
+
</li>
|
1643
|
+
|
1644
|
+
|
1645
|
+
</ul>
|
1646
|
+
</nav>
|
1647
|
+
</div>
|
1648
|
+
</div>
|
1649
|
+
</div>
|
1650
|
+
|
1651
|
+
|
1652
|
+
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
|
1653
|
+
<div class="md-sidebar__scrollwrap">
|
1654
|
+
<div class="md-sidebar__inner">
|
1655
|
+
|
1656
|
+
<nav class="md-nav md-nav--secondary">
|
1657
|
+
|
1658
|
+
|
1659
|
+
|
1660
|
+
|
1661
|
+
|
1662
|
+
<label class="md-nav__title" for="__toc">Table of contents</label>
|
1663
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
1664
|
+
|
1665
|
+
<li class="md-nav__item">
|
1666
|
+
<a href="#add-client-side-page" title="Add Client-side page" class="md-nav__link">
|
1667
|
+
Add Client-side page
|
1668
|
+
</a>
|
1669
|
+
|
1670
|
+
</li>
|
1671
|
+
|
1672
|
+
<li class="md-nav__item">
|
1673
|
+
<a href="#load-client-side-page" title="Load Client-side page" class="md-nav__link">
|
1674
|
+
Load Client-side page
|
1675
|
+
</a>
|
1676
|
+
|
1677
|
+
</li>
|
1678
|
+
|
1679
|
+
<li class="md-nav__item">
|
1680
|
+
<a href="#add-controls" title="Add Controls" class="md-nav__link">
|
1681
|
+
Add Controls
|
1682
|
+
</a>
|
1683
|
+
|
1684
|
+
</li>
|
1685
|
+
|
1686
|
+
<li class="md-nav__item">
|
1687
|
+
<a href="#add-client-side-web-parts" title="Add Client-side Web Parts" class="md-nav__link">
|
1688
|
+
Add Client-side Web Parts
|
1689
|
+
</a>
|
1690
|
+
|
1691
|
+
</li>
|
1692
|
+
|
1693
|
+
<li class="md-nav__item">
|
1694
|
+
<a href="#find-controls" title="Find Controls" class="md-nav__link">
|
1695
|
+
Find Controls
|
1696
|
+
</a>
|
1697
|
+
|
1698
|
+
</li>
|
1699
|
+
|
1700
|
+
<li class="md-nav__item">
|
1701
|
+
<a href="#control-comments" title="Control Comments" class="md-nav__link">
|
1702
|
+
Control Comments
|
1703
|
+
</a>
|
1704
|
+
|
1705
|
+
</li>
|
1706
|
+
|
1707
|
+
<li class="md-nav__item">
|
1708
|
+
<a href="#likeunlike-client-side-page-get-like-information-about-page" title="Like/Unlike Client-side page, get like information about page" class="md-nav__link">
|
1709
|
+
Like/Unlike Client-side page, get like information about page
|
1710
|
+
</a>
|
1711
|
+
|
1712
|
+
</li>
|
1713
|
+
|
1714
|
+
<li class="md-nav__item">
|
1715
|
+
<a href="#sample" title="Sample" class="md-nav__link">
|
1716
|
+
Sample
|
1717
|
+
</a>
|
1718
|
+
|
1719
|
+
</li>
|
1720
|
+
|
1721
|
+
|
1722
|
+
|
1723
|
+
|
1724
|
+
|
1725
|
+
</ul>
|
1726
|
+
|
1727
|
+
</nav>
|
1728
|
+
</div>
|
1729
|
+
</div>
|
1730
|
+
</div>
|
1731
|
+
|
1732
|
+
|
1733
|
+
<div class="md-content">
|
1734
|
+
<article class="md-content__inner md-typeset">
|
1735
|
+
|
1736
|
+
|
1737
|
+
<a href="http://github.com/pnp/pnpjs/tree/dev/packages/sp/docs/client-side-pages.md" title="Edit this page" class="md-icon md-content__icon"></a>
|
1738
|
+
|
1739
|
+
|
1740
|
+
<h1 id="pnpspclientsidepages">@pnp/sp/clientsidepages<a class="headerlink" href="#pnpspclientsidepages" title="Permanent link">¶</a></h1>
|
1741
|
+
<p>The ability to manage client-side pages is a capability introduced in version 1.0.2 of @pnp/sp. Through the methods described
|
1742
|
+
you can add and edit "modern" pages in SharePoint sites.</p>
|
1743
|
+
<h2 id="add-client-side-page">Add Client-side page<a class="headerlink" href="#add-client-side-page" title="Permanent link">¶</a></h2>
|
1744
|
+
<p>Using the addClientSidePage you can add a new client side page to a site, specifying the filename.</p>
|
1745
|
+
<div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">sp</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">"@pnp/sp"</span><span class="p">;</span>
|
1746
|
+
|
1747
|
+
<span class="kr">const</span> <span class="nx">page</span> <span class="o">=</span> <span class="nx">await</span> <span class="nx">sp</span><span class="p">.</span><span class="nx">web</span><span class="p">.</span><span class="nx">addClientSidePage</span><span class="p">(</span><span class="sb">`file-name`</span><span class="p">);</span>
|
1748
|
+
|
1749
|
+
<span class="c1">// OR</span>
|
1750
|
+
|
1751
|
+
<span class="kr">const</span> <span class="nx">page</span> <span class="o">=</span> <span class="nx">await</span> <span class="nx">sp</span><span class="p">.</span><span class="nx">web</span><span class="p">.</span><span class="nx">addClientSidePage</span><span class="p">(</span><span class="sb">`file-name`</span><span class="p">,</span> <span class="sb">`Page Display Title`</span><span class="p">);</span>
|
1752
|
+
</pre></div>
|
1753
|
+
|
1754
|
+
|
1755
|
+
<p>Added in 1.0.5 you can also add a client side page using the list path. This gets around potential language issues with list title. You must specify the list path when calling this method in addition to the new page's filename.</p>
|
1756
|
+
<div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">sp</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">"@pnp/sp"</span><span class="p">;</span>
|
1757
|
+
|
1758
|
+
<span class="kr">const</span> <span class="nx">page</span> <span class="o">=</span> <span class="nx">await</span> <span class="nx">sp</span><span class="p">.</span><span class="nx">web</span><span class="p">.</span><span class="nx">addClientSidePageByPath</span><span class="p">(</span><span class="sb">`file-name`</span><span class="p">,</span> <span class="s2">"/sites/dev/SitePages"</span><span class="p">);</span>
|
1759
|
+
</pre></div>
|
1760
|
+
|
1761
|
+
|
1762
|
+
<h2 id="load-client-side-page">Load Client-side page<a class="headerlink" href="#load-client-side-page" title="Permanent link">¶</a></h2>
|
1763
|
+
<p>You can also load an existing page based on the file representing that page. Note that the static fromFile returns a promise which
|
1764
|
+
resolves so the loaded page. Here we are showing use of the getFileByServerRelativeUrl method to get the File instance, but any of the ways
|
1765
|
+
of <a href="../files/">getting a File instance</a> will work. Also note we are passing the File instance, not the file content.</p>
|
1766
|
+
<div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span>
|
1767
|
+
<span class="nx">sp</span><span class="p">,</span>
|
1768
|
+
<span class="nx">ClientSidePage</span><span class="p">,</span>
|
1769
|
+
<span class="p">}</span> <span class="nx">from</span> <span class="s2">"@pnp/sp"</span><span class="p">;</span>
|
1770
|
+
|
1771
|
+
<span class="kr">const</span> <span class="nx">page</span> <span class="o">=</span> <span class="nx">await</span> <span class="nx">ClientSidePage</span><span class="p">.</span><span class="nx">fromFile</span><span class="p">(</span><span class="nx">sp</span><span class="p">.</span><span class="nx">web</span><span class="p">.</span><span class="nx">getFileByServerRelativeUrl</span><span class="p">(</span><span class="s2">"/sites/dev/SitePages/ExistingFile.aspx"</span><span class="p">));</span>
|
1772
|
+
</pre></div>
|
1773
|
+
|
1774
|
+
|
1775
|
+
<p><strong>The remaining examples below reference a variable "page" which is assumed to be a ClientSidePage instance loaded through one of the above means.</strong></p>
|
1776
|
+
<h2 id="add-controls">Add Controls<a class="headerlink" href="#add-controls" title="Permanent link">¶</a></h2>
|
1777
|
+
<p>A client-side page is made up of sections, which have columns, which contain controls. A new page will have none of these and an existing page may have
|
1778
|
+
any combination of these. There are a few rules to understand how sections and columns layout on a page for display. A section is a horizontal piece of
|
1779
|
+
a page that extends 100% of the page width. A page with multiple sections will stack these sections based on the section's order property - a 1 based index.</p>
|
1780
|
+
<p>Within a section you can have one or more columns. Each column is ordered left to right based on the column's order property. The width of each column is
|
1781
|
+
controlled by the factor property whose value is one of 0, 2, 4, 6, 8, 10, or 12. The columns in a section should have factors that add up to 12. Meaning
|
1782
|
+
if you wanted to have two equal columns you can set a factor of 6 for each. A page can have empty columns.</p>
|
1783
|
+
<div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span>
|
1784
|
+
<span class="nx">sp</span><span class="p">,</span>
|
1785
|
+
<span class="nx">ClientSideText</span><span class="p">,</span>
|
1786
|
+
<span class="p">}</span> <span class="nx">from</span> <span class="s2">"@pnp/sp"</span><span class="p">;</span>
|
1787
|
+
|
1788
|
+
<span class="c1">// this code adds a section, and then adds a control to that section. The control is added to the section's defaultColumn, and if there are no columns a single</span>
|
1789
|
+
<span class="c1">// column of factor 12 is created as a default. Here we add the ClientSideText part</span>
|
1790
|
+
<span class="nx">page</span><span class="p">.</span><span class="nx">addSection</span><span class="p">().</span><span class="nx">addControl</span><span class="p">(</span><span class="k">new</span> <span class="nx">ClientSideText</span><span class="p">(</span><span class="s2">"@pnp/sp is a great library!"</span><span class="p">));</span>
|
1791
|
+
|
1792
|
+
<span class="c1">// here we add a section, add two columns, and add a text control to the second section so it will appear on the right of the page</span>
|
1793
|
+
<span class="c1">// add and get a reference to a new section</span>
|
1794
|
+
<span class="kr">const</span> <span class="nx">section</span> <span class="o">=</span> <span class="nx">page</span><span class="p">.</span><span class="nx">addSection</span><span class="p">();</span>
|
1795
|
+
|
1796
|
+
<span class="c1">// add a column of factor 6</span>
|
1797
|
+
<span class="nx">section</span><span class="p">.</span><span class="nx">addColumn</span><span class="p">(</span><span class="mi">6</span><span class="p">);</span>
|
1798
|
+
|
1799
|
+
<span class="c1">// add and get a reference to a new column of factor 6</span>
|
1800
|
+
<span class="kr">const</span> <span class="nx">column</span> <span class="o">=</span> <span class="nx">section</span><span class="p">.</span><span class="nx">addColumn</span><span class="p">(</span><span class="mi">6</span><span class="p">);</span>
|
1801
|
+
|
1802
|
+
<span class="c1">// add a text control to the second new column</span>
|
1803
|
+
<span class="nx">column</span><span class="p">.</span><span class="nx">addControl</span><span class="p">(</span><span class="k">new</span> <span class="nx">ClientSideText</span><span class="p">(</span><span class="s2">"Be sure to check out the @pnp docs at https://pnp.github.io/pnpjs/"</span><span class="p">));</span>
|
1804
|
+
|
1805
|
+
<span class="c1">// we need to save our content changes</span>
|
1806
|
+
<span class="nx">await</span> <span class="nx">page</span><span class="p">.</span><span class="nx">save</span><span class="p">();</span>
|
1807
|
+
</pre></div>
|
1808
|
+
|
1809
|
+
|
1810
|
+
<h2 id="add-client-side-web-parts">Add Client-side Web Parts<a class="headerlink" href="#add-client-side-web-parts" title="Permanent link">¶</a></h2>
|
1811
|
+
<p>Beyond the text control above you can also add any of the available client-side web parts in a given site. To find out what web parts are available you
|
1812
|
+
first call the web's getClientSideWebParts method. Once you have a list of parts you need to find the defintion you want to use, here we get the Embed web part
|
1813
|
+
whose's id is "490d7c76-1824-45b2-9de3-676421c997fa" (at least in one farm, your mmv).</p>
|
1814
|
+
<div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span>
|
1815
|
+
<span class="nx">sp</span><span class="p">,</span>
|
1816
|
+
<span class="nx">ClientSideWebpart</span><span class="p">,</span>
|
1817
|
+
<span class="nx">ClientSideWebpartPropertyTypes</span><span class="p">,</span>
|
1818
|
+
<span class="p">}</span> <span class="nx">from</span> <span class="s2">"@pnp/sp"</span><span class="p">;</span>
|
1819
|
+
|
1820
|
+
<span class="c1">// this will be a ClientSidePageComponent array</span>
|
1821
|
+
<span class="c1">// this can be cached on the client in production scenarios</span>
|
1822
|
+
<span class="kr">const</span> <span class="nx">partDefs</span> <span class="o">=</span> <span class="nx">await</span> <span class="nx">sp</span><span class="p">.</span><span class="nx">web</span><span class="p">.</span><span class="nx">getClientSideWebParts</span><span class="p">();</span>
|
1823
|
+
|
1824
|
+
<span class="c1">// find the definition we want, here by id</span>
|
1825
|
+
<span class="kr">const</span> <span class="nx">partDef</span> <span class="o">=</span> <span class="nx">partDefs</span><span class="p">.</span><span class="nx">filter</span><span class="p">(</span><span class="nx">c</span> <span class="o">=></span> <span class="nx">c</span><span class="p">.</span><span class="nx">Id</span> <span class="o">===</span> <span class="s2">"490d7c76-1824-45b2-9de3-676421c997fa"</span><span class="p">);</span>
|
1826
|
+
|
1827
|
+
<span class="c1">// optionally ensure you found the def</span>
|
1828
|
+
<span class="k">if</span> <span class="p">(</span><span class="nx">partDef</span><span class="p">.</span><span class="nx">length</span> <span class="o"><</span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
|
1829
|
+
<span class="c1">// we didn't find it so we throw an error</span>
|
1830
|
+
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s2">"Could not find the web part"</span><span class="p">);</span>
|
1831
|
+
<span class="p">}</span>
|
1832
|
+
|
1833
|
+
<span class="c1">// create a ClientWebPart instance from the definition</span>
|
1834
|
+
<span class="kr">const</span> <span class="nx">part</span> <span class="o">=</span> <span class="nx">ClientSideWebpart</span><span class="p">.</span><span class="nx">fromComponentDef</span><span class="p">(</span><span class="nx">partDef</span><span class="p">[</span><span class="mi">0</span><span class="p">]);</span>
|
1835
|
+
|
1836
|
+
<span class="c1">// set the properties on the web part. Here we have imported the ClientSideWebpartPropertyTypes module and can use that to type</span>
|
1837
|
+
<span class="c1">// the available settings object. You can use your own types or help us out and add some typings to the module :).</span>
|
1838
|
+
<span class="c1">// here for the embed web part we only have to supply an embedCode - in this case a youtube video.</span>
|
1839
|
+
<span class="nx">part</span><span class="p">.</span><span class="nx">setProperties</span><span class="o"><</span><span class="nx">ClientSideWebpartPropertyTypes</span><span class="p">.</span><span class="nx">Embed</span><span class="o">></span><span class="p">({</span>
|
1840
|
+
<span class="nx">embedCode</span><span class="o">:</span> <span class="s2">"https://www.youtube.com/watch?v=IWQFZ7Lx-rg"</span><span class="p">,</span>
|
1841
|
+
<span class="p">});</span>
|
1842
|
+
|
1843
|
+
<span class="c1">// we add that part to a new section</span>
|
1844
|
+
<span class="nx">page</span><span class="p">.</span><span class="nx">addSection</span><span class="p">().</span><span class="nx">addControl</span><span class="p">(</span><span class="nx">part</span><span class="p">);</span>
|
1845
|
+
|
1846
|
+
<span class="c1">// save our content changes back to the server</span>
|
1847
|
+
<span class="nx">await</span> <span class="nx">page</span><span class="p">.</span><span class="nx">save</span><span class="p">();</span>
|
1848
|
+
</pre></div>
|
1849
|
+
|
1850
|
+
|
1851
|
+
<h2 id="find-controls">Find Controls<a class="headerlink" href="#find-controls" title="Permanent link">¶</a></h2>
|
1852
|
+
<p>Added in <em>1.0.3</em></p>
|
1853
|
+
<p>You can use the either of the two available method to locate controls within a page. These method search through all sections, columns, and controls returning the first instance that meets the supplied criteria.</p>
|
1854
|
+
<div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">ClientSideWebPart</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">"@pnp/sp"</span><span class="p">;</span>
|
1855
|
+
|
1856
|
+
<span class="c1">// find a control by instance id</span>
|
1857
|
+
<span class="kr">const</span> <span class="nx">control1</span> <span class="o">=</span> <span class="nx">page</span><span class="p">.</span><span class="nx">findControlById</span><span class="p">(</span><span class="s2">"b99bfccc-164e-4d3d-9b96-da48db62eb78"</span><span class="p">);</span>
|
1858
|
+
|
1859
|
+
<span class="c1">// type the returned control</span>
|
1860
|
+
<span class="kr">const</span> <span class="nx">control2</span> <span class="o">=</span> <span class="nx">page</span><span class="p">.</span><span class="nx">findControlById</span><span class="o"><</span><span class="nx">ClientSideWebPart</span><span class="o">></span><span class="p">(</span><span class="s2">"c99bfccc-164e-4d3d-9b96-da48db62eb78"</span><span class="p">);</span>
|
1861
|
+
<span class="kr">const</span> <span class="nx">control3</span> <span class="o">=</span> <span class="nx">page</span><span class="p">.</span><span class="nx">findControlById</span><span class="o"><</span><span class="nx">ClientSideText</span><span class="o">></span><span class="p">(</span><span class="s2">"a99bfccc-164e-4d3d-9b96-da48db62eb78"</span><span class="p">);</span>
|
1862
|
+
|
1863
|
+
<span class="c1">// use any predicate to find a control</span>
|
1864
|
+
<span class="kr">const</span> <span class="nx">control4</span> <span class="o">=</span> <span class="nx">page2</span><span class="p">.</span><span class="nx">findControl</span><span class="o"><</span><span class="nx">ClientSideWebpart</span><span class="o">></span><span class="p">((</span><span class="nx">c</span>: <span class="kt">CanvasControl</span><span class="p">)</span> <span class="o">=></span> <span class="p">{</span>
|
1865
|
+
|
1866
|
+
<span class="c1">// any logic you wish can be used on the control here</span>
|
1867
|
+
<span class="c1">// return true to return that control</span>
|
1868
|
+
<span class="k">return</span> <span class="nx">c</span><span class="p">.</span><span class="nx">order</span> <span class="o">></span> <span class="mi">3</span><span class="p">;</span>
|
1869
|
+
<span class="p">});</span>
|
1870
|
+
</pre></div>
|
1871
|
+
|
1872
|
+
|
1873
|
+
<h2 id="control-comments">Control Comments<a class="headerlink" href="#control-comments" title="Permanent link">¶</a></h2>
|
1874
|
+
<p>You can choose to enable or disable comments on a page using these methods</p>
|
1875
|
+
<div class="codehilite"><pre><span></span><span class="c1">// indicates if comments are disabled, not valid until the page is loaded (Added in _1.0.3_)</span>
|
1876
|
+
<span class="nx">page</span><span class="p">.</span><span class="nx">commentsDisabled</span>
|
1877
|
+
|
1878
|
+
<span class="c1">// enable comments</span>
|
1879
|
+
<span class="nx">await</span> <span class="nx">page</span><span class="p">.</span><span class="nx">enableComments</span><span class="p">();</span>
|
1880
|
+
|
1881
|
+
<span class="c1">// disable comments</span>
|
1882
|
+
<span class="nx">await</span> <span class="nx">page</span><span class="p">.</span><span class="nx">disableComments</span><span class="p">();</span>
|
1883
|
+
</pre></div>
|
1884
|
+
|
1885
|
+
|
1886
|
+
<h2 id="likeunlike-client-side-page-get-like-information-about-page">Like/Unlike Client-side page, get like information about page<a class="headerlink" href="#likeunlike-client-side-page-get-like-information-about-page" title="Permanent link">¶</a></h2>
|
1887
|
+
<p>Added in <em>1.2.4</em></p>
|
1888
|
+
<p>You can like or unlike a modern page. You can also get information about the likes (i.e like Count and which users liked the page)</p>
|
1889
|
+
<div class="codehilite"><pre><span></span><span class="c1">// Like a Client-side page (Added in _1.2.4_)</span>
|
1890
|
+
<span class="nx">await</span> <span class="nx">page</span><span class="p">.</span><span class="nx">like</span><span class="p">();</span>
|
1891
|
+
|
1892
|
+
<span class="c1">// Unlike a Client-side page</span>
|
1893
|
+
<span class="nx">await</span> <span class="nx">page</span><span class="p">.</span><span class="nx">unlike</span><span class="p">();</span>
|
1894
|
+
|
1895
|
+
<span class="c1">// Get liked by information such as like count and user's who liked the page</span>
|
1896
|
+
<span class="nx">await</span> <span class="nx">page</span><span class="p">.</span><span class="nx">getLikedByInformation</span><span class="p">();</span>
|
1897
|
+
</pre></div>
|
1898
|
+
|
1899
|
+
|
1900
|
+
<h2 id="sample">Sample<a class="headerlink" href="#sample" title="Permanent link">¶</a></h2>
|
1901
|
+
<p>The below sample shows the process to add a Yammer feed webpart to the page. The properties required as well as the data version are found by adding the part using the UI and reviewing the values. Some or all of these may be discoverable using <a href="https://developer.microsoft.com/en-us/yammer/docs">Yammer APIs</a>. An identical process can be used to add web parts of any type by adjusting the definition, data version, and properties appropriately.</p>
|
1902
|
+
<div class="codehilite"><pre><span></span><span class="c1">// get webpart defs</span>
|
1903
|
+
<span class="kr">const</span> <span class="nx">defs</span> <span class="o">=</span> <span class="nx">await</span> <span class="nx">sp</span><span class="p">.</span><span class="nx">web</span><span class="p">.</span><span class="nx">getClientSideWebParts</span><span class="p">();</span>
|
1904
|
+
|
1905
|
+
<span class="c1">// this is the id of the definition in my farm</span>
|
1906
|
+
<span class="kr">const</span> <span class="nx">yammerPartDef</span> <span class="o">=</span> <span class="nx">defs</span><span class="p">.</span><span class="nx">filter</span><span class="p">(</span><span class="nx">d</span> <span class="o">=></span> <span class="nx">d</span><span class="p">.</span><span class="nx">Id</span> <span class="o">===</span> <span class="s2">"31e9537e-f9dc-40a4-8834-0e3b7df418bc"</span><span class="p">)[</span><span class="mi">0</span><span class="p">];</span>
|
1907
|
+
|
1908
|
+
<span class="c1">// page file</span>
|
1909
|
+
<span class="kr">const</span> <span class="nx">file</span> <span class="o">=</span> <span class="nx">sp</span><span class="p">.</span><span class="nx">web</span><span class="p">.</span><span class="nx">getFileByServerRelativePath</span><span class="p">(</span><span class="s2">"/sites/dev/SitePages/Testing_kVKF.aspx"</span><span class="p">);</span>
|
1910
|
+
|
1911
|
+
<span class="c1">// create page instance</span>
|
1912
|
+
<span class="kr">const</span> <span class="nx">page</span> <span class="o">=</span> <span class="nx">await</span> <span class="nx">ClientSidePage</span><span class="p">.</span><span class="nx">fromFile</span><span class="p">(</span><span class="nx">file</span><span class="p">);</span>
|
1913
|
+
|
1914
|
+
<span class="c1">// create part instance from definition</span>
|
1915
|
+
<span class="kr">const</span> <span class="nx">part</span> <span class="o">=</span> <span class="nx">ClientSideWebpart</span><span class="p">.</span><span class="nx">fromComponentDef</span><span class="p">(</span><span class="nx">yammerPartDef</span><span class="p">);</span>
|
1916
|
+
|
1917
|
+
<span class="c1">// update data version</span>
|
1918
|
+
<span class="nx">part</span><span class="p">.</span><span class="nx">dataVersion</span> <span class="o">=</span> <span class="s2">"1.5"</span><span class="p">;</span>
|
1919
|
+
|
1920
|
+
<span class="c1">// set the properties required</span>
|
1921
|
+
<span class="nx">part</span><span class="p">.</span><span class="nx">setProperties</span><span class="p">({</span>
|
1922
|
+
<span class="nx">feedType</span>: <span class="kt">0</span><span class="p">,</span>
|
1923
|
+
<span class="nx">isSuiteConnected</span>: <span class="kt">false</span><span class="p">,</span>
|
1924
|
+
<span class="nx">mode</span>: <span class="kt">2</span><span class="p">,</span>
|
1925
|
+
<span class="nx">networkId</span>: <span class="kt">9999999</span><span class="p">,</span>
|
1926
|
+
<span class="nx">yammerEmbedContainerHeight</span>: <span class="kt">400</span><span class="p">,</span>
|
1927
|
+
<span class="nx">yammerFeedURL</span><span class="o">:</span> <span class="s2">""</span><span class="p">,</span>
|
1928
|
+
<span class="nx">yammerGroupId</span><span class="o">:</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span>
|
1929
|
+
<span class="nx">yammerGroupMugshotUrl</span><span class="o">:</span> <span class="s2">"https://mug0.assets-yammer.com/mugshot/images/{width}x{height}/all_company.png"</span><span class="p">,</span>
|
1930
|
+
<span class="nx">yammerGroupName</span><span class="o">:</span> <span class="s2">"All Company"</span><span class="p">,</span>
|
1931
|
+
<span class="nx">yammerGroupUrl</span><span class="o">:</span> <span class="s2">"https://www.yammer.com/{tenant}/#/threads/company?type=general"</span><span class="p">,</span>
|
1932
|
+
<span class="p">});</span>
|
1933
|
+
|
1934
|
+
<span class="c1">// add to the section/column you want</span>
|
1935
|
+
<span class="nx">page</span><span class="p">.</span><span class="nx">sections</span><span class="p">[</span><span class="mi">0</span><span class="p">].</span><span class="nx">addControl</span><span class="p">(</span><span class="nx">part</span><span class="p">);</span>
|
1936
|
+
|
1937
|
+
<span class="c1">// persist changes</span>
|
1938
|
+
<span class="nx">page</span><span class="p">.</span><span class="nx">save</span><span class="p">();</span>
|
1939
|
+
</pre></div>
|
1940
|
+
|
1941
|
+
|
1942
|
+
|
1943
|
+
|
1944
|
+
|
1945
|
+
|
1946
|
+
|
1947
|
+
|
1948
|
+
|
1949
|
+
</article>
|
1950
|
+
</div>
|
1951
|
+
</div>
|
1952
|
+
</main>
|
1953
|
+
|
1954
|
+
|
1955
|
+
<footer class="md-footer">
|
1956
|
+
|
1957
|
+
<div class="md-footer-nav">
|
1958
|
+
<nav class="md-footer-nav__inner md-grid">
|
1959
|
+
|
1960
|
+
<a href="../attachments/" title="Attachments" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
|
1961
|
+
<div class="md-flex__cell md-flex__cell--shrink">
|
1962
|
+
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
|
1963
|
+
</div>
|
1964
|
+
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
|
1965
|
+
<span class="md-flex__ellipsis">
|
1966
|
+
<span class="md-footer-nav__direction">
|
1967
|
+
Previous
|
1968
|
+
</span>
|
1969
|
+
Attachments
|
1970
|
+
</span>
|
1971
|
+
</div>
|
1972
|
+
</a>
|
1973
|
+
|
1974
|
+
|
1975
|
+
<a href="../content-types/" title="Content Types" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
|
1976
|
+
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
|
1977
|
+
<span class="md-flex__ellipsis">
|
1978
|
+
<span class="md-footer-nav__direction">
|
1979
|
+
Next
|
1980
|
+
</span>
|
1981
|
+
Content Types
|
1982
|
+
</span>
|
1983
|
+
</div>
|
1984
|
+
<div class="md-flex__cell md-flex__cell--shrink">
|
1985
|
+
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
|
1986
|
+
</div>
|
1987
|
+
</a>
|
1988
|
+
|
1989
|
+
</nav>
|
1990
|
+
</div>
|
1991
|
+
|
1992
|
+
<div class="md-footer-meta md-typeset">
|
1993
|
+
<div class="md-footer-meta__inner md-grid">
|
1994
|
+
<div class="md-footer-copyright">
|
1995
|
+
|
1996
|
+
powered by
|
1997
|
+
<a href="https://www.mkdocs.org">MkDocs</a>
|
1998
|
+
and
|
1999
|
+
<a href="https://squidfunk.github.io/mkdocs-material/">
|
2000
|
+
Material for MkDocs</a>
|
2001
|
+
</div>
|
2002
|
+
|
2003
|
+
|
2004
|
+
<div class="md-footer-social">
|
2005
|
+
<link rel="stylesheet" href="../../../assets/fonts/font-awesome.css">
|
2006
|
+
|
2007
|
+
<a href="https://twitter.com/officedevpnp" class="md-footer-social__link fa fa-twitter"></a>
|
2008
|
+
|
2009
|
+
<a href="http://aka.ms/sppnp-videos" class="md-footer-social__link fa fa-youtube"></a>
|
2010
|
+
|
2011
|
+
<a href="https://aka.ms/sppnp" class="md-footer-social__link fa fa-link"></a>
|
2012
|
+
|
2013
|
+
</div>
|
2014
|
+
|
2015
|
+
|
2016
|
+
</div>
|
2017
|
+
</div>
|
2018
|
+
</footer>
|
2019
|
+
|
2020
|
+
</div>
|
2021
|
+
|
2022
|
+
<script src="../../../assets/javascripts/application.583bbe55.js"></script>
|
2023
|
+
|
2024
|
+
<script>app.initialize({version:"1.0.1",url:{base:"../../.."}})</script>
|
2025
|
+
|
2026
|
+
|
2027
|
+
|
2028
|
+
<img src="https://telemetry.sharepointpnp.com/@pnp/pnpjs/ghpages/pnpjs/sp/docs/client-side-pages/" alt="spacer" />
|
2029
|
+
|
2030
|
+
</body>
|
2031
|
+
</html>
|