> For the complete documentation index, see [llms.txt](https://docs.forms.md/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.forms.md/input-types/password-input.md).
# Password input
Password input
Use the `passwordInput()` function to create password inputs in your forms. It uses the HTML `` element which masks the input value for security.
***
## Basic usage
```javascript
import { Composer } from "formsmd";
const composer = new Composer({
id: "my-form"
});
composer.passwordInput("password", {
question: "Create a password"
});
```
Generates the following Markdown-like syntax:
```
#! id = my-form
password = PasswordInput(
| question = Create a password
)
```
### Required
Add the `required` parameter to make the field mandatory:
```javascript
composer.passwordInput("password", {
question: "Create a password",
required: true
});
```
Generates the following Markdown-like syntax:
```
password* = PasswordInput(
| question = Create a password
)
```
***
## Function overview
The following is the overview of the function:
```typescript
passwordInput(name: string, params: object)
```
### Arguments
| Name | Type | Description |
| -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | `string` | A unique name for your form field that you'll use to identify the user's response.\* |
| `params` | `object` | An object containing all the configuration parameters for your password input field (see the [parameters section](#parameters) below for the full list of options). |
{% hint style="danger" %} \*Avoid values for the `name` argument which may be the names of HTML attributes, such as `"name"`, `"role"`, `"id"`, etc. This is because by default, the form's template string is first sanitized using [DOMPurify](https://github.com/cure53/DOMPurify), and these values may be removed to prevent DOM clobbering.
{% endhint %}
***
## Parameters
### Shared parameters
These parameters are common to all form fields:
| Name | Type | Description |
| --------------------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `question` (required) | `string` | The main question or label of the form field. |
| `required` | `true` (`boolean`) | When set, the field becomes required. |
| `description` | `string` | Any extra information that the user may need to fill out the form. Appears right below the question. |
| `fieldSize` | `"sm"` | When set to `"sm"`, the font sizes of the question, description, and answer are made smaller. |
| `labelStyle` | `"classic"` | When set to `"classic"`, the question and description of the form field are made smaller. |
| `subfield` | `true` (`boolean`) | When set, the question and description of the form field are made smaller. Functionally the same as setting `labelStyle` to `"classic"`. |
| `disabled` | `true` (`boolean`) | When set, the input is disabled. |
| `autofocus` | `true` (`boolean`) | When set, the input will be automatically focused when the parent slide becomes active, or immediately after page load. |
| `id` | `string` | The `id` attribute of the form field container. |
| `classNames` | `string[]` | The CSS class names of the form field. [See the available CSS utility classes](/content/css-utility-classes.md). |
| `attrs` | `Array<{ name: string, value: string }>` | Other HTML attributes of the form field. Each attribute has a `name` and `value` property. |
| `displayCondition` | `{ dependencies: string[], condition: string }` | Controls when the field is shown. The `dependencies` lists the fields to watch, and `condition` is the expression that must be true to show the field. The `condition` must be a valid [Nunjucks](https://mozilla.github.io/nunjucks/) expression. [See example](#conditional-display). |
### Password input specific parameters
| Name | Type | Description |
| ------------- | -------- | --------------------------------------------------------------------------- |
| `placeholder` | `string` | Sets the `placeholder` attribute of the input. |
| `maxlength` | `number` | If set, this becomes the maximum number of allowed characters in the input. |
| `pattern` | `string` | If set, the input value must match the given pattern. |
| `value` | `string` | If set, this becomes the default value of the input. |
***
## Examples
### Password input with custom placeholder
```javascript
composer.passwordInput("newPassword", {
question: "Create a new password",
description: "Must be at least 8 characters long",
placeholder: "Enter your password",
required: true
});
```
Generates the following Markdown-like syntax:
```
newPassword* = PasswordInput(
| question = Create a new password
| description = Must be at least 8 characters long
| placeholder = Enter your password
)
```
### Password input with pattern validation
```javascript
composer.passwordInput("password", {
question: "Create a password",
description: "Must contain at least one uppercase letter, one lowercase letter, and one number",
pattern: "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d).{8,}$",
required: true
});
```
Generates the following Markdown-like syntax:
```
password* = PasswordInput(
| question = Create a password
| description = Must contain at least one uppercase letter, one lowercase letter, and one number
| pattern = ^(?=.*[a-z])(?=.*[A-Z])(?=.*\d).{8,}$
)
```
### Styled password input with custom attributes
Add CSS classes and other HTML attributes using the `classNames` and `attrs` parameters. Please note, these class names and attributes are added to the `