Merge pull request #2373 from SandeepDev365/main
New Sample - Hide Lists SPFx WebPart
This commit is contained in:
Hugo Bernier
GitHub
commit
9efaa28946
|
|
@ -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**********"
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
# Auto detect text files and perform LF normalization
|
||||
* text=auto
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
# Logs
|
||||
logs
|
||||
*.log
|
||||
npm-debug.log*
|
||||
|
||||
# Dependency directories
|
||||
node_modules
|
||||
|
||||
# Build generated files
|
||||
dist
|
||||
lib
|
||||
release
|
||||
solution
|
||||
temp
|
||||
*.sppkg
|
||||
|
||||
# Coverage directory used by tools like istanbul
|
||||
coverage
|
||||
|
||||
# OSX
|
||||
.DS_Store
|
||||
|
||||
# Visual Studio files
|
||||
.ntvs_analysis.dat
|
||||
.vs
|
||||
bin
|
||||
obj
|
||||
|
||||
# Resx Generated Code
|
||||
*.resx.ts
|
||||
|
||||
# Styles Generated Code
|
||||
*.scss.ts
|
||||
# .CER Certificates
|
||||
*.cer
|
||||
# .PEM Certificates
|
||||
*.pem
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
!dist
|
||||
config
|
||||
|
||||
gulpfile.js
|
||||
|
||||
release
|
||||
src
|
||||
temp
|
||||
|
||||
tsconfig.json
|
||||
tslint.json
|
||||
|
||||
*.log
|
||||
|
||||
.yo-rc.json
|
||||
.vscode
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
{
|
||||
"@microsoft/generator-sharepoint": {
|
||||
"plusBeta": false,
|
||||
"isCreatingSolution": true,
|
||||
"environment": "spo",
|
||||
"version": "1.13.0",
|
||||
"libraryName": "hide-lists-wp",
|
||||
"libraryId": "6c179ebe-a9d0-4916-956f-0b9c6bfad50e",
|
||||
"packageManager": "npm",
|
||||
"isDomainIsolated": false,
|
||||
"componentType": "webpart"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,103 @@
|
|||
# Hide Lists WebPart
|
||||
|
||||
## Summary
|
||||
|
||||
SPFx Web part to Hide/UnHide lists in a Site Collection's Site Contents Page.
|
||||
|
||||
|
||||
|
||||
As Site Admins we may need to hide some lists or libraries in Site Contents from other users who have access to the lists/libraries.
|
||||
|
||||
For example: we may have created a PowerApps form and need to hide master lists or Logs list which has to be kept hidden from end users though they have Read permissions or Edit permissions to the lists/libraries.
|
||||
|
||||
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.
|
||||
|
||||
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 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.
|
||||
|
||||
|
||||
|
||||
## Compatibility
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Applies to
|
||||
|
||||
* [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
|
||||
* [Microsoft 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
|
||||
|
||||
> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram)
|
||||
## Solution
|
||||
|
||||
|
||||
Solution|Author(s)
|
||||
--------|---------
|
||||
react-lists-hide | [Sandeep Unnikrishnan](https://github.com/SandeepDev365/)
|
||||
|
||||
## Version history
|
||||
|
||||
Version|Date|Comments
|
||||
-------|----|--------
|
||||
1.0|February 27, 2022|Initial release
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Ensure to have Site Collection Admin access to use this web part.
|
||||
|
||||
|
||||
## Minimal path to awesome
|
||||
|
||||
|
||||
* 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`**
|
||||
* `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
|
||||
|
||||
|
||||
## Help
|
||||
|
||||
|
||||
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.
|
||||
|
||||
If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
|
||||
|
||||
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-lists-hide%22) to see if anybody else is having the same issues.
|
||||
|
||||
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-lists-hide) 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%20react-lists-hide&template=bug-report.yml&sample=react-lists-hide&authors=@SandeepDev365&title=react-lists-hide%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%20react-lists-hide&template=question.yml&sample=react-lists-hide&authors=@SandeepDev365&title=react-lists-hide%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%20react-lists-hide&template=suggestion.yml&sample=react-lists-hide&authors=@SandeepDev365&title=react-lists-hide%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/react-lists-hide" />
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 169 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 434 KiB |
|
|
@ -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"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
{
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/config.2.0.schema.json",
|
||||
"version": "2.0",
|
||||
"bundles": {
|
||||
"hide-lists-web-part": {
|
||||
"components": [
|
||||
{
|
||||
"entrypoint": "./lib/webparts/hideLists/HideListsWebPart.js",
|
||||
"manifest": "./src/webparts/hideLists/HideListsWebPart.manifest.json"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"externals": {},
|
||||
"localizedResources": {
|
||||
"HideListsWebPartStrings": "lib/webparts/hideLists/loc/{locale}.js"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
{
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/deploy-azure-storage.schema.json",
|
||||
"workingDir": "./release/assets/",
|
||||
"account": "<!-- STORAGE ACCOUNT NAME -->",
|
||||
"container": "hide-lists-wp",
|
||||
"accessKey": "<!-- ACCESS KEY -->"
|
||||
}
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
{
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json",
|
||||
"solution": {
|
||||
"name": "hide-lists-wp-client-side-solution",
|
||||
"id": "6c179ebe-a9d0-4916-956f-0b9c6bfad50e",
|
||||
"version": "1.0.0.0",
|
||||
"includeClientSideAssets": true,
|
||||
"skipFeatureDeployment": true,
|
||||
"isDomainIsolated": false,
|
||||
"developer": {
|
||||
"name": "",
|
||||
"websiteUrl": "",
|
||||
"privacyUrl": "",
|
||||
"termsOfUseUrl": "",
|
||||
"mpnId": "Undefined-1.13.0"
|
||||
}
|
||||
},
|
||||
"paths": {
|
||||
"zippedPackage": "solution/hide-lists-wp.sppkg"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
{
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/core-build/serve.schema.json",
|
||||
"port": 4321,
|
||||
"https": true,
|
||||
"initialPage": "https://enter-your-SharePoint-site/_layouts/workbench.aspx"
|
||||
}
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
{
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/write-manifests.schema.json",
|
||||
"cdnBasePath": "<!-- PATH TO CDN -->"
|
||||
}
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
'use strict';
|
||||
|
||||
const build = require('@microsoft/sp-build-web');
|
||||
|
||||
build.addSuppression(`Warning - [sass] The local CSS class 'ms-Grid' is not camelCase and will not be type-safe.`);
|
||||
|
||||
var getTasks = build.rig.getTasks;
|
||||
build.rig.getTasks = function () {
|
||||
var result = getTasks.call(build.rig);
|
||||
|
||||
result.set('serve', result.get('serve-deprecated'));
|
||||
|
||||
return result;
|
||||
};
|
||||
|
||||
build.initialize(require('gulp'));
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,39 @@
|
|||
{
|
||||
"name": "hide-lists-wp",
|
||||
"version": "0.0.1",
|
||||
"private": true,
|
||||
"main": "lib/index.js",
|
||||
"scripts": {
|
||||
"build": "gulp bundle",
|
||||
"clean": "gulp clean",
|
||||
"test": "gulp test"
|
||||
},
|
||||
"dependencies": {
|
||||
"@fluentui/react": "^8.55.1",
|
||||
"@microsoft/sp-core-library": "1.13.0",
|
||||
"@microsoft/sp-lodash-subset": "1.13.0",
|
||||
"@microsoft/sp-office-ui-fabric-core": "1.13.0",
|
||||
"@microsoft/sp-property-pane": "1.13.0",
|
||||
"@microsoft/sp-webpart-base": "1.13.0",
|
||||
"@pnp/common": "^2.12.0",
|
||||
"@pnp/logging": "^2.12.0",
|
||||
"@pnp/odata": "^2.12.0",
|
||||
"@pnp/sp": "^2.12.0",
|
||||
"bootstrap": "^5.1.3",
|
||||
"office-ui-fabric-react": "7.174.1",
|
||||
"react": "16.13.1",
|
||||
"react-dom": "16.13.1",
|
||||
"react-table-6": "^6.11.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/react": "16.9.51",
|
||||
"@types/react-dom": "16.9.8",
|
||||
"@microsoft/sp-build-web": "1.13.0",
|
||||
"@microsoft/sp-tslint-rules": "1.13.0",
|
||||
"@microsoft/sp-module-interfaces": "1.13.0",
|
||||
"@microsoft/rush-stack-compiler-3.9": "0.4.47",
|
||||
"gulp": "~4.0.2",
|
||||
"ajv": "~5.2.2",
|
||||
"@types/webpack-env": "1.13.1"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
export const CallOutMessages: any = {
|
||||
hideList: "Do you want to Hide this List?",
|
||||
unHideList: "Do you want to Un-hide this List?"
|
||||
};
|
||||
|
||||
export const buttonTexts: any = {
|
||||
hide: "Hide",
|
||||
Unhide: "Un-hide"
|
||||
};
|
||||
|
|
@ -0,0 +1 @@
|
|||
// A file is required to be in the root of the /src directory by the TypeScript compiler
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
{
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/spfx/client-side-web-part-manifest.schema.json",
|
||||
"id": "1b1dc257-2f1f-4255-a742-148a73e7be99",
|
||||
"alias": "HideListsWebPart",
|
||||
"componentType": "WebPart",
|
||||
|
||||
// The "*" signifies that the version should be taken from the package.json
|
||||
"version": "*",
|
||||
"manifestVersion": 2,
|
||||
|
||||
// If true, the component can only be installed on sites where Custom Script is allowed.
|
||||
// Components that allow authors to embed arbitrary script code should set this to true.
|
||||
// https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f
|
||||
"requiresCustomScript": false,
|
||||
"supportedHosts": ["SharePointWebPart", "TeamsPersonalApp", "TeamsTab", "SharePointFullPage"],
|
||||
"supportsThemeVariants": true,
|
||||
|
||||
"preconfiguredEntries": [{
|
||||
"groupId": "5c03119e-3074-46fd-976b-c60198311f70", // Other
|
||||
"group": { "default": "Other" },
|
||||
"title": { "default": "HideLists" },
|
||||
"description": { "default": "This WebPart is used to show all lists in Site collection with an option to hide lists from site contents" },
|
||||
"officeFabricIconFontName": "Page",
|
||||
"properties": {
|
||||
"description": "HideLists"
|
||||
}
|
||||
}]
|
||||
}
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
import * as React from 'react';
|
||||
import * as ReactDom from 'react-dom';
|
||||
import { Version } from '@microsoft/sp-core-library';
|
||||
import {
|
||||
IPropertyPaneConfiguration,
|
||||
PropertyPaneTextField
|
||||
} from '@microsoft/sp-property-pane';
|
||||
import { BaseClientSideWebPart } from '@microsoft/sp-webpart-base';
|
||||
|
||||
import * as strings from 'HideListsWebPartStrings';
|
||||
import HideLists from './components/HideLists';
|
||||
import { sp } from '@pnp/sp';
|
||||
|
||||
export interface IHideListsWebPartProps {
|
||||
description: string;
|
||||
}
|
||||
|
||||
export default class HideListsWebPart extends BaseClientSideWebPart<IHideListsWebPartProps> {
|
||||
|
||||
private listsinSiteCollection = [];
|
||||
|
||||
protected onInit(): Promise<void> {
|
||||
return super.onInit().then(_ => {
|
||||
sp.setup({
|
||||
spfxContext: this.context
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
public render(): void {
|
||||
const element: React.ReactElement = React.createElement(
|
||||
HideLists,
|
||||
{
|
||||
ctx: this.context
|
||||
}
|
||||
);
|
||||
|
||||
ReactDom.render(element, this.domElement);
|
||||
}
|
||||
|
||||
protected onDispose(): void {
|
||||
ReactDom.unmountComponentAtNode(this.domElement);
|
||||
}
|
||||
|
||||
protected get dataVersion(): Version {
|
||||
return Version.parse('1.0');
|
||||
}
|
||||
|
||||
protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
|
||||
return {
|
||||
pages: [
|
||||
{
|
||||
header: {
|
||||
description: strings.PropertyPaneDescription
|
||||
},
|
||||
groups: [
|
||||
{
|
||||
groupName: strings.BasicGroupName,
|
||||
groupFields: [
|
||||
PropertyPaneTextField('description', {
|
||||
label: strings.DescriptionFieldLabel
|
||||
})
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
};
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,74 @@
|
|||
@import '~office-ui-fabric-react/dist/sass/References.scss';
|
||||
|
||||
.hideLists {
|
||||
.container {
|
||||
max-width: 700px;
|
||||
margin: 0px auto;
|
||||
box-shadow: 0 2px 4px 0 rgba(0, 0, 0, 0.2), 0 25px 50px 0 rgba(0, 0, 0, 0.1);
|
||||
}
|
||||
|
||||
.row {
|
||||
@include ms-Grid-row;
|
||||
@include ms-fontColor-white;
|
||||
background-color: $ms-color-themeDark;
|
||||
padding: 20px;
|
||||
}
|
||||
|
||||
.column {
|
||||
@include ms-Grid-col;
|
||||
@include ms-lg10;
|
||||
@include ms-xl8;
|
||||
@include ms-xlPush2;
|
||||
@include ms-lgPush1;
|
||||
}
|
||||
|
||||
.title {
|
||||
@include ms-font-xl;
|
||||
@include ms-fontColor-white;
|
||||
}
|
||||
|
||||
.subTitle {
|
||||
@include ms-font-l;
|
||||
@include ms-fontColor-white;
|
||||
}
|
||||
|
||||
.description {
|
||||
@include ms-font-l;
|
||||
@include ms-fontColor-white;
|
||||
}
|
||||
|
||||
.button {
|
||||
// Our button
|
||||
text-decoration: none;
|
||||
height: 32px;
|
||||
|
||||
// Primary Button
|
||||
min-width: 80px;
|
||||
background-color: $ms-color-themePrimary;
|
||||
border-color: $ms-color-themePrimary;
|
||||
color: $ms-color-white;
|
||||
|
||||
// Basic Button
|
||||
outline: transparent;
|
||||
position: relative;
|
||||
font-family: "Segoe UI WestEuropean","Segoe UI",-apple-system,BlinkMacSystemFont,Roboto,"Helvetica Neue",sans-serif;
|
||||
-webkit-font-smoothing: antialiased;
|
||||
font-size: $ms-font-size-m;
|
||||
font-weight: $ms-font-weight-regular;
|
||||
border-width: 0;
|
||||
text-align: center;
|
||||
cursor: pointer;
|
||||
display: inline-block;
|
||||
padding: 0 16px;
|
||||
|
||||
.label {
|
||||
font-weight: $ms-font-weight-semibold;
|
||||
font-size: $ms-font-size-m;
|
||||
height: 32px;
|
||||
line-height: 32px;
|
||||
margin: 0 4px;
|
||||
vertical-align: top;
|
||||
display: inline-block;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,242 @@
|
|||
import * as React from 'react';
|
||||
import styles from './HideLists.module.scss';
|
||||
import { IHideListsProps } from './IHideListsProps';
|
||||
import { IHideListsState } from './IHideListsState';
|
||||
import { sp } from "@pnp/sp";
|
||||
import "@pnp/sp/webs";
|
||||
import "@pnp/sp/lists";
|
||||
import "@pnp/sp/site-users/web";
|
||||
import ReactTable from "react-table-6";
|
||||
import 'react-table-6/react-table.css';
|
||||
import 'bootstrap/dist/css/bootstrap.min.css';
|
||||
import { DefaultButton, FocusTrapCallout } from '@microsoft/office-ui-fabric-react-bundle';
|
||||
import { CallOutMessages, buttonTexts } from "../../../Helper/Constant";
|
||||
import { FocusZone, FocusZoneTabbableElements, MessageBarType, PrimaryButton, Stack } from 'office-ui-fabric-react';
|
||||
import { MessageBar, MessageBarButton } from 'office-ui-fabric-react';
|
||||
|
||||
export default class HideLists extends React.Component<IHideListsProps, IHideListsState> {
|
||||
private columns = [
|
||||
{
|
||||
Header: "List Name",
|
||||
accessor: "Title",
|
||||
headerStyle: { whiteSpace: 'nowrap' },
|
||||
style: { whiteSpace: 'normal' },
|
||||
sortable: true,
|
||||
filterable: true,
|
||||
width: 150,
|
||||
Cell: row => (
|
||||
<div className='trucateData'>{row.original.Title}</div>
|
||||
)
|
||||
},
|
||||
{
|
||||
Header: "List Type",
|
||||
accessor: "BaseTemplate",
|
||||
headerStyle: { whiteSpace: 'nowrap' },
|
||||
style: { whiteSpace: 'normal' },
|
||||
sortable: true,
|
||||
filterable: true,
|
||||
width: 120,
|
||||
Cell: row => (
|
||||
<div className='trucateData'>{row.original.BaseTemplate}</div>
|
||||
)
|
||||
},
|
||||
{
|
||||
Header: "List GUID",
|
||||
accessor: "Id",
|
||||
headerStyle: { whiteSpace: 'nowrap' },
|
||||
style: { whiteSpace: 'normal' },
|
||||
sortable: true,
|
||||
filterable: true,
|
||||
Cell: row => (
|
||||
<div className='trucateData'>{row.original.Id}</div>
|
||||
)
|
||||
},
|
||||
{
|
||||
Header: "Is Hidden",
|
||||
accessor: "Hidden",
|
||||
headerStyle: { whiteSpace: 'nowrap' },
|
||||
style: { whiteSpace: 'normal' },
|
||||
sortable: true,
|
||||
filterable: true,
|
||||
width: 100,
|
||||
Cell: row => (
|
||||
<div className='trucateData'>{row.original.Hidden.toString()}</div>
|
||||
)
|
||||
},
|
||||
{
|
||||
Header: "Action",
|
||||
accessor: "",
|
||||
headerStyle: { whiteSpace: 'nowrap' },
|
||||
style: { whiteSpace: 'normal', color: '#0460A9', fontWeight: 'bold', flexWrap: 'wrap' },
|
||||
width: 140,
|
||||
Cell: row => (
|
||||
<>
|
||||
{
|
||||
row.original.Hidden ?
|
||||
<DefaultButton id={"btn" + row.index} onClick={() => this.actionbtnClicked(row, buttonTexts.Unhide)}>{buttonTexts.Unhide}</DefaultButton>
|
||||
:
|
||||
<DefaultButton id={"btn" + row.index} onClick={() => this.actionbtnClicked(row, buttonTexts.hide)}>{buttonTexts.hide}</DefaultButton>
|
||||
}
|
||||
</>
|
||||
)
|
||||
}
|
||||
];
|
||||
private tableInstance;
|
||||
|
||||
constructor(props) {
|
||||
super(props);
|
||||
|
||||
this.state = {
|
||||
data: [],
|
||||
rowData: null,
|
||||
user: null,
|
||||
isCalloutVisible: false,
|
||||
isConfirmCalloutMessage: "",
|
||||
isConfirmCallOutVisible: false
|
||||
};
|
||||
}
|
||||
|
||||
public async componentDidMount() {
|
||||
await this.GetLists();
|
||||
await this.checkifUserisAdmin();
|
||||
}
|
||||
|
||||
private async checkifUserisAdmin() {
|
||||
await sp.web.currentUser().then((userObj) => {
|
||||
this.setState({ user: userObj }, () => {
|
||||
console.log("user", this.state.user);
|
||||
console.log("isAdmin", this.state.user.IsSiteAdmin);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
private async unHideList() {
|
||||
let row = this.state.rowData;
|
||||
console.log("In UnHideList method");
|
||||
console.log("row", row);
|
||||
console.log("List Title - ", row.original.Title);
|
||||
console.log("List GUID - ", row.original.Id);
|
||||
|
||||
try {
|
||||
await sp.web.lists.getById(row.original.Id).update({
|
||||
Hidden: false
|
||||
});
|
||||
await this.GetLists();
|
||||
}
|
||||
catch (ex) {
|
||||
console.log('Error', ex);
|
||||
}
|
||||
}
|
||||
|
||||
private async hideList() {
|
||||
let row = this.state.rowData;
|
||||
console.log("In HideList method");
|
||||
console.log("row", row);
|
||||
console.log("List Title - ", row.original.Title);
|
||||
console.log("List GUID - ", row.original.Id);
|
||||
|
||||
try {
|
||||
await sp.web.lists.getById(row.original.Id).update({
|
||||
Hidden: true
|
||||
});
|
||||
await this.GetLists();
|
||||
}
|
||||
catch (ex) {
|
||||
console.log('Error', ex);
|
||||
}
|
||||
}
|
||||
|
||||
private async GetLists(): Promise<any> {
|
||||
return sp.web.lists.filter("BaseTemplate eq 100 or BaseTemplate eq 101 or BaseTemplate eq 106 or BaseTemplate eq 119").get().then((lsData) => { //filter("Hidden eq false and BaseType ne 1")
|
||||
console.log("Total number of lists are " + lsData.length);
|
||||
console.log("data", lsData);
|
||||
this.setState({ data: lsData });
|
||||
});
|
||||
}
|
||||
|
||||
private actionbtnClicked = (row, btnText) => {
|
||||
switch (btnText) {
|
||||
case buttonTexts.hide: this.setState({ isConfirmCallOutVisible: true, isConfirmCalloutMessage: CallOutMessages.hideList, rowData: row }); break;
|
||||
case buttonTexts.Unhide: this.setState({ isConfirmCallOutVisible: true, isConfirmCalloutMessage: CallOutMessages.unHideList, rowData: row }); break;
|
||||
}
|
||||
}
|
||||
|
||||
private _onCalloutDismiss = () => {
|
||||
this.setState({ isCalloutVisible: false, isConfirmCalloutMessage: "", isConfirmCallOutVisible: false });
|
||||
}
|
||||
|
||||
private onConfirmationMessageYesClicked = (event) => {
|
||||
switch (this.state.isConfirmCalloutMessage) {
|
||||
case CallOutMessages.hideList: this.hideList(); this._onCalloutDismiss(); break;
|
||||
case CallOutMessages.unHideList: this.unHideList(); this._onCalloutDismiss(); break;
|
||||
}
|
||||
}
|
||||
|
||||
private onConfirmationMessageNoClicked = (event) => {
|
||||
this._onCalloutDismiss();
|
||||
}
|
||||
|
||||
public render(): React.ReactElement {
|
||||
let { isCalloutVisible, isConfirmCallOutVisible, isConfirmCalloutMessage, data, user } = this.state;
|
||||
let btnId = this.state.rowData ? "btn" + this.state.rowData.index : "";
|
||||
console.log("columns", this.columns);
|
||||
console.log("data", data);
|
||||
return (
|
||||
<div>
|
||||
{
|
||||
user && user.IsSiteAdmin ?
|
||||
<div>
|
||||
<div>
|
||||
Site Url: <b>{this.props.ctx.pageContext.web.absoluteUrl}</b><br />
|
||||
Total Number of lists in the Site are <b>{data.length}</b>
|
||||
</div>
|
||||
<br />
|
||||
<ReactTable
|
||||
columns={this.columns}
|
||||
data={data}
|
||||
minRows={0}
|
||||
defaultPageSize={5}
|
||||
pageSizeOptions={[5, 10, 15]}
|
||||
noDataText={"Sorry, No data to display!!!"}
|
||||
defaultFilterMethod={(filter, row, column) => {
|
||||
const id = filter.pivotId || filter.id;
|
||||
return row[id] !== undefined ? String(row[id]).toLowerCase().indexOf(filter.value.toLowerCase()) !== -1 : true;
|
||||
}}
|
||||
/>
|
||||
|
||||
{isConfirmCallOutVisible && (
|
||||
<FocusTrapCallout
|
||||
className='ms-CalloutExample-callout'
|
||||
ariaLabelledBy={'callout-label-1'}
|
||||
ariaDescribedBy={'callout-description-1'}
|
||||
role={'alertdialog'}
|
||||
gapSpace={0}
|
||||
target={`#${btnId}`}
|
||||
onDismiss={this._onCalloutDismiss}
|
||||
setInitialFocus={true}
|
||||
>
|
||||
<MessageBar messageBarType={MessageBarType.warning} className='saveChanges' isMultiline={true} actions={
|
||||
<FocusZone handleTabKey={FocusZoneTabbableElements.all} isCircularNavigation>
|
||||
<Stack className='button custButton' gap={8} horizontal>
|
||||
<PrimaryButton onClick={(event) => this.onConfirmationMessageYesClicked(event)}>Yes</PrimaryButton>
|
||||
<DefaultButton onClick={(event) => this.onConfirmationMessageNoClicked(event)}>No</DefaultButton>
|
||||
</Stack>
|
||||
</FocusZone>
|
||||
}>
|
||||
{isConfirmCalloutMessage}
|
||||
</MessageBar>
|
||||
</FocusTrapCallout>
|
||||
)}
|
||||
</div>
|
||||
:
|
||||
<div>
|
||||
<MessageBar messageBarType={MessageBarType.error} className='saveChanges' isMultiline={true}>
|
||||
Sorry!!! This tool is only for Site Admins...
|
||||
</MessageBar>
|
||||
</div>
|
||||
}
|
||||
|
||||
</div>
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
export interface IHideListsProps {
|
||||
ctx: any;
|
||||
}
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
import { IListInfo } from '@pnp/sp/lists';
|
||||
|
||||
export interface IHideListsState {
|
||||
data: IListInfo[];
|
||||
rowData: any;
|
||||
user: any;
|
||||
isCalloutVisible: boolean;
|
||||
isConfirmCalloutMessage: string;
|
||||
isConfirmCallOutVisible: boolean;
|
||||
}
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
define([], function() {
|
||||
return {
|
||||
"PropertyPaneDescription": "Description",
|
||||
"BasicGroupName": "Group Name",
|
||||
"DescriptionFieldLabel": "Description Field"
|
||||
}
|
||||
});
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
declare interface IHideListsWebPartStrings {
|
||||
PropertyPaneDescription: string;
|
||||
BasicGroupName: string;
|
||||
DescriptionFieldLabel: string;
|
||||
}
|
||||
|
||||
declare module 'HideListsWebPartStrings' {
|
||||
const strings: IHideListsWebPartStrings;
|
||||
export = strings;
|
||||
}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 542 B |
|
|
@ -0,0 +1,35 @@
|
|||
{
|
||||
"extends": "./node_modules/@microsoft/rush-stack-compiler-3.9/includes/tsconfig-web.json",
|
||||
"compilerOptions": {
|
||||
"target": "es5",
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"module": "esnext",
|
||||
"moduleResolution": "node",
|
||||
"jsx": "react",
|
||||
"declaration": true,
|
||||
"sourceMap": true,
|
||||
"experimentalDecorators": true,
|
||||
"skipLibCheck": true,
|
||||
"outDir": "lib",
|
||||
"inlineSources": false,
|
||||
"strictNullChecks": false,
|
||||
"noUnusedLocals": false,
|
||||
"typeRoots": [
|
||||
"./node_modules/@types",
|
||||
"./node_modules/@microsoft"
|
||||
],
|
||||
"types": [
|
||||
"webpack-env"
|
||||
],
|
||||
"lib": [
|
||||
"es5",
|
||||
"dom",
|
||||
"es2015.collection",
|
||||
"es2015.promise"
|
||||
]
|
||||
},
|
||||
"include": [
|
||||
"src/**/*.ts",
|
||||
"src/**/*.tsx"
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
{
|
||||
"extends": "./node_modules/@microsoft/sp-tslint-rules/base-tslint.json",
|
||||
"rules": {
|
||||
"class-name": false,
|
||||
"export-name": false,
|
||||
"forin": false,
|
||||
"label-position": false,
|
||||
"member-access": true,
|
||||
"no-arg": false,
|
||||
"no-console": false,
|
||||
"no-construct": false,
|
||||
"no-duplicate-variable": true,
|
||||
"no-eval": false,
|
||||
"no-function-expression": true,
|
||||
"no-internal-module": true,
|
||||
"no-shadowed-variable": true,
|
||||
"no-switch-case-fall-through": true,
|
||||
"no-unnecessary-semicolons": true,
|
||||
"no-unused-expression": true,
|
||||
"no-with-statement": true,
|
||||
"semicolon": true,
|
||||
"trailing-comma": false,
|
||||
"typedef": false,
|
||||
"typedef-whitespace": false,
|
||||
"use-named-parameter": true,
|
||||
"variable-name": false,
|
||||
"whitespace": false
|
||||
}
|
||||
}
|
||||
|
|
@ -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