Skip to content

CHANGELOG.md

Latest commit

 

History

History
750 lines (552 loc) · 35.7 KB

CHANGELOG.md

File metadata and controls

750 lines (552 loc) · 35.7 KB
Raw

Changelog

Unreleased

This release has an MSRV of 1.88.

Added

Parlance

  • BidiLevel to encode bidirectional text embedding levels. (#710 by @tomcur)
  • Script::is_cursive returning whether a script is cursive. (#728 by @tomcur)
    This can be used to decide, for example, whether to apply letter spacing.

Fontique

  • Collection::family_ids to iterate over unique font family identifiers. (#725 by @tomcur)

Changed

Parley

  • Breaking change: the Glyph::style_index field was removed. Use Cluster::{style, style_index} or GlyphRun::{style, style_index} instead. (#661 by @tomcur)
  • Breaking change: Cluster now spans a full grapheme cluster instead of a single character. (#715 by @tomcur)
    Shaped clusters that cross grapheme boundaries are represented using the existing Cluster::is_ligature_start and Cluster::is_ligature_continuation; note these methods previously encoded graphemes as well. Shaped clusters' advances are split evenly over the grapheme clusters they overlap. Run::cluster_range now returns grapheme cluster indices relative to the run's shaped run.
  • Breaking change: lines with mixed inline content, like different fonts or sizes, or inline boxes, are now sized more closely to the CSS line-box model. (#697 by @tomcur)
    The LineMetrics::{ascent,descent,leading} fields were removed, and LineMetrics::block_{min,max}_coord now describe the block-axis layout bounds of each line box. Glyphs may overflow these layout bounds, especially when a small line height is used. LineMetrics::content_block_{min,max}_coord provide the typographic content bounds, covering typographic ascent and descent as well as inline boxes, ignoring the specified line height. Note glyphs overflow these content bounds as well, for example when many combining marks are stacked. The union of the line-box and content bounds is close to the old LineMetrics::block_{min,max}_coord fields.
  • parley::editing::Cursor::{previous,next}_logical_word now land at the previous/next logical start of a word and skip over whitespace. (#215 by @tomcur)

Fixed

Parley

  • Applying letter spacing now stops optional ligatures from forming. (#731 by @tomcur)

Fontique

  • Fix compilation on 32-bit platforms without 64-bit atomics (e.g. mipsel-unknown-linux-gnu). (#671 by @nicoburns)
  • Don't panic when fontconfig exposes no fonts. (#717 by @ogoffart)

0.11.0 - 2026-06-24

This release has an MSRV of 1.88.

Added

Parley

  • Line break opportunity override (#640 by @taj-p). The builders now have a set_line_break_override method which can be used to customise where Parley detects line-breaking opportunities. It can be called with Some(parley::CHROMIUM_LINE_BREAK_OVERRIDE) to make line-breaking match Chromium, or with a custom instance of AsciiLineBreakTable created with AsciiLineBreakTableBuilder. If you do not call the function then you will get the existing standard ICU-defined behavior.
  • From conversions into StyleProperty for FontWidth, FontStyle, FontWeight, WordBreak, OverflowWrap, and TextWrapMode, matching the existing conversions for font family, variations, features, and line height. (#643 by @waywardmonkeys)

Changed

Parley

  • Upgrade to read-fonts 0.40, skrifa 0.43, harfrust 0.10 (#650 by @nicoburns)

Fixed

Parley

  • Fix font selection for emoji followed by a variation selector (#637 by @kane50613)

0.10.0 - 2026-06-01

This release has an MSRV of 1.88.

Added

Parley

  • Add complex-scripts Cargo feature to enable dictionary-based line and word breaking for complex scripts (CJK, Thai, Khmer, Lao, Myanmar). When disabled, the lightweight segmenter is used (no change in default behavior) (#621 by @Linktime)
  • PlainEditor, Layout, LayoutAccessibility, and Generation now implement Debug. (#615 by @NandishwarSingh) Note: The Layout implementation provides a compact summary by default; the alternate form ({:#?}) formats the full underlying data.
  • Add StyleSet::clear method (#614 by @lainon1)
  • Restore the ability to use a different alignment width than breaking width (#618 by @DJMcNab)

Fontique

Fixed

Parley

  • StyleRunBuilder now handles a first style run that references a non-zero style table index. (#626 by @waywardmonkeys)
  • Fix color emoji matching when emoji with non printing variation selector (#617 by @fundon)

Changed

Parley

0.9.0 - 2026-04-21

This release has an MSRV of 1.88.

Added

Parley

  • Floating boxes and other advanced layouts. (#421 by @nicoburns)

    This comes with a few changes to the API. Additionally, it brings a number of additional advanced capabilities to users who are calling the break_lines() function to use the BreakLines struct directly:

    • The Layout::align method no longer accepts a width parameter. Text will now automatically be aligned relative to the max_advance passed to break_all_lines(), unless that is Infinite (or f32::MAX which we treat as infinite) in which case it will be aligned relative to the width of the longest line in the layout. Additionally, if a line is given a (non-infinite) line-specific line_max_advance using the advanced BreakLines API, then it will aligned relative to that width instead.
    • The min_coord and max_coord fields of LineMetrics which record the start and end position of the line in the block/y axis are renamed to block_min_coord and inline_min_coord, and there are new inline_min_coord and inline_max_coord which record the start and end position of the line in the x/inline axis.
    • Inline boxes now have an additional InlineBoxKind field. InFlow behaves like inline boxes in previous versions of Parley. OutOfFlow gets positioned like an InFlow box, but does not take up space (like position:absolute in CSS), and CustomOutOfFlow can be used in conjunction with the low-level .break_lines() API to implement floated boxes (like CSS float) which position depends on the state of line breaking.
    • Each line can have it's x/y/width/height set individually, and text will lay out into that box (the width for each line must be less than or equal to the width of the overall layout). This enables text to be laid out around "excluded regions", by setting a line box that avoids those regions. The logic for computing the positions of each line is left to the user.

Fontique

  • FallbackKey now implements From<Script> for convenience. (#594 by @xStrom)

Changed

Fixed

Parley

  • Going to the start of text when moving up on a single line. (#609 by @jordanhalase)

Fontique

  • CJK text on macOS when PingFangUI contains hvgl outlines. (#598 by @dfrg)

0.8.0 - 2026-03-27

This release has an MSRV of 1.88.

Added

Parley

  • CSS text-indent support. (#551 by @devunt)
  • break_line_with_next method which implements a new line-breaking algorithm based on the number of characters rather than the width of the text. (#575 by @taj-p)
  • Layout::lines now returns an iterator that also implements ExactSizeIterator and DoubleEndedIterator. (#554, #560 by @xStrom)
  • BoundingBox now implements Debug. (#486 by @taj-p)
  • Lower-level StyleRunBuilder to go along with the existing RangedBuilder and TreeBuilder. StyleRunBuilder accept non-overlapping ranges of styles. (#516 by @waywardmonkeys)
  • X-height, cap-height to RunMetrics. (#523 by @elbaro)
  • All possible AccessKit text properties. (#563 by @mwcampbell)
  • PlainEditor getters scale, font_size, and default_style. (#571 by @zeophlite)

Fontique

  • load_system_fonts and load_fonts_from_paths methods. (#540 by @nicoburns)
  • Method to convert non-shared Collection/SourceCache to shared variants. (#541 by @nicoburns)

Fixed

Parley

  • Max-content width being reset to 0 by mandatory line breaks. (#531 by @nicoburns)
  • Cursor rectangle calculation for last line. (#547 by @areopagitics)
  • Treat Line Separator and Paragraph Separator as mandatory break. (#549 by @xorgy)
  • Justification space count for non-space line breaks. (#565 by @devunt)
  • Font fallback by computing map_len in fill_cluster_in_place. (#566 by @devunt)

Fontique

  • Clear fallback_families cache on attribute change. (#562 by @dqii)
  • Fix font family name override being ignored during registration. (#564 by @devunt)
  • Reset fallback cache when fallback families are modified. (#567 by @devunt)
  • Panic on Windows 7. (#589 by @guiguiprim)

Changed

Parley

  • AccessKit has been updated to v0.24. (#532 by @nicoburns)

  • Fontations has updated: harfrust (0.5), skrifa (0.40), read-fonts (0.37). (#510 by @waywardmonkeys)

  • Parley now uses icu4x rather than swash for text analysis. (#436 by @conor-93 and @taj-p)

  • TextStyle now uses separate lifetimes for family vs settings. This lets callers keep a long-lived font-family value while borrowing per-run settings without forcing both to share a single lifetime. (#519 by @waywardmonkeys)

  • Breaking change: Glyph::y is now in Y-down coordinate space instead of Y-up coordinate space. (#528 by @valadaptive)

    This does not change the API surface, but will change the behavior of existing code! If you're iterating over non-positioned glyphs using the GlyphRun::glyphs method and positioning each glyph yourself, with code like:

    let run_y = glyph_run.baseline();
for glyph in glyph_run.glyphs() {
  let glyph_y = run_y - glyph.y;
  ...
}

    You'll need to update your code to add glyph.y, instead of subtracting it:

    let run_y = glyph_run.baseline();
for glyph in glyph_run.glyphs() {
  let glyph_y = run_y + glyph.y;
  ...
}

    If you instead use the GlyphRun::positioned_glyphs method, your code will not need to change.

Fontique

Removed

Fontique

  • Fontique no longer has conversions between it's script type and that of icu4x and unicode_properties. If you need these then you will now need to implement the conversions yourself (see linked PR for removed implementation). (#512 by @waywardmonkeys)

0.7.0 - 2025-11-24

This release has an MSRV of 1.83.

Highlights

#448 by @taj-p) and (#449 by @nicoburns collectively fix a significant performance bug that occurred when laying out large paragraphs of text. Previously the time to perform layout was non-linear with respect to the input size and laying out paragraphs of text with more than ~1k characters was very slow.

The new TextWrapMode style implements the semantics of the text-wrap-mode CSS property and allows text-wrapping to be disabled completely for a span of text.

Migration

Some modules have been moved:

  • parley::editor and parley::layout::editor are now parley::editing.
  • parley::layout::cursor is now parley::cursor.

Fontique no longer sets the dlopen feature of yeslogic-fontconfig-sys by default. If you wish to run Fontique on a Linux system without fontconfig installed then you will need to enable the new fontconfig-dlopen feature of the fontique crate. If you wish to compile Fontique on a Linux system without the fontconfig-dlopen enabled then you will need the fontconfig dev package (e.g. libfontconfig1-dev on Ubuntu) installed.

Added

Parley

  • Add TextWrapMode style. This allow line wrapping to be disabled completely for a span of text (excluding explicit line breaks). (#367 by @nicoburns)
  • Add Cluster::from_point_exact method for hit-testing spans of text. This is useful for implementing "hover" or "click" functionality. (#447 by @nicoburns)

Changed

Parley

Fontique

  • Make the yeslogic-fontconfig-sys/dlopen feature optional. #467 by @ogoffart)

Fixed

Parley

  • Running line height calculation. (#448 by @taj-p)
  • Optimise line height computation. (#449 by @nicoburns)
  • Add word and letter spacing to text layout based on style properties. (#468 by @dolsup)
  • Hang trailing whitespace preceding explicit newline. (#276 by @wfdewith)

Fontique

0.6.0 - 2025-10-06

This release has an MSRV of 1.82.

Highlights

Parley now uses HarfRust rather than Swash. This means that Parley now has production-quality shaping for all scripts and can be recommended for general usage.

Migration

As Parley now uses it's own parley::BoundingBox in place of kurbo::Rect, you may need to convert the type if you were previously passing one of these values into a function that expects kurbo::Rect. The following function may be used to perform this conversion:

fn bounding_box_to_rect(bb: parley::BoundingBox) -> kurbo::Rect {
    kurbo::Rect::new(bb.x0, bb.y0, bb.x1, bb.y1)
}

Added

Parley

  • Shift-click support through Selection::shift_click_extension and PlainEditorDriver::shift_click_extension. (#385 by @kekelp)
  • Add some benchmarks using Tango. (#405 by @taj-p)

Fontique

  • Cache character mapping metadata for each font to improve performance of font selection. (#413 by @dfrg)
  • Upgrade icu4x dependencies to v2.x. (#418 by @nicoburns)
  • Added an unregister_font method to remove a font from a collection. (#395 by @taj-p)

Changed

Parley

  • Breaking change: Alignment variants have been renamed to better match CSS. Alignment::Justified is now Alignment::Justify and Alignment::Middle is now Alignment::Center. (#389 by @waywardmonkeys)
  • In the PlainEditor, triple-click now selects paragraphs rather than words (#381 by @DJMcNab)
  • Updated to accesskit 0.21. (#390 by @mwcampbell)
  • Uses HarfRust for text shaping. (#400 by @taj-p)
  • Parley no longer depends on peniko or kurbo. (#414 by @nicoburns):
    • Breaking change: The use of peniko::Font has been replaced with linebender_resource_handle::FontData, as such parley::Font is now called Parley::FontData. Note that this is the same type as in previous releases, and so is fully backwards-compatible, just with a different name.
    • Breaking change: The use of kurbo::Rect has been replaced with a new parley::BoundingBox type.

Fontique

  • The fontconfig backend, used to enumerate system fonts on Linux, has been rewritten to call into the system's fontconfig library instead of parsing fontconfig's configuration files itself. This should significantly improve the behavior of system fonts and generic families on Linux. (#378 by @valadaptive)
  • Fontique no longer depends on peniko. The use of peniko::Blob has been replaced with linebender_resource_handle::Blob. This is unlikely to affect users of the crate. (#414 by @nicoburns)

Fixed

Parley

  • Selection extension moves the focus to the side being extended. (#385 by @kekelp)
  • Ranged builder default style not respecting scale. (#368 by @xStrom)
  • Cluster source character not correct. (#402 by @taj-p)
  • Don't justify the last line of a paragraph. (#410 by @taj-p)

Fontique

  • Font family name aliases (secondary names for font families, often in another language) not being registered. (#380 by @valadaptive)

0.5.0 - 2025-06-01

This release has an MSRV of 1.82.

Added

Parley

Changed

Parley

  • Breaking change: Layout::min_content_width, Layout::max_content_width, and Layout::content_widths have been replaced with Layout::calculate_content_widths, which does not internally cache the widths. This means that Layout is now Sync again, but callers will have to cache the min and max content widths themselves. (#353 by @valadaptive)
  • Breaking change: the line height style property (StyleProperty::LineHeight and the line_height field on TextStyle) is now a LineHeight enum that allows you to specify absolute, font-size-relative, and font-metrics-relative line heights. Previously, it was always font-size-relative. (#362 by @valadaptive)
    • The default line height was previously LineHeight::FontSizeRelative(1.0) if you used RangedStyleBuilder, or LineHeight::FontSizeRelative(1.2) if you used TreeStyleBuilder. It is now LineHeight::MetricsRelative(1.0) in both cases. This will affect layout if you don't specify your own line height.
  • Breaking change: {RangedBuilder, TreeBuilder}::{build_into, build} methods now consume self. (#369 by @dhardy)

0.4.0 - 2025-05-08

This release has an MSRV of 1.82.

Migration

Quantization of vertical layout metrics is now optional. For an easy upgrade we recommend enabling it by setting quantize to true when calling LayoutContext::ranged_builder or LayoutContext::tree_builder.

Added

Parley

  • Option to skip quantization of vertical layout metrics for advanced rendering use cases. (#297 by @valadaptive, #344 by @xStrom)
  • The WordBreak and OverflowWrap style properties for controlling line wrapping. (#315 by @valadaptive)
  • PlainEditor methods raw_selection and raw_text. (#316, #317 by @mwcampbell)
  • PlainEditor::selection_geometry_with, the equivalent of Selection::geometry_with method. (#318 by @valadaptive)
  • BreakLines::is_done method to check if all the text has been placed into lines. (#319 by @valadaptive)

Changed

Parley

  • Breaking change: Selection::geometry, Selection::geometry_with, and PlainEditor::selection_geometry now include the line indices that the selection rectangles belong to. (#318 by @valadaptive)
  • Updated to accesskit 0.19. (#294 by @waywardmonkeys, #348 by @xStrom)
  • Now displaying selected newlines as whitespace in the selection highlight. (#296 by @valadaptive)
  • Made BreakReason public. (#300 by @valadaptive)

Fontique

  • Breaking change: Collection::register_fonts now takes a Blob<u8> instead of a Vec<u8>. (#306 by @valadaptive)
  • Breaking change: Collection::register_fonts now takes an optional second parameter which allows overriding the metadata used for matching the font. (#312 by @valadaptive)

Fixed

Parley

  • Text editing for layouts which contain inline boxes. (#299 by @valadaptive)
  • Cursor navigation in RTL text sometimes getting stuck within a line. (#331 by @valadaptive)
  • Using Layout::align on an aligned layout without breaking lines again. (#342 by @xStrom)
  • Selection box height going below ascent + descent with small line heights. (#344 by @xStrom)
  • Rounding error accumulation of vertical layout metrics. (#344 by @xStrom)

Fontique

  • Panic on macOS when running in debug mode. (#335 by @NoahR02)

0.3.0 - 2025-02-27

This release has an MSRV of 1.82.

Added

Parley

  • Generation on PlainEditor to help implement lazy drawing. (#143 by @xorgy)
  • Support for preedit for input methods in PlainEditor. (#192 by @DJMcNab, #198 by @tomcur)
  • PlainEditor method to get a cursor area for use by the platform's input method. (#224 by @tomcur)
  • Layout methods to calculate minimum and maximum content widths. (#259 by @wfdewith)
  • PlainEditor now implements Clone. (#133 by @nicoburns)
  • Navigation and byte selection operations for PlainEditor. (#146 by @xorgy)
  • AccessKit integration. (#166 by @mwcampbell)
  • first_style method to Cluster. (#264 by @nicoburns)

Fontique

Changed

Parley

  • Breaking change: The cursor API has been completely reworked. (#170 by @dfrg)
  • Breaking change: PlainEditors API is now method-based rather than enum based. (#154 by @mwcampbell)
  • Breaking change: PlainEditor's semantics are no longer transactional. (#192 by @DJMcNab)
  • Breaking change: Alignment::Start and Alignment::End now depend on text base direction. Alignment::Left and Alignment::Right are introduced for text direction-independent alignment. (#250 by @tomcur)
  • Breaking change: Layout is no longer Sync. (#259 by @wfdewith)
  • Breaking change: PlainEditor's width is now Option<f32> rather than f32. (#137 by @nicoburns)
  • Breaking change: Make alignment when free space is negative configurable. (#241 by @nicoburns)
  • Allow Bidi base_level to be determined from text. (#245 by @tomcur)

Fontique

Fixed

Parley

  • Alignment of right-to-left text. (#250, #268 by @tomcur)
  • Performing line breaking or aligning a layout again, after justified alignment had been applied previously. (#271 by @tomcur)
  • Placement of inline boxes. (#163 by @spirali)
  • Cursor position for lines that are not left-aligned. (#169 by @mwcampbell)
  • Cursor::from_point not using the line's offset. (#176 by @DJMcNab)
  • Off-by-one error in PlainEditor::cursor_at. (#187 by @tomcur)
  • Binary search in Layout::line_for_offset. (#188 by @tomcur)
  • Whitespace collapsing at the start of inline spans. (#191 by @nicoburns)
  • Collapsing selection. (#201 by @tomcur)
  • Affinities not being ignored in Selection::is_collapsed. (#202 by @tomcur)
  • Misc. inline box layout issues. (#207 by @nicoburns)
  • Linebreaking for lines without text runs. (#249 by @wfdewith)
  • Calculating trailing whitespace for all lines. (#256 by @wfdewith)
  • Strip whitespace following a newline when whitespace collapsing is enabled. (#254 by @nicoburns)
  • Account for inline boxes when collapsing whitespace after newlines. (#280 by @nicoburns)

Fontique

  • Skip adding font family as fallback if it has zero coverage for given script. (#182 by @richardhozak)

0.2.0 - 2024-10-10

This release has an MSRV of 1.75.

Added

Parley

  • Example using tiny-skia which renders into a PNG. (#55 by @nicoburns)
    • Breaking change: There is now a blanket implementation for Brush.
  • A Swash example which renders into a PNG. (#54 by @nicoburns)
  • An example with Vello on Winit which shows a basic text editor .(#106 by @dfrg)
  • PlainEditor, a basic action-based text editor based on Parley Selection and Cursor. (#126 by @xorgy)
  • Tree style builder. (#76 by @nicoburns)
  • Conversions for FontFamily, FontStack, and StyleProperty to make styling more ergonomic. (#129 by @xorgy)

Changed

General

Parley

  • Emoji clusters now get an Emoji family added by default. (#56 by @dfrg)
  • Style builders now accept Into<StyleProperty<'a, B: Brush>> so you can push a GenericFamily or FontStack directly. (#129 by @xorgy)

Fontique

Fixed

Fontique

Removed

Fontique

  • Breaking change: removed conversion to/from icu_properties::Script for fontique::Script. (#72 by @waywardmonkeys)
    • This can be restored by using the icu_properties feature of fontique.

0.1.0 - 2024-05-01

This release has an MSRV of 1.70.

  • Initial release