Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CodeEditApp/CodeEditTextView
A text editor specialized for displaying and editing code documents. Written in pure Swift.
https://github.com/CodeEditApp/CodeEditTextView
appkit coretext macos swift text-editor
Last synced: about 2 months ago
JSON representation
A text editor specialized for displaying and editing code documents. Written in pure Swift.
- Host: GitHub
- URL: https://github.com/CodeEditApp/CodeEditTextView
- Owner: CodeEditApp
- License: mit
- Created: 2023-12-12T22:45:14.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-05-21T14:18:54.000Z (4 months ago)
- Last Synced: 2024-05-21T15:36:59.005Z (4 months ago)
- Topics: appkit, coretext, macos, swift, text-editor
- Language: Swift
- Homepage: https://codeeditapp.github.io/CodeEditTextView/documentation/codeedittextview/
- Size: 976 KB
- Stars: 39
- Watchers: 7
- Forks: 5
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
CodeEditTextView
A text editor specialized for displaying and editing code documents. Features include basic text editing, extremely fast initial layout, support for handling large documents, customization options for code documents.
[](https://discord.gg/vChUXVf9Em)
> [!IMPORTANT]
> This package contains a text view suitable for replacing `NSTextView` in some, ***specific*** cases. If you want a text view that can handle things like: right-to-left text, custom layout elements, or feature parity with the system text view, consider using [STTextView](https://github.com/krzyzanowskim/STTextView) or [NSTextView](https://developer.apple.com/documentation/appkit/nstextview). The ``TextView`` exported by this library is designed to lay out documents made up of lines of text. It also does not attempt to reason about the contents of the document. If you're looking to edit *source code* (indentation, syntax highlighting) consider using the parent library [CodeEditSourceEditor](https://github.com/CodeEditApp/CodeEditSourceEditor).
## Documentation
This package is fully documented [here](https://codeeditapp.github.io/CodeEditTextView/documentation/codeedittextview/).
## Usage
This package exports a primary `TextView` class. The `TextView` class is an `NSView` subclass that can be embedded in a scroll view or used standalone. It parses and renders lines of a document and handles mouse and keyboard events for text editing. It also renders styled strings for use cases like syntax highlighting.
```swift
import CodeEditTextView
import AppKit
/// # ViewController
///
/// An example view controller for displaying a text view embedded in a scroll view.
class ViewController: NSViewController, TextViewDelegate {
private var scrollView: NSScrollView!
private var textView: TextView!
var text: String = "func helloWorld() {\n\tprint(\"hello world\")\n}"
var font: NSFont!
var textColor: NSColor!
override func loadView() {
textView = TextView(
string: text,
font: font,
textColor: textColor,
lineHeightMultiplier: 1.0,
wrapLines: true,
isEditable: true,
isSelectable: true,
letterSpacing: 1.0,
delegate: self
)
textView.translatesAutoresizingMaskIntoConstraints = false
scrollView = NSScrollView()
scrollView.translatesAutoresizingMaskIntoConstraints = false
scrollView.hasVerticalScroller = true
scrollView.hasHorizontalScroller = true
scrollView.documentView = textView
self.view = scrollView
NSLayoutConstraint.activate([
scrollView.leadingAnchor.constraint(equalTo: view.leadingAnchor),
scrollView.trailingAnchor.constraint(equalTo: view.trailingAnchor),
scrollView.topAnchor.constraint(equalTo: view.topAnchor),
scrollView.bottomAnchor.constraint(equalTo: view.bottomAnchor)
])
textView.updateFrameIfNeeded()
}
}
```
## License
Licensed under the [MIT license](https://github.com/CodeEditApp/CodeEdit/blob/main/LICENSE.md).
## Dependencies
Special thanks to [Matt Massicotte](https://twitter.com/mattie) for the great work he's done!
| Package | Source | Author |
| :---------- | :--------------------------------------------------- | :-------------------------------------------- |
| `TextStory` | [GitHub](https://github.com/ChimeHQ/TextStory) | [Matt Massicotte](https://twitter.com/mattie) |
| `swift-collections` | [GitHub](https://github.com/apple/swift-collections.git) | [Apple](https://github.com/apple) |
## Related Repositories
CodeEditKit
CodeEditLanguages
CodeEdit CLI
