TextKit 2 – The Promised Land

TextKit 2 – The Promised Land(blog.krzyzanowskim.com)

111 points by nickmain 278 days ago | 32 comments

w10-1 278 days ago |

This is one of many such API.

I spent decades in Java land using open-source libraries, where the quality was broad and deep. An enticing demo usually meant it was good all the way down.

With Apple, though, a nice demo means you can do exactly what they did, but be blocked if you step off the happy path. Worse, each developer needs to get bruised because there's no publicly available list of bugs for an API.

I'm grateful to those who publish critiques of API's. It's a life saver.

mpweiher 277 days ago | |

With NeXTstep it was exactly the opposite: you could usually rearrange, recompose, override the pieces any way you wanted, including from scratch, but the demos and pre-built parts were of such quality that you didn't really want to.

But if you wanted: knock yourself out.

With the first version of Mac OS X, I was stunned that the high-level "convenience" APIs had capabilities that you couldn't actually replicate using the lower level APIs. And this seems to be getting worse. Fortunately with Swift we now have a type-system to enforce the "Apply way or the highway" attitude.

colbyn 278 days ago |

Oh hey good to see some more literature on TextKit2. I remember diving into it when I wrote my proof of concept markdown renderer:

https://github.com/SuperSwiftMarkup/SuperSwiftMarkdownProtot...

It’s a good example of what else you can do with TextKit2, beyond plain text rendering. Here, I can draw text layout fragments in a core graphics context and use typographic information to also render markdown specific graphics in the background or foreground such as markdown tables. One day I’d love to experiment with a markdown centric spread sheet app.

At the time there was so little online info that I had to figure out everything on my own (and no chatbots didn’t have a clue about TextKit2), but STTextView was a great reference. Overall his open source work was very much appreciated. (I should probably say as much in the read me.)

That experiment was also a ton of work that ultimately didn’t go anywhere. Most people would rather just use a relatively subpar embedded browser (i.e. web view).

colbyn 278 days ago | |

Oh also I’d like to add to the above, the TextKit2 API is way more freeform than people think. You could probably implement your own web browser upon it with optimized line by line text rendering (which isn’t that bad). One thing I always wanted to experiment with is rendering markdown content with horizontally scrollable text fragments for table rows and certain fenced code blocks. Super cool and practical idea for native markdown text rendering. Moreover, in some ways it seems pretty easy to do in TextKit2 since you get very fine grained control over text layout fragment rendering.

nicoburns 278 days ago | | |

> You could probably implement your own web browser upon it with optimized line by line text rendering

I actually have an ambition to do this. I already have most of the layout engine. The use case is for a React Native like framework that can render spec-compliant web content.

krzyzanowskim 278 days ago | | |

we could build a space rocket with it if we only knew how to use it, so it would not glitch

andrekandre 278 days ago |

  > Today, I believe that's not me. The TextKit 2 API and its implementation are lacking and unexpectedly difficult to use correctly. While the design is solid, it proved challenging to apply in real-world applications.

when making new apis its a good idea to have people try and use it like this to find and fix the rough edges and fix bugs... it definitely feels like apple didn't do that (at least enough) here...

zffr 278 days ago | |

Apple’s typical process for releasing public API involves dogfooding it internally first. Sometimes it will take years of internal use before Apple will release API publicly.

With something as large as TextKit, I would be extremely surprised if Apple did not get several of its apps to adopt the new API and use it for a few years before considering releasing it publicly.

saurik 276 days ago | | |

That isn't what it ever seemed, on early iOS at least? They would have every single app on the device using a private API -- like UIScroller, or UIWebDocumentView -- and then they would let all of their end developers screw around with the new UIScrollView, or UIWebView, and it would take a few years for their screams to result in the good design aspects from the private APIs to be begrudgingly given to the masses. At some point, a couple apps -- often starting with the Calculator app, which always seemed to be written by an intern -- would get ported to use the APIs the end developers had been trying to use for years, and if that worked out, Apple would start actually porting their apps off the internal APIs to the "finally good enough" public ones. It was honestly ridiculous... you'd see people talking about some extremely limited API, such as UINavigationController, as if it was somehow amazing... but you'd then have to point out "so why isn't Apple using it anywhere?" and the zealots somehow wouldn't even understand that that was possible :/.

wpm 278 days ago | | |

I’m sure they did, but did they actually fix all of the bugs they found?

arthurofbabylon 278 days ago |

> TextKit2 is implemented to be used by UITextView

This is the key insight that makes TextKit2 workable. I personally would not attempt to build an alternative to UITextView on TextKit (1 or 2). Instead, TextKit2 is all about very sensible intervention points for customizing UITextView (eg, Markdown-style parsing, typography, interactions, layout).

I recently rebuilt Minimal’s editor with TextKit2 (see minimal.app/#beta to experience it), and found Kryzanowskim’s deep dives very fruitful. He explores the edges of the API, so his writing helped me identify a nice bounds of safe-space to work in, and helped clarify what areas are too complex to safely build custom functionality within. (So thank you, author!)

I would not dismiss TextKit2; it is an incredible improvement over TextKit1. It remains a complicated and challenging field.

lapcat 278 days ago | |

> I would not dismiss TextKit2; it is an incredible improvement over TextKit1.

It's an absolute disaster on macOS. Even TextEdit app is now buggy as hell.

It's incredible how Apple broke plain text display on the Mac, which was a solved problem since forever.

rayiner 278 days ago | | |

Is it incredible, or is it quite credible? It’s taken Microsoft years now for “New Outlook” to get feature priority with Outlook 98. This feels like the new normal.

krzyzanowskim 278 days ago | |

> I personally would not attempt to build an alternative to UITextView on TextKit (1 or 2)

sure. If only UITextView/NSTextView did not have bugs impossible to workaround otherwise. TextKit 2 support in UITextView/NSTextView was really bad. improved over time. and still remain buggy. The UITextView focus limits the use of TextKit 2 architecture significantly.

eviks 278 days ago |

> The jiggery is super annoying and hard to accept. This is also expected, given that the height is estimated. Works as-designedj

It works as poorly designed, but it's not expected. You don't need to show those tiny meaningless jumps to the user since no user action will be different based on this extra precision, the scrollbar indicator is just not that kind of tool.

whoisthemachine 278 days ago |

This is an unavoidable result of lazy layouts. With the LazyList in Jetpack compose, it's comically difficult to produce a scrollbar, because the "LazyList" only ever lays out the visible items, so Compose can't really know (unless you actually already know) the full size of the list.

I find the iron triangle of project management reins supreme in a lot of domains: quality is sacrificed in the name of performance.

[0] https://en.wikipedia.org/wiki/Project_management_triangle

bobbylarrybobby 278 days ago | |

While difficult, there are surely ways to make the scroll bar move more smoothly. For instance, you could demand that it can only change direction when the scroll direction changes. You can also use past scroll bar positions as stronger estimates of document height than text content and whatever else is being used, which would lead to more consistent (if inaccurate) scrolling as well. But as long as we're estimating things we might as well make them enjoyable to use; it's not like the user will be able to discern that the scroll bar is off by 5% anyway.

wavemode 277 days ago | |

> "Good, fast, cheap. Choose two."

I think many software companies would happily choose good and fast if that were an option. In reality it rarely is (see: The Mythical Man Month).

In fact a lot of companies don't end up achieving any one of the three.

unconed 277 days ago |

It's bizarre that they prioritize parsimony over correctness. Laying out long documents can happen in the background, but shouldn't be deferred to when you actually scroll.

krzyzanowskim 277 days ago | |

annoyingly enough, the API has some sort of background layout support. I don't think it works well, though. I tried to use it, but it did not improve the "main thread" operations sigificantly to have an impact of fast scrolling scenario - I suspect it may not work actually

Wowfunhappy 277 days ago |

> In a scrollview, such frequent and significant changes to the height result in "juggery" of the scroller position and size

What on earth? How is that considered acceptable? And from Apple of all companies, the ones that put a speaker in the iPod just so it would improve the UX of scrolling.

rumori 277 days ago |

When I was working with TextKit years ago I was constantly using the Hopper decompiler on iOS SDKs to understand the internal workings of these frameworks. Documentation is sparse and calling functions in the right order resulted in big differences in results. It can take a lot of time and trial and errors to get it right.

dgreensp 278 days ago |

This semi-explains why I have started to notice (sadly) serious bugs in TextEdit, not just scrolling but editing/corruption.

refulgentis 278 days ago |

Interesting read.

I have to wonder if the scrollbar problem is inescapable, given the shape of the problem.

Flutter has dealt with similar issues, perhaps by virtue of more eyeballs / being slightly older, there are solutions. SuperSliverList in particular completely erased the jumpy-jank that happened when estimates changed to concrete values.

krzyzanowskim 278 days ago | |

as long as we deal with estimated values, it is inescapable. the best we can do is tune the estimate calculations and tweak heuristics. that's my understanding of the problem, but I'd love to hear from other experience

dostick 277 days ago |

So there’s only that major problem with it, or there’s others? If you need TextView for non-overflowing non scrollable content, it’s fine then?

keyle 278 days ago |

I tried to use it a year+ ago and that was a joke and a half. Half baked, buggy, and horribly documented.

With Apple apis, it's attend WWDC or good luck.

1over137 277 days ago | |

Or use the old ones. Obj-C and AppKit are pretty stable and have a big knowledge base out there.

lapcat 276 days ago | | |

NSTextView uses TextKit 2 by default now, so you can't really escape it. This is precisely why the TextEdit app has become so buggy, because the app is mostly a default NSTextView.

kmeisthax 278 days ago |

If anyone had tried lazy-loading scrolling in TextEdit back in the day, Steve Jobs would have had a tantrum. This shit looks awful in motion.

valorzard 278 days ago |

I was really excited by the title that this would be about beloved classic Minecraft mod pack Tekkit

> Today, I believe that's not me. The TextKit 2 API and its implementation are lacking and unexpectedly difficult to use correctly. While the design is solid, it proved challenging to apply in real-world applications.