Design your website to work best with 1Password
1Password is designed to generate, fill, and save passwords on most websites. You shouldn't have to do anything special to support 1Password on your website, as long as you develop your pages according to best practices. This will make the intention of each page element clear. 1Password will have an easier time understanding your page even when you make changes to it.
1Password also supports saving and signing in with passkeys. Learn how to design your website to work with passkeys.
Build logical forms
If 1Password has trouble saving or filling on your site, make sure you're following best practices with your forms:
- Use unique element IDs for every field.
- Enclose
<input>
fields in<form>
elements. - Group related fields (like usernames and passwords) together in the same
<form>
element. - Separate unrelated fields into different
<form>
elements. For example, put registration and sign-in fields in different forms.
If you don't want 1Password to offer to save or fill on a field, you can use the data-1p-ignore
attribute to tell 1Password it should ignore the field. For example:
Password change and reset forms
On password change forms, ask for the current password, the new password, and a password confirmation in that order. This makes the intention of each form element clear. For example:
On password reset and "forgot password" forms, include the username for the password that is being reset. This helps 1Password determine which item to update with the new password. For example:
Provide password requirements
1Password can generate passwords that fit your website's password requirements. 1Password uses Apple's Password Manager Resources to identify a website's unique password rules along with the shared credential backends file in the same repository for multiple domains that share the same account system.
To provide the rules 1Password will use to generate smart passwords, add the following attributes to each <input type="password">
element:
passwordrules
minlength
maxlength
Learn how to create a passwordrules
attribute.
Embrace accessibility
Making your website accessible benefits everyone who uses your website. As a bonus, making your site accessible provides clues to 1Password as well.
When examining a page, 1Password can take advantage of accessibility cues to locate fields:
-
Give every field a
<label>
element. -
Use the
for
attribute on your labels to associate them with the appropriate field: -
Use ARIA attributes to annotate form fields. For example, use the
aria-hidden
attribute on fields that aren't visible.
Improve reliability
Follow these additional guidelines to make sure 1Password will always work with your site, even when you make changes to it:
- Use
placeholder
attributes on fields instead of overlays. - Don't use generated field names and IDs.
- Don't dynamically add or remove fields from the DOM. Reuse fields and hide them when you don't need them.
- Use the appropriate
autocomplete
attributes on fields. These attributes make it easier for 1Password to identify your fields. Refer to this list of available attributes . For example, addautocomplete="one-time-code"
to a field where someone can enter a one-time password.
Get help
Make sure you're testing with the latest 1Password beta release.
If you're still having trouble after following the guidelines above, get help from the 1Password Support Community.