Skip to content

Commit

Permalink
Merge pull request #1422 from Sandeep-FED/ver-upgrd-SPFx1.20
Browse files Browse the repository at this point in the history
  • Loading branch information
hugoabernier authored Oct 13, 2024
2 parents 92843c2 + 128495c commit 2eb4af3
Show file tree
Hide file tree
Showing 6 changed files with 20,328 additions and 25,325 deletions.
6 changes: 3 additions & 3 deletions samples/react-application-messagebanner/.yo-rc.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
"@microsoft/generator-sharepoint": {
"isCreatingSolution": false,
"environment": "spo",
"version": "1.18.2",
"version": "1.20.0",
"libraryName": "message-banner",
"libraryId": "004b6d5e-aee8-499b-9fe8-06757cfd043b",
"packageManager": "npm",
"isDomainIsolated": false,
"componentType": "extension",
"extensionType": "ApplicationCustomizer",
"nodeVersion": "18.19.0",
"nodeVersion": "18.18.2",
"sdkVersions": {
"@microsoft/teams-js": "2.12.0",
"@microsoft/teams-js": "2.24.0",
"@microsoft/microsoft-graph-client": "3.0.2"
}
}
Expand Down
23 changes: 17 additions & 6 deletions samples/react-application-messagebanner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ Built using a SharePoint Framework Application Customizer Extension with the Top

## Compatibility

![SPFx 1.14](https://img.shields.io/badge/SPFx-1.14-green.svg)
![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg)
![SPFx 1.20.0](https://img.shields.io/badge/SPFx-1.20.0-green.svg)
![Node.js v18](https://img.shields.io/badge/Node.js-v18-green.svg)
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg "SharePoint Server 2019 requires SPFx 1.4.1 or lower")
![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
![Does not work with SharePoint 2016 (Feature Pack 2)](<https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg> "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
![Local Workbench Unsupported](https://img.shields.io/badge/Local%20Workbench-Unsupported-red.svg "Local workbench is no longer available as of SPFx 1.13 and above")
![Hosted Workbench Incompatible](https://img.shields.io/badge/Hosted%20Workbench-Incompatible-red.svg "Does not work with hosted workbench")

Expand All @@ -33,12 +33,14 @@ Built using a SharePoint Framework Application Customizer Extension with the Top
## Contributors

- [Brad Schlintz](https://github.com/bschlintz)
- [Paul Matthews](https://github.com/pmatthews05)
- [Paul Matthews](https://github.com/pmatthews05)
- [Sandeep P S](https://github.com/Sandeep-FED)

## Version history

| Version | Date | Comments |
| ------- | ------------ | ---------------------------------------------------------------------------------------------------------------------- |
| 1.4.2 | Oct 06, 2024 | Sandeep P S, upgraded to SPFX 1.20.0. |
| 1.4.1 | Feb 10, 2024 | Paul Matthews, upgraded to SPFX 1.18.2. |
| 1.4 | Aug 12, 2022 | Paul Matthews, upgraded to SPFX 1.15.2 obtained permission to submit to PNP Samples. |
| 1.0 | Nov 5, 2109 | Initial Commit 1.0 created by Brad Schlintz at [spfx-message-banner](https://github.com/bschlintz/spfx-message-banner) |
Expand Down Expand Up @@ -89,19 +91,22 @@ Here's a debug URL for testing around this sample. _Note: The '#' is encoded in
## Installing with Script

### Build

```ps1
npm install
gulp clean
gulp build --ship
gulp bundle --ship
gulp package-solution --ship
```

### Upload to App Catalog

#### PowerShell PnP

```ps1
$appCatalogUrl = "https://tenant.sharepoint.com/sites/appcatalog"
Connect-PnPOnline -url:$appCatalogUrl -pnpManagementShell
Connect-PnPOnline -url:$appCatalogUrl -pnpManagementShell
Add-PnPApp -Path:"<path-to: react-application-messagebanner.sppkg>" `
-Publish `
Expand All @@ -110,16 +115,19 @@ Add-PnPApp -Path:"<path-to: react-application-messagebanner.sppkg>" `
```

#### M365 Cli

```bash
m365 login
m365 spo app add --filePath <path-to: react-application-messagebanner.sppkg> --overwrite
m365 spo app deploy --name "react-application-messagebanner.sppkg" --skipFeatureDeployment
```


### Register SPFX Extension on your target SharePoint site(s) using one of the methods below.

- Once added to Tenant App Catalog, you can then add to either Site or Web. The following code examples are for PNP PowerShell or M365 Cli.

#### PowerShell PnP

```ps1
Connect-PnPOnline -Url:"https://tenant.sharepoint.com/sites/targetSite"
Expand Down Expand Up @@ -153,6 +161,7 @@ Add-PnPCustomAction `
```

#### M365 Cli

```bash
m365 login

Expand Down Expand Up @@ -188,6 +197,7 @@ m365 spo customaction add --url "https://tenant.sharepoint.com/sites/targetSite"
### Remove SPFX Extension on your target SharePoint site(s) using one of the methods below.

#### PowerShell PnP

```ps1
Connect-PnPOnline -Url:"https://tenant.sharepoint.com/sites/targetSite"
Expand All @@ -199,6 +209,7 @@ Get-PnPCustomAction -Scope Web | Where-Object {$_.ClientSideComponentId -eq "1e2
```

#### M365 Cli

```bash
m365 login
# Site Collection Scope
Expand Down
4 changes: 2 additions & 2 deletions samples/react-application-messagebanner/assets/sample.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"A react Message Banner sample, allows to add a custom banner message to your SharePoint Online modern sites. Can target either Site or Web Scoped. Allows a site owner to modify the text, font size, colours and height of the banner. Specify a start date to control when the banner is visible to members of a site. Uses the latest v1.15.2 of SPFX framework."
],
"creationDateTime": "2022-11-09",
"updateDateTime": "2024-01-10",
"updateDateTime": "2024-10-06",
"products": [
"SharePoint"
],
Expand All @@ -20,7 +20,7 @@
},
{
"key": "SPFX-VERSION",
"value": "1.18.2"
"value": "1.20.0"
}
],
"thumbnails": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"solution": {
"name": "Message Banner",
"id": "004b6d5e-aee8-499b-9fe8-06757cfd043b",
"version": "1.4.1.0",
"version": "1.4.2.0",
"includeClientSideAssets": true,
"skipFeatureDeployment": true,
"isDomainIsolated": false,
Expand All @@ -30,7 +30,7 @@
"title": "message-banner Feature",
"description": "The feature that activates elements of the message-banner solution.",
"id": "2f5235b8-a888-46a5-9b30-eaf8cfdae04e",
"version": "1.4.0.0"
"version": "1.4.2.0"
}
]
},
Expand Down
Loading

0 comments on commit 2eb4af3

Please sign in to comment.