https://github.com/dagronf/dsfsecuretextfield
NSSecureTextField with a 'visibility' button.
https://github.com/dagronf/dsfsecuretextfield
macos nssecuretextfield password swift
Last synced: about 1 year ago
JSON representation
NSSecureTextField with a 'visibility' button.
- Host: GitHub
- URL: https://github.com/dagronf/dsfsecuretextfield
- Owner: dagronf
- License: mit
- Created: 2020-01-02T12:55:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-06T22:53:49.000Z (over 1 year ago)
- Last Synced: 2025-03-23T04:31:39.712Z (about 1 year ago)
- Topics: macos, nssecuretextfield, password, swift
- Language: Swift
- Homepage:
- Size: 68.4 KB
- Stars: 20
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DSFSecureTextField
NSSecureTextField with a 'visibility' button.
  
 [](https://cocoapods.org) [](https://swift.org/package-manager)
## Why
Sometimes it's nice to be able to see the contents of a password field. `DSFSecureTextField` adds a visibility button to the existing `NSSecureTextField` allowing your users to show or hide the contents of the field.
Optionally, you can choose to dynamically remove the button from the control (for example, if you want to be able to let your users choose whether to show the password or not via a preference)
## Integrate
* Copy the file `DSFSecureTextField.swift` into your project
* Or, use CocoaPods
`pod 'DSFSecureTextField', :git => 'https://github.com/dagronf/DSFSecureTextField/'`
* Or, use Swift Package Manager
## Usage
### Interface builder
1. Drag a Secure Text Field into the canvas
2. Set the `Custom Class` field for the control to `DSFSecureTextField`
3. Done!
### Code
Since `DSFSecureTextField` inherits from `NSSecureTextField`, you can create it exactly as you would for an `NSSecureTextField`
### Demo
There is a very simple project in the `Demos` folder.
## Configuration
| Parameter | Type | Description |
|:-----------------------------|:------------:|:------------------------------------------------------------|
| `allowPasswordInPlainText` | `Bool` | If true, *allows* the control to display a plain text representation of the password. Useful if you want to be able to control whether the user can choose (eg. via preferences) to make the password visible. |
| `displayToggleButton` | `Bool` | If true, displays a button _within_ the control (an eye) to allow the user to toggle between secure and plain text input |
| `visibility` | `Visibility` | If `.plainText`, the password is displayed in plain text. |
### `allowPasswordInPlainText`
A boolean flag to indicate if the field is allowed to display passwords in plain text.
If true, *allows* the control to display a plain text representation of the password. Useful if you want to be able
to control whether the user can choose (eg. via preferences) to make the password visible.
### `displayToggleButton`
When true, displays an 'eye' button embedded within the password field that allows the user to toggle the visibility
of the password.
* If true, displays a button _within_ the control (an eye) to allow the user to toggle between secure and plain text input
* If false (and `allowPasswordInPlainText` is true), the application needs to provide its own mechanism for setting
`visibility` as appropriate.
### `visibility`
The visibility flag denotes the visibility of the text within the field
| Value | Description |
|--------------|:--------------|
| `.secure` | The content is displayed securely (eg. `●●●●●●●●`) |
| `.plainText` | The content is displayed in plain text (eg. `gr00vy!.`) |
## License
```
MIT License
Copyright (c) 2023 Darren Ford
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```