Aztec for iOS: Native HTML Editor
About Aztec & WordPressEditor
Aztec is a Swift library that provides a UITextView subclass with HTML visual-editing capabilities.
- Use this library if you want to create an App that interacts with raw HTML content.
WordPressEditor is a Swift library that provides a plugin to make Aztec work with WordPress content.
- Use this library if you want to create an App that interacts with WordPress HTML content.
Requirements
- iOS 10 and above
- Xcode 9.3 and above
Running the Example App
To run the Example app, you first need to make sure its dependencies are installed:
- Make sure you have Carthage installed.
- Using the command line:
cd Example
carthage update --platform iOS
Once Carthage finishes, you should open the file Aztec.xcworkspace from the root directory of Aztec.
Make sure the AztecExample target it selected, and press CMD + R to run it.
Integrating the Library with Carthage
Both libraries are available through Carthage. To install
it, simply add the following line to your Cartfile:
github "wordpress-mobile/AztecEditor-iOS" "1.0" # or the version number you want
github "wordpress-mobile/WordPressEditor-iOS" "1.0"
Follow these instructions to add Aztec.framework or WordPressEditor.framework to your App.
Then:
- Open your project, head to Build Settings for your target and add
$(SDKROOT)/usr/include/libxml2/to your Header Search Paths. - Go to
Build Phases>Link Binary With Librariesand addAztec.framework. - Add
import Aztecto your project's source.
Integrating the Library with CocoaPods
Both libraries are available through CocoaPods. To install
them, simply add the following lines to your Podfile:
pod "WordPress-Aztec-iOS", "1.0" # or the version number you want
pod "WordPress-Editor-iOS", "1.0"
Usage
After installing Aztec, import the module and use the Aztec.TextView view as shown below:
import Aztec
// ...
let textView = Aztec.TextView(
defaultFont: UIFont,
defaultParagraphStyle: ParagraphStyle = ParagraphStyle.default,
defaultMissingImage: UIImage) {
Contributing
Read our Contributing Guide to learn about reporting issues, contributing code, and more ways to contribute.
Getting in Touch
If you have questions about getting setup or just want to say hi, join the WordPress Slack and drop a message on the #mobile channel.
License
WordPress-Aztec-iOS is available under the GPLv2 license. See the LICENSE file for more info.
WordPress-Editor-iOS is available under the GPLv2 license. See the LICENSE file for more info.
