https://github.com/chimehq/rearrange
Swift library for working with ranges types: NSRange, IndexSet, and String.Index
https://github.com/chimehq/rearrange
cocoa foundation macos nstextview swift uitextview
Last synced: 6 months ago
JSON representation
Swift library for working with ranges types: NSRange, IndexSet, and String.Index
- Host: GitHub
- URL: https://github.com/chimehq/rearrange
- Owner: ChimeHQ
- License: bsd-3-clause
- Created: 2019-06-20T18:25:43.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-02-19T16:32:50.000Z (8 months ago)
- Last Synced: 2025-03-30T05:05:42.130Z (6 months ago)
- Topics: cocoa, foundation, macos, nstextview, swift, uitextview
- Language: Swift
- Homepage:
- Size: 127 KB
- Stars: 78
- Watchers: 3
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[![Build Status][build status badge]][build status]
[![Platforms][platforms badge]][platforms]
[![Documentation][documentation badge]][documentation]
[![Matrix][matrix badge]][matrix]
# Rearrange
Rearrange is a collection of utilities for making it easier to work with `NSRange`, `IndexSet`, and `String.Index`.
If you need to work with `NSTextRange`/`UITextRange` or just TextKit in general, check out [Glyph][].
[Glyph]: https://github.com/chimeHQ/Glyph
## Integration
Swift Package Manager:
```swift
dependencies: [
.package(url: "https://github.com/ChimeHQ/Rearrange")
]
```
## Types
**RangeMutation**
This is a struct that encapsulates a single change to an `NSRange`. It's useful for serializing, queuing, or otherwise storing changes and applying them.
You can also use this class to tranform locations, `NSRange`, or even an `IndexSet`. This is handy for updating values as text is changed. This might seem easy, but there are a large number of edge cases that `RangeMutation` handles, including mutations that invalidate (for example completely delete) a range.
## Extensions
**NSRange**
```swift
// convenience
static let zero: NSRange
static let notFound: NSRange
var max: Int
// shifting
func shifted(by delta: Int) -> NSRange?
func shifted(endBy delta: Int) -> NSRange?
func shifted(startBy delta: Int) -> NSRange?
// mutating
func clamped(to limit: Int) -> NSRange
func apply(_ change: RangeMutation) -> NSRange?
// working with Swift String
func range(in string: String) -> Range?
```
**IndexSet**
```swift
init(integersIn range: NSRange)
init(ranges: [NSRange])
mutating func insert(range: NSRange)
mutating func insert(ranges: [NSRange])
mutating func remove(integersIn range: NSRange)
var nsRangeView: [NSRange]
func contains(integersIn range: NSRange) -> Bool
func intersects(integersIn range: NSRange) -> Bool
var limitSpanningRange: NSRange?
```
**String**
```swift
subscript(range: Range) -> Substring?
subscript(range: NSRange) -> Substring?
```
## Contributing and Collaboration
I would love to hear from you! Issues or pull requests work great. Both a [Matrix space][matrix] and [Discord][discord] are available for live help, but I have a strong bias towards answering in the form of documentation. You can also find me on [mastodon](https://mastodon.social/@mattiem).
I prefer collaboration, and would love to find ways to work together if you have a similar project.
I prefer indentation with tabs for improved accessibility. But, I'd rather you use the system you want and make a PR than hesitate because of whitespace.
By participating in this project you agree to abide by the [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
[build status]: https://github.com/ChimeHQ/Rearrange/actions
[build status badge]: https://github.com/ChimeHQ/Rearrange/workflows/CI/badge.svg
[platforms]: https://swiftpackageindex.com/ChimeHQ/Rearrange
[platforms badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FChimeHQ%2FRearrange%2Fbadge%3Ftype%3Dplatforms
[documentation]: https://swiftpackageindex.com/ChimeHQ/Rearrange/main/documentation
[documentation badge]: https://img.shields.io/badge/Documentation-DocC-blue
[matrix]: https://matrix.to/#/%23chimehq%3Amatrix.org
[matrix badge]: https://img.shields.io/matrix/chimehq%3Amatrix.org?label=Matrix
[discord]: https://discord.gg/esFpX6sErJ