STTextView

SttextView

Performant macOS dan iOS textView dengan nomor baris dan banyak lagi. (NSTEXTVIEW/UITEXTVIEW Reimplementation)

Tujuan dari proyek ini adalah untuk membangun komponen yang dapat digunakan kembali NSTEXTVIEW/UITEXTVIEW menggunakan kerangka kerja TextKit 2. karena banyak alasan bagus.

Komponen ini terutama dikembangkan untuk melayani kebutuhan studio Swift sebagai editor kode sumber .

TextKit 2 diumumkan selama WWDC 2021 sebagai pengganti TextKit 1 untuk tata letak teks dan yang lainnya. Apple mengumumkan bahwa NSTextView , komponen tampilan yang khusus untuk pengeditan teks, akan mengadopsi TextKit 2 dan memberikan dukungan di sepanjang TextKit 1 bit. Ketika saya mulai mempelajari lebih lanjut tentang NSTextView + TextKit2, saya menyadari bahwa pada hari ini (Februari 2022), baik kelas NSTextView maupun TextKit 2 tidak berfungsi penuh. Sepanjang jalan, saya melaporkan beberapa laporan bug ke Apple yang meminta DTS (tiket dukungan). Akhirnya, saya diblokir oleh bug spesifik yang mendorong saya untuk memulai proyek ini.

Fitur

• Integrasi Sistem Teks MacOS
• Pengeditan teks pertunjukan
• Nomor garis tampilan
• Menampilkan karakter yang tidak terlihat
• Kustomisasi warna dan font
• Mengaktifkan dan mematikan jalur menyalakan dan mematikan
• Sesuaikan ketinggian garis
• Sorot/Pilih Rentang di Tampilan Teks
• Pengeditan multi-kursor
• Cari/ganti teks
• Ejaan dan tata bahasa
• Dikte
• Dukungan penyelesaian yang dapat disesuaikan
• Menggulir konten panjang yang halus
• LTR (kiri ke kanan) / RTL (kanan ke kiri) Tata letak
• Undo/redo
• Plugin
• Anotasi berlabuh (via plugin)
• Sumber Kode Sumber Sorot (via plugin)

SttextView-30-07-2024.mp4

? Dukungan & Sponsor

Keberlanjutan finansial proyek dimungkinkan berkat kontribusi berkelanjutan dari sponsor GitHub kami

? Roadmap

SttextView sudah sangat cocok sebagai komponen editor teks. Namun, masih membutuhkan perbaikan sebelum rilis v1.0

Menyarankan atau memilih fitur baru: permintaan fitur

Masalah yang diketahui

• menyeret teks (diimplementasikan sebagian)

Memulai

STTextView didistribusikan menggunakan Swift Package Manager. Instal dalam proyek dengan menambahkannya sebagai ketergantungan dalam Package.swift Anda.

 let package = Package (
    dependencies : [
        . package ( url : " https://github.com/krzyzanowskim/STTextView " , from : " 1.0.0 " )
    ]
) 

Aplikasi demo

Aplikasi demo TextEdit dan TextEdit.swiftUi memungkinkan Anda menjelajahi perpustakaan.

Plugin

Plugin dalam komponen SttextView menawarkan fungsionalitas dan kustomisasi tambahan di luar tampilan teks sederhana. Mereka meningkatkan kemampuan inti dari tampilan teks dengan menambahkan fitur seperti penyorotan sintaks, pelacakan jumlah kata, dan banyak lagi. Plugin ini memperluas utilitas SttextView sambil mempertahankan struktur perangkat lunak yang modular dan mudah beradaptasi.

• Plugin-neon Source Code Sintaks Sorot dengan Treesitter dan Neon.
• Plugin-Textformation Typing Completions dengan TextFormation.
• Anotasi berlabuh plugin-anotasi (mis. Pesan kesalahan inline)) plugin.
• Plugin-Template Dummy Plugin Template Repository Siap Membangun Plugin Baru.
• ... Tambahkan lebih banyak plugin

Penggunaan

SwiftUi

TextView adalah tampilan SwiftUi yang membungkus SttextView.

• Dukungan untuk Teks Kaya (String Dikaitkan)
• Lebih cepat dari swiftui.textedit (https://twitter.com/krzyzanowskim/status/1677628085217243137)

import STTextViewSwiftUI

struct ContentView : View {

    @ State private var text = AttributedString ( " Hello World! " )
    @ State private var selection : NSRange ?

    var body : some View {
        TextView (
            text : $text ,
            selection : $selection ,
            options : [ . wrapLines , . highlightSelectedLine ] ,
            plugins : [ plugin1 ( ) , plugin2 ( ) ]
        )
        . textViewFont ( . preferredFont ( forTextStyle : . body ) )
    }
}

Buat TextView

STTextView adalah subkelas NSView dan dapat diinisialisasi seperti tampilan lainnya. Ini memiliki API yang mirip dengan NStextView.

import STTextView

let textView = STTextView ( )
view . addSubview ( textView )

(macOS) Tambahkan ke tampilan gulir

 let textView = STTextView ( )
let scrollView = NSScrollView ( )
scrollView . documentView = textView

 let scrollView = STTextView . scrollableTextView ( )
let textView = scrollView . documentView as! STTextView

Menyesuaikan

Tampilan teks dapat disesuaikan dengan berbagai cara.

 let paragraph = NSParagraphStyle . default . mutableCopy ( ) as! NSMutableParagraphStyle
// Set the line-height to 110%
paragraph . lineHeightMultiple = 1.1
paragraph . defaultTabInterval = 28

// Default Paragraph style
textView . typingAttributes [ . paragraphStyle ] = paragraph

// Set default font
textView . font = NSFont . monospacedSystemFont ( ofSize : 14 , weight : . regular )

// Set default text color
textView . textColor = . textColor

// Set text value
textView . text = " Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean ornare lobortis sem a vulputate. "
textView . addAttributes ( [ . foregroundColor : NSColor . red ] , range : NSRange ( location : 10 , length : 5 ) )

// Wrap/No wrap lines to editor width
textView . isHorizontallyResizable = true

// Highlight the selected line.
textView . highlightSelectedLine = true

Tambahkan Gutter dengan nomor baris

textView . showLineNumbers = true
textView . gutterView ? . drawSeparator = true

(MacOS) Mengaktifkan antarmuka pencarian dan ganti opsional di dalam tampilan, biasanya tampilan gulir.

textView . isIncrementalSearchingEnabled = true
textView . textFinder . incrementalSearchingShouldDimContentView = true

? Daftar Laporan Bug TextKit 2

Daftar Masalah TextKit 2 dan Bug yang Terkait dengan NSTEXTVIEW dan Kerangka TextKit yang saya laporkan ke Apple sejauh ini:

• FB9856587: TextKit2 Fragmen Baris Tambahan Tidak Terduga untuk Baris Terakhir
• Fb9925766: nstextselectionNavigation.deletionranges hanya berfungsi di akhir kata
• FB9925647: NStextLayoutManager.Replacecontents (dalam kisaran: dengan dikaitkan dengan stribut :) didokumentasikan tetapi bukan bagian dari API publik
• FB9907261: nStextElementProvider.Replacecontents (dalam: dengan :) tidak menggantikan konten seperti yang didokumentasikan
• FB9692714: Atribut rendering tidak menggambar dengan benar
• FB9886911: NStextView tidak dapat dengan benar tata letak dan menampilkan baris panjang (yang ini jahat karena menyebabkan tampilan "melompat" kapan pun pembaruan atribut teks)
• FB9713415: NStextView DrawIntionPoint (Dalam: Warna: Turnon) tidak pernah dipanggil
• FB9971054: nslayoutManager.enumerateCaretoffsetinLinefragment mengabaikan lokasi awal
• FB9971054: NSTEXTVIEW menegaskan pada pemilihan saat diatur dengan TextKit2
• FB9743449, FB10019859: NStextContentStorage.TextElements (untuk :) Mengembalikan No Element, sementara enumerateTextElements memang mengembalikan elemen elemen
• FB11898356: TextSelection (InteracingAt: Incontainerat: Jangkar: Pengubah: Memilih: Batas :) Menghasilkan Pilihan yang Salah untuk lokasi tertentu
• FB12726775: Dokumentasi ke nstextparagraph.paragraphContentRange salah
• FB13272586: NStextContainer.Size Nilai default tidak seperti yang didokumentasikan
• Fb13290979: nstextcontainer.linefragmentpadding tidak mempengaruhi akhir dari fragmen penggunaan persegi panjang fragmen
• FB13291926: NStextLayoutManager.usageboundsfortextContainer Observer tidak pernah dipicu
• FB13789916: NStextInputClient.SetMarkedText Menyediakan rentang pemilihan palsu untuk keyboard Cina
• FB14700414: NStextList tidak berfungsi sejak macOS 14 (regresi)
• FB15131180: TextKit Bingkai garis ekstra tidak benar dan tidak menghormati ukuran fragmen tata letak (regresi)

... Saya sadar bahwa daftar masalah tidak lengkap. Saya berhasil mengatasi sebagian besar masalah di SttextView.

Mengapa ST?

( ST Prefix adalah singkatan dari " s wift s t udio" karena ss tidak awalan yang baik sejak 1939)

Saran atau umpan balik

Mulai topik diskusi baru atau permintaan tarik.

Saya ingin mendengar dari Anda! Hubungi melalui x/twitter @krzyzanowskim, mastodon @krzyzanowskim @mastodon.social.

Lisensi

Lisensi Sumber Terbuka

Jika Anda membuat aplikasi open-source di bawah lisensi yang kompatibel dengan Lisensi GNU GPL V3, Anda dapat menggunakan SttextView berdasarkan ketentuan GPLV3.

Lisensi Komersial

Dapatkan satu mulai dari € 5.

Jika Anda ingin menggunakan SttextView untuk mengembangkan produk dan aplikasi yang tidak terbuka, lisensi komersial sesuai. Dengan opsi ini, kode sumber Anda disimpan. Anda tidak perlu mengubah seluruh kode sumber aplikasi Anda menjadi lisensi sumber terbuka. Beli Lisensi Komersial SttextView