Added remote container and sample.json
This commit is contained in:
Hugo Bernier
parent
0efddc896e
commit
5d38fc0d4f
|
|
@ -0,0 +1,39 @@
|
|||
// For more information on how to run this SPFx project in a VS Code Remote Container, please visit https://aka.ms/spfx-devcontainer
|
||||
{
|
||||
"name": "SPFx 1.13.1",
|
||||
"image": "docker.io/m365pnp/spfx:1.13.1",
|
||||
// Set *default* container specific settings.json values on container create.
|
||||
"settings": {},
|
||||
// Add the IDs of extensions you want installed when the container is created.
|
||||
"extensions": [
|
||||
"editorconfig.editorconfig",
|
||||
"dbaeumer.vscode-eslint"
|
||||
],
|
||||
// Use 'forwardPorts' to make a list of ports inside the container available locally.
|
||||
"forwardPorts": [
|
||||
4321,
|
||||
35729
|
||||
],
|
||||
"portsAttributes": {
|
||||
"4321": {
|
||||
"protocol": "https",
|
||||
"label": "Manifest",
|
||||
"onAutoForward": "silent",
|
||||
"requireLocalPort": true
|
||||
},
|
||||
// Not needed for SPFx>= 1.12.1
|
||||
// "5432": {
|
||||
// "protocol": "https",
|
||||
// "label": "Workbench",
|
||||
// "onAutoForward": "silent"
|
||||
// },
|
||||
"35729": {
|
||||
"protocol": "https",
|
||||
"label": "LiveReload",
|
||||
"onAutoForward": "silent",
|
||||
"requireLocalPort": true
|
||||
}
|
||||
},
|
||||
"postCreateCommand": "bash .devcontainer/spfx-startup.sh",
|
||||
"remoteUser": "node"
|
||||
}
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
echo
|
||||
echo -e "\e[1;94mInstalling Node dependencies\e[0m"
|
||||
npm install
|
||||
|
||||
## commands to create dev certificate and copy it to the root folder of the project
|
||||
echo
|
||||
echo -e "\e[1;94mGenerating dev certificate\e[0m"
|
||||
gulp trust-dev-cert
|
||||
|
||||
# Convert the generated PEM certificate to a CER certificate
|
||||
openssl x509 -inform PEM -in ~/.rushstack/rushstack-serve.pem -outform DER -out ./spfx-dev-cert.cer
|
||||
|
||||
# Copy the PEM ecrtificate for non-Windows hosts
|
||||
cp ~/.rushstack/rushstack-serve.pem ./spfx-dev-cert.pem
|
||||
|
||||
## add *.cer to .gitignore to prevent certificates from being saved in repo
|
||||
if ! grep -Fxq '*.cer' ./.gitignore
|
||||
then
|
||||
echo "# .CER Certificates" >> .gitignore
|
||||
echo "*.cer" >> .gitignore
|
||||
fi
|
||||
|
||||
## add *.pem to .gitignore to prevent certificates from being saved in repo
|
||||
if ! grep -Fxq '*.pem' ./.gitignore
|
||||
then
|
||||
echo "# .PEM Certificates" >> .gitignore
|
||||
echo "*.pem" >> .gitignore
|
||||
fi
|
||||
|
||||
echo
|
||||
echo -e "\e[1;92mReady!\e[0m"
|
||||
|
||||
echo -e "\n\e[1;94m**********\nOptional: if you plan on using gulp serve, don't forget to add the container certificate to your local machine. Please visit https://aka.ms/spfx-devcontainer for more information\n**********"
|
||||
|
|
@ -31,3 +31,7 @@ obj
|
|||
|
||||
# Styles Generated Code
|
||||
*.scss.ts
|
||||
# .CER Certificates
|
||||
*.cer
|
||||
# .PEM Certificates
|
||||
*.pem
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
## Summary
|
||||
|
||||
SPFx Webpart to Hide/UnHide lists in a Site Collection's Site Contents Page.
|
||||
SPFx Web part to Hide/UnHide lists in a Site Collection's Site Contents Page.
|
||||
|
||||
|
||||
|
||||
|
|
@ -12,13 +12,13 @@ For example: we may have created a PowerApps form and need to hide master lists
|
|||
|
||||
So that once the list is hidden, users cannot access the list directly from Site Contents or without knowing list name or list URL.
|
||||
|
||||
There are multiple ways to do this by using PowerShell Scripts, Rest Api & MS Flows.
|
||||
There are multiple ways to do this by using PowerShell Scripts, Rest API & MS Flows.
|
||||
|
||||
Here same functionality is achieved using SPFx Webpart, which we can just be added to a Site Collection and it will list out the lists and libraries in the site and Site Admin can Hide/Unhide lists with a simple button click.
|
||||
Here same functionality is achieved using SPFx web part, which we can just be added to a Site Collection and it will list out the lists and libraries in the site and Site Admin can Hide/Unhide lists with a simple button click.
|
||||
|
||||
This Webpart will be accessible only to users with Site Collection Admin access.
|
||||
This web part will be accessible only to users with Site Collection Admin access.
|
||||
|
||||
PnP Js library to get relevant SharePoint lists and libraries from current Site Collection and use "Hidden" property of lists to hide/Unhide.
|
||||
PnP JS library to get relevant SharePoint lists and libraries from current Site Collection and use "Hidden" property of lists to hide/Unhide.
|
||||
|
||||
|
||||
|
||||
|
|
@ -31,41 +31,8 @@ PnP Js library to get relevant SharePoint lists and libraries from current Site
|
|||
-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
|
||||
|
||||
|
||||
<!--
|
||||
If using SPFx 1.13.1, update the SPFx and Node.js tags accordingly:
|
||||
|
||||
If using SPFx 1.12.1, update the SPFx and Node.js tags accordingly:
|
||||
|
||||
|
||||
If using an older version of SPFx, update the SPFx and Node.js compatibility tag accordingly:
|
||||
SPFx 1.11
|
||||
|
||||
|
||||
SPFx 1.10
|
||||
|
||||
|
||||
SPFx 1.4.1
|
||||
|
||||
|
||||
If you built this sample specifically for SharePoint 2016, or SharePoint 2019 support, update the SharePoint compatibility tag accordingly:
|
||||
|
||||
-Compatible-green.svg)
|
||||
If you know your web part only works on the hosted workbench, you can use this for the workbench compatibility tag:
|
||||
|
||||
Otherwise:
|
||||
|
||||
If your web part needs permissions before working in the hosted workbench, let people know;
|
||||
-yellow.svg "Requires permissions to be granted before this solution can work on the hosted workbench")
|
||||
or:
|
||||
|
||||
Otherwise:
|
||||
|
||||
If you specifically built and tested this web part to work with Teams, use this for the Teams compatibility tag:
|
||||
|
||||
And if you know for sure that it is NOT compatible with Teams, use this:
|
||||
|
||||
Don't worry if you're unsure about the compatibility matrix above. We'll verify it when we approve the PR.
|
||||
-->
|
||||
|
||||
|
||||
|
||||
## Applies to
|
||||
|
||||
|
|
@ -74,12 +41,7 @@ Don't worry if you're unsure about the compatibility matrix above. We'll verify
|
|||
|
||||
> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram)
|
||||
## Solution
|
||||
<!--
|
||||
We use this section to recognize and promote your contributions. Please provide one author per line -- even if you worked together on it.
|
||||
We'll only use the info you provided here. Make sure to include your full name, not just your GitHub username.
|
||||
Provide a link to your GitHub profile to help others find more cool things you have done.
|
||||
If you provide a link to your Twitter profile, we'll promote your contribution on social media.
|
||||
-->
|
||||
|
||||
|
||||
Solution|Author(s)
|
||||
--------|---------
|
||||
|
|
@ -93,64 +55,30 @@ Version|Date|Comments
|
|||
|
||||
## Prerequisites
|
||||
|
||||
Enusre to have Site Collection Admin access to use this WebPart.
|
||||
Ensure to have Site Collection Admin access to use this web part.
|
||||
|
||||
<!--
|
||||
Any special pre-requisites? Include any lists, permissions, offerings to the demo gods, or whatever else needs to be done for this web part to work.
|
||||
Please describe the steps to configure the pre-requisites. Feel free to add screen shots, but make sure that there is a text description of the steps to perform.
|
||||
|
||||
-->
|
||||
|
||||
## Minimal Path to Awesome
|
||||
## Minimal path to awesome
|
||||
|
||||
<!--
|
||||
PRO TIP:
|
||||
For commands, use the `code syntax`
|
||||
For button labels, page names, dialog names, etc. as they appear on the screen, use **Bold**
|
||||
Don't use "click", use "select" or "use"
|
||||
As tempting as it may be, don't just use images to describe the steps. Let's be as inclusive as possible and think about accessibility.
|
||||
-->
|
||||
|
||||
* Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-lists-hide) then unzip it)
|
||||
* From your command line, change your current directory to the directory containing this sample (`react-lists-hide`, located under `samples`)
|
||||
* in the command line run:
|
||||
* `npm install`
|
||||
* **Update your SharePoint Site Url in serve.json**
|
||||
* **Update your SharePoint Site URL in `serve.json`**
|
||||
* `gulp serve`
|
||||
|
||||
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit https://aka.ms/spfx-devcontainer for further instructions.
|
||||
>
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
* List Out available Lists and Libraries based on template in current Site Collection
|
||||
* Hide/Unhide Lists on button click
|
||||
|
||||
<!--
|
||||
Note that better pictures and documentation will increase the sample usage and the value you are providing for others. Thanks for your submissions in advance! You rock ❤.
|
||||
-->
|
||||
|
||||
<!--
|
||||
RESERVED FOR REPO MAINTAINERS
|
||||
We'll add the video from the community call recording here
|
||||
## Video
|
||||
[](https://www.youtube.com/watch?v=XXXXX "YouTube video title")
|
||||
-->
|
||||
|
||||
## Help
|
||||
|
||||
<!--
|
||||
You can just search and replace this page with the following values:
|
||||
Search for:
|
||||
YOUR-SOLUTION-NAME
|
||||
Replace with your sample folder name. E.g.: react-my-cool-sample
|
||||
Search for:
|
||||
@YOURGITHUBUSERNAME
|
||||
Replace with your GitHub username, prefixed with an "@". If you have more than one author, use %20 to separate them, making sure to prefix everyone's username individually with an "@".
|
||||
Example:
|
||||
@hugoabernier
|
||||
Or:
|
||||
@hugoabernier%20@VesaJuvonen%20@PopWarner
|
||||
-->
|
||||
|
||||
We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,56 @@
|
|||
[
|
||||
{
|
||||
"name": "pnp-sp-dev-spfx-web-parts-react-hide-lists",
|
||||
"source": "pnp",
|
||||
"title": "Hide Lists",
|
||||
"shortDescription": "SPFx Web part to Hide/UnHide lists in a Site Collection's Site Contents Page.",
|
||||
"url": "https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-hide-lists",
|
||||
"downloadUrl": "https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-hide-lists",
|
||||
"longDescription": [
|
||||
"SPFx Web part to Hide/UnHide lists in a Site Collection's Site Contents Page."
|
||||
],
|
||||
"creationDateTime": "2022-02-27",
|
||||
"updateDateTime": "2022-02-27",
|
||||
"products": [
|
||||
"SharePoint"
|
||||
],
|
||||
"metadata": [
|
||||
{
|
||||
"key": "CLIENT-SIDE-DEV",
|
||||
"value": "React"
|
||||
},
|
||||
{
|
||||
"key": "SPFX-VERSION",
|
||||
"value": "1.14"
|
||||
}
|
||||
],
|
||||
"thumbnails": [
|
||||
{
|
||||
"type": "image",
|
||||
"order": 100,
|
||||
"url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-hide-lists/assets/ListHideWebPart.jpg",
|
||||
"alt": "Web Part Preview"
|
||||
},
|
||||
{
|
||||
"type": "image",
|
||||
"order": 101,
|
||||
"url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-hide-lists/assets/listHidewp.gif",
|
||||
"alt": "Web Part Preview"
|
||||
}
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"gitHubAccount": "SandeepDev365",
|
||||
"pictureUrl": "https://github.com/SandeepDev365.png",
|
||||
"name": "Sandeep Unnikrishnan"
|
||||
}
|
||||
],
|
||||
"references": [
|
||||
{
|
||||
"name": "Build your first SharePoint client-side web part",
|
||||
"description": "Client-side web parts are client-side components that run in the context of a SharePoint page. Client-side web parts can be deployed to SharePoint environments that support the SharePoint Framework. You can also use modern JavaScript web frameworks, tools, and libraries to build them.",
|
||||
"url": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
|
|
@ -2,12 +2,20 @@
|
|||
|
||||
<!--
|
||||
This is how you want the sample to appear in the samples browser.
|
||||
When naming your sample, try to give it a friendly name that describes what it does. Avoid using terms like `SharePoint` and `WebPart` -- because that's what all the samples in this repo is all about. Also, don't use `React`, `Angular`, `JavaScript`, etc. in your sample title -- unless that's what the sample is about.
|
||||
When naming your sample, try to give it a friendly name that describes what it does. Avoid using terms like `SharePoint` and `web part` -- because that's what all the samples in this repo is all about. Also, don't use `React`, `Angular`, `JavaScript`, etc. in your sample title -- unless that's what the sample is about.
|
||||
GOOD 👍:
|
||||
Kitten Videos
|
||||
BAD 👎:
|
||||
react-kittenvideos
|
||||
SPFx Kitten Videos Web Part for SharePoint using React
|
||||
|
||||
NOTE:
|
||||
It is "web part", not "webpart" -- unless when used in a class
|
||||
"OneDrive", not "OneDrive"
|
||||
"SharePoint" not "Sharepoint"
|
||||
"PowerShell" not "Powershell"
|
||||
"JavaScript" not "Javascript"
|
||||
|
||||
-->
|
||||
|
||||
## Summary
|
||||
|
|
@ -33,7 +41,7 @@ You can add as many screen shots as you'd like to help users understand your web
|
|||
## Compatibility
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
|
||||
|
|
@ -42,7 +50,7 @@ You can add as many screen shots as you'd like to help users understand your web
|
|||
|
||||
<!--
|
||||
If using SPFx 1.13.1, update the SPFx and Node.js tags accordingly:
|
||||
|
||||
<!--  -->
|
||||
|
||||
If using SPFx 1.12.1, update the SPFx and Node.js tags accordingly:
|
||||
|
||||
|
|
@ -127,7 +135,7 @@ Please describe the steps to configure the pre-requisites. Feel free to add scre
|
|||
|
||||
-->
|
||||
|
||||
## Minimal Path to Awesome
|
||||
## Minimal path to awesome
|
||||
|
||||
<!--
|
||||
PRO TIP:
|
||||
|
|
@ -148,11 +156,11 @@ As tempting as it may be, don't just use images to describe the steps. Let's be
|
|||
* `npm install`
|
||||
* `gulp serve`
|
||||
|
||||
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit https://aka.ms/spfx-devcontainer for further instructions.
|
||||
>
|
||||
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit <https://aka.ms/spfx-devcontainer> for further instructions.
|
||||
|
||||
## Features
|
||||
|
||||
Description of the web part with possible additional details than in short summary.
|
||||
Description of the web part with possible additional details than in short summary.
|
||||
This Web Part illustrates the following concepts on top of the SharePoint Framework:
|
||||
|
||||
* topic 1
|
||||
|
|
@ -203,17 +211,14 @@ You can try looking at [issues related to this sample](https://github.com/pnp/sp
|
|||
|
||||
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=YOUR-SOLUTION-NAME) and see what the community is saying.
|
||||
|
||||
If you encounter any issues while using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20YOUR-SOLUTION-NAME&template=bug-report.yml&sample=YOUR-SOLUTION-NAME&authors=@YOURGITHUBUSERNAME&title=YOUR-SOLUTION-NAME%20-%20).
|
||||
If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20YOUR-SOLUTION-NAME&template=bug-report.yml&sample=YOUR-SOLUTION-NAME&authors=@YOURGITHUBUSERNAME&title=YOUR-SOLUTION-NAME%20-%20).
|
||||
|
||||
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20YOUR-SOLUTION-NAME&template=question.yml&sample=YOUR-SOLUTION-NAME&authors=@YOURGITHUBUSERNAME&title=YOUR-SOLUTION-NAME%20-%20).
|
||||
|
||||
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20YOUR-SOLUTION-NAME&template=suggestion.yml&sample=YOUR-SOLUTION-NAME&authors=@YOURGITHUBUSERNAME&title=YOUR-SOLUTION-NAME%20-%20).
|
||||
|
||||
|
||||
## Disclaimer
|
||||
|
||||
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
|
||||
|
||||
|
||||
<img src="https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/YOUR-SOLUTION-NAME" />
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@
|
|||
"title": "YOUR-SAMPLE-TITLE",
|
||||
"shortDescription": "YOUR-SHORT-DESCRIPTION",
|
||||
"url": "https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/YOUR-SAMPLE-NAME",
|
||||
"downloadUrl": "https://download.url/file.zip",
|
||||
"longDescription": [
|
||||
"YOUR-SHORT-DESCRIPTION"
|
||||
],
|
||||
|
|
|
|||
Loading…
Reference in New Issue