Skip to content

Commit

Permalink
Merge branch 'version-4'
Browse files Browse the repository at this point in the history
  • Loading branch information
Julie Turner committed May 6, 2024
2 parents fd16508 + a111ec8 commit a3ed963
Show file tree
Hide file tree
Showing 48 changed files with 32,046 additions and 1,203 deletions.
39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
22 changes: 11 additions & 11 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
#### Category
### Category

- [ ] Bug fix?
- [ ] New feature?
- [ ] New sample?
- [ ] Documentation update?

#### Related Issues
### Related Issues

fixes #X, mentioned in #Y

#### What's in this Pull Request?
### What's in this Pull Request?

*Please describe the changes in this PR. Simple description of the contents of this PR so folks reviewing can easily understand what it contains.*

#### Guidance

*You can delete this section when you are submitting the pull request.*
### Guidance

* Please update this PR information accordingly. We'll use this as part of our release notes in monthly communications.
* Please target your PR to "version-3" branch for v3 changes
* Please ensure you have updated any associated docs files based on your code changes
* Please ensure you have updated/added tests to cover your change.
* If you are fixing a bug include a test that would have caught the bug you are fixing
*You can delete this section when you are submitting the pull request.*

- Please update this PR information accordingly. We'll use this as part of our release notes in monthly communications.
- Please target your PR to "version-4" branch for v4 changes
- Please ensure you have updated any associated docs files based on your code changes
- Please ensure you have updated/added tests to cover your change.
- If you are fixing a bug include a test that would have caught the bug you are fixing
10 changes: 6 additions & 4 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,17 @@ Next we can import and use the functionality within our application. Below is a

## Getting Started with SharePoint Framework

The @pnp/sp and @pnp/graph libraries are designed to work seamlessly within SharePoint Framework projects with a small amount of upfront configuration. If you are running in 2016 or 2019 on-premises you will need to use [version 2](./v2/SPFx-on-premises/index.html) of the library. If you are targeting SharePoint online you will need to take the additional steps outlined below based on the version of the SharePoint Framework you are targeting.
The @pnp/sp and @pnp/graph libraries are designed to work seamlessly within SharePoint Framework projects with a small amount of upfront configuration. If you are running in 2016 or 2019 on-premises you will need to use [version 2](./v2/SPFx-on-premises/index.html) of the library. If you are targeting SharePoint online you may need to take the additional steps outlined below based on the version of the SharePoint Framework you are targeting.

We've created two Getting Started samples. The first uses the more traditional React Component classes and can be found in the [react-pnp-js-sample](https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-pnp-js-sample) project, utilizing SPFx 1.15.2 and PnPjs V3, it showcases some of the more dramatic changes to the library. There is also a companion video series on YouTube if you prefer to see things done through that medium here's a link to the playlist for the 5 part series:
We've created two Getting Started samples. The first uses the more traditional React Component classes and can be found in the [spfx-react-components](../samples/spfx-react-components/README.md) sample project, utilizing SPFx 1.18.2 and PnPjs V4.

Although original created for V3, this 5 part video series is similar enough to v4 to give good direction for getting started with PnPjs:

[Getting started with PnPjs 3.0: 5-part series](https://youtube.com/playlist?list=PLR9nK3mnD-OWvmtj9TKE6tM7ZrUosV_vB)

In addition, we have converted the sample project from React Component to React Hooks. This version can be found in [react-pnp-js-hooks](https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-pnp-js-hooks). This sample will help those struggling to establish context correctly while using the hooks conventions.
Also, again although this sample uses V3 of PnPjs it's a good getting started sample if you want to use PnPjs with React Hooks. This version can be found in [react-pnp-js-hooks](https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-pnp-js-hooks). This sample will help those struggling to establish context correctly while using the hooks conventions.

The SharePoint Framework supports different versions of NodeJS and TypeScript natively. Because of dependency updates we've made to PnPjs Version 4 is only compatible with NodeJS v18.x and therefore is not supported on SPFx version before 1.18.x.
The SharePoint Framework supports different versions of NodeJS and TypeScript natively. Because of dependency updates we've made to PnPjs Version 4 is only compatible with NodeJS v18.x and therefore is not supported on SPFx version before 1.18.x.

### SPFx Version 1.18.0 & later

Expand Down
16 changes: 8 additions & 8 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ nav:
- util: 'core/util.md'
- graph:
- graph: 'packages/#graph'
- admin: 'graph\admin.md'
- analytics: 'graph\analytics.md'
- appCatalog: 'graph\appCatalog.md'
- admin: 'graph/admin.md'
- analytics: 'graph/analytics.md'
- appCatalog: 'graph/appCatalog.md'
- attachments: 'graph/attachments.md'
- behaviors: 'graph/behaviors.md'
- bookings: 'graph/bookings.md'
- columns: 'graph/columns.md'
- compliance: 'graph\compliance.md'
- compliance: 'graph/compliance.md'
- 'content types': 'graph/content-types.md'
- conversations: 'graph/conversations.md'
- groups: 'graph/groups.md'
Expand All @@ -68,20 +68,20 @@ nav:
- 'messages': 'graph/mail-messages.md'
- 'rules': 'graph/mail-rules.md'
- members: 'graph/members.md'
- onenote: 'graph\onenote.md'
- onenote: 'graph/onenote.md'
- outlook: 'graph/outlook.md'
- operations: 'graph/operations.md'
- permissions: 'graph/permissions.md'
- photos: 'graph/photos.md'
- places: 'graph\places.md'
- places: 'graph/places.md'
- planner: 'graph/planner.md'
- search: 'graph/search.md'
- shares: 'graph/shares.md'
- sites: 'graph/sites.md'
- subscriptions: 'graph/subscriptions.md'
- taxonomy: 'graph\taxonomy.md'
- taxonomy: 'graph/taxonomy.md'
- teams: 'graph/teams.md'
- to-do: 'graph\to-do.md'
- to-do: 'graph/to-do.md'
- users: 'graph/users.md'
- logging:
- logging: 'logging/index.md'
Expand Down
Loading

0 comments on commit a3ed963

Please sign in to comment.