sp-dev-fx-webparts/samples/react-password-vault
Hugo Bernier 7ebabdf2fa Added devcontainer, nvmrc, sample.josn, fixed typo 2023-11-18 19:15:45 -05:00
..
.devcontainer Added devcontainer, nvmrc, sample.josn, fixed typo 2023-11-18 19:15:45 -05:00
.vscode
assets Added devcontainer, nvmrc, sample.josn, fixed typo 2023-11-18 19:15:45 -05:00
config
fast-serve
images
src Added devcontainer, nvmrc, sample.josn, fixed typo 2023-11-18 19:15:45 -05:00
teams
.eslintrc.js
.gitignore
.npmignore
.npmrc
.nvmrc Added devcontainer, nvmrc, sample.josn, fixed typo 2023-11-18 19:15:45 -05:00
.yo-rc.json
README.md Added devcontainer, nvmrc, sample.josn, fixed typo 2023-11-18 19:15:45 -05:00
gulpfile.js
package-lock.json Added devcontainer, nvmrc, sample.josn, fixed typo 2023-11-18 19:15:45 -05:00
package.json
tsconfig.json

README.md

Password vault

Summary

This web part allows you to protect your data, such as the username, password or even just a text note (rich text). This data is protected with a master password that you can choose yourself. The data is encrypted and stored in the properties of the web part. This means that the data is not in plain text and can only be decrypted by entering the master password. You can also use this web part in SharePoint and Microsoft Teams (as a tab)

Edit Mode

Edit Mode

Display Mode

Display Mode

Maintenance Mode

Maintenance Mode

Compatibility

⚠️ Important
Every SPFx version is optimally compatible with specific versions of Node.js. In order to be able to build this sample, you need to ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.
Refer to https://aka.ms/spfx-matrix for more information on SPFx compatibility.

This sample is optimally compatible with the following environment configuration:

SPFx 1.16.1 Node.js v16.13+ Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Unsupported Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Get your own free development tenant by subscribing to Microsoft 365 developer program

Contributors

Version history

Version Date Comments
1.0 October 27, 2023 Initial release

Minimal path to awesome

  • Clone this repository (or download this solution as a .ZIP file then unzip it)
  • From your command line, change your current directory to the directory containing this sample (react-password-vault, located under samples)
  • in the command line run:
    • npm install
    • gulp serve or npm run serve for spfx-fast-serve

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Features

This web part illustrates the following concepts on top of the SharePoint Framework:

The web part comes with this features

  • Protect all data with a master password
  • store as many usernames, passwords and notes as you want (similar "look and feel" as in SharePoint Standard, when you want to place a new web part)
  • Copy username and password to clipboard
  • Hide/display password in text field
  • Close the safe manually or the safe will be closed automatically after a few minutes
  • No possibility to "reset" the master password if the password is forgotten
  • The data is NOT stored in plain text

Video

Building SPFx Password Vault Web Part

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 from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

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.