# payload-plugin-password-protection

> Password protection plugin for Payload CMS

Latest version **0.0.2** (published 2022-05-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install payload-plugin-password-protection
pnpm add payload-plugin-password-protection
yarn add payload-plugin-password-protection
bun add payload-plugin-password-protection
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2022-05-04 |
| First published | 2022-03-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 37.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | dev@trbl.design |
| Maintainers | jacobsfletch |
| Keywords | payload, cms, plugin, typescript, react, password, protection, pages |

## Links

- npm: https://www.npmjs.com/package/payload-plugin-password-protection
- npm.io page: https://npm.io/package/payload-plugin-password-protection

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2022-05-04
- 0.0.1 — 2022-03-17

## README

# Payload Password Protection Plugin

[![NPM](https://img.shields.io/npm/v/payload-plugin-password-protection)](https://www.npmjs.com/package/payload-plugin-password-protection)

A plugin for [Payload CMS](https://github.com/payloadcms/payload) to easily allow for documents to be secured behind a layer of password protection.

Core features:
  - one
  - two

## Installation

```bash
  yarn add payload-plugin-password-protection
  # OR
  npm i payload-plugin-password-protection
```

## Basic Usage

In the `plugins` array of your [Payload config](https://payloadcms.com/docs/configuration/overview), call the plugin with [options](#options):

```js
import { buildConfig } from 'payload/config';
import passwordProtection from 'payload-plugin-password-protection';

const config = buildConfig({
  collections: [
  plugins: [
    passwordProtection({
      collections: ['pages'],
    })
  ]
});

export default config;
```

### Options

#### `collections`

  An array of collections slugs to enable password protection.

## TypeScript

All types can be directly imported:
```js
import {
  PasswordProtectionConfig,
} from 'payload-plugin-password-protection/dist/types';
```

## Screenshots

<!-- ![screenshot 1](https://github.com/trouble/payload-plugin-password-protection/blob/main/images/screenshot-1.jpg?raw=true) -->

---
_Source: https://npm.io/package/payload-plugin-password-protection · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._