Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marinofelipe/CurrencyText
Currency text field formatter available for UIKit and SwiftUI 💶✏️
https://github.com/marinofelipe/CurrencyText
cocoapods currency currency-formatting ios swift swift-package-manager swiftui textfield uikit uitextfield
Last synced: about 1 month ago
JSON representation
Currency text field formatter available for UIKit and SwiftUI 💶✏️
- Host: GitHub
- URL: https://github.com/marinofelipe/CurrencyText
- Owner: marinofelipe
- License: mit
- Created: 2018-04-22T23:45:16.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T19:46:02.000Z (4 months ago)
- Last Synced: 2024-07-20T22:02:25.792Z (about 2 months ago)
- Topics: cocoapods, currency, currency-formatting, ios, swift, swift-package-manager, swiftui, textfield, uikit, uitextfield
- Language: Swift
- Homepage:
- Size: 428 KB
- Stars: 229
- Watchers: 6
- Forks: 31
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-swiftui-libraries - CurrencyText - Currency text field formatter (TextField / Content)
README
[](https://codecov.io/gh/marinofelipe/CurrencyText)
[]()
[](https://swift.org/package-manager/)
[](https://cocoapods.org/pods/CurrencyText)
[](https://twitter.com/_marinofelipe)
CurrencyText provides lightweight libraries for formating text field text as currency, available for both `UIKit` and `SwiftUI`.
Its main core, the `CurrencyFormatter` class, can also be used _a part from text fields_ to format any value that can be monetary represented.
If you need to present currency formatted text or allow users to input currency data, `CurrencyText` is going to help you do it in a readable and configurable matter.
## Documentation
For details on how to use `CurrencyText` libraries please refer to [the docs](/documentation/Documentation.md).
## Installation
### Swift Package Manager
To install it using Swift Package Manager, just add this repository through Xcode built-in `Swift Packages`, or by manually adding it to your `Package.swift` Package's dependencies:
```swift
dependencies: [
.package(
url: "https://github.com/marinofelipe/CurrencyText.git",
.upToNextMinor(from: .init(2, 1, 0)
)
]
.target(
name: "MyTarget",
dependencies: [
// Can be imported to consume the formatter in insolation
.target(name: "CurrencyFormatter"),
// UIKit library - Provide access to "CurrencyFormatter" and "CurrencyUITextFieldDelegate" targets
.target(name: "CurrencyText"),
// SwiftUI library - Provide access to "CurrencyFormatter" and "CurrencyTextField" targets
.target(name: "CurrencyTextSwiftUI")
],
...
)
```
### Install via CocoaPods
To integrate `CurrencyText` using CocoaPods, specify it, one or more of its sub-specs in your `Podfile`:
```ruby
# Podfile
use_frameworks!
target 'YOUR_TARGET_NAME' do
pod 'CurrencyText'
# sub-specs
# pod 'CurrencyText/CurrencyFormatter'
# pod 'CurrencyText/CurrencyUITextField'
# pod 'CurrencyText/CurrencyTextField'
end
```
## Contributing
Contributions and feedbacks are always welcome. Please feel free to fork, follow, open issues and pull requests. The issues, milestones, and what we are currently working on can be seen in the main [Project](https://github.com/marinofelipe/CurrencyText/projects/1).
## Special Thanks
To [@malcommac](https://github.com/malcommac) for his awesome work with [SwiftRichString](https://github.com/malcommac/SwiftRichString) and [SwiftDate](https://github.com/malcommac/SwiftDate), that inspired me when creating this project.
Also to [myanalysis](https://github.com/myanalysis) for contributing so much by finding issues and giving nice suggestions.
## Copyright
CurrencyText is released under the MIT license. [See LICENSE](https://github.com/marinofelipe/CurrencyText/blob/master/LICENSE) for details.
Felipe Marino: [[email protected]](mailto:[email protected]), [@_marinofelipe](https://twitter.com/_marinofelipe)