feat: hyphenation

Annonnymmousss · Annonnymmousss · commit f68213fd31a2 · 2026-04-09T03:38:17.000+05:30
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -152,6 +152,7 @@ vello_encoding = "0.7"
 resvg = "0.47"
 usvg = "0.47"
 parley = "0.6"
+hyphenation = { version = "0.8.3", features = ["embed_all"] }
 skrifa = "0.40"
 polycool = "0.4"
 # Linebender ecosystem (END)
diff --git a/editor/src/messages/portfolio/document/overlays/utility_functions.rs b/editor/src/messages/portfolio/document/overlays/utility_functions.rs
@@ -239,6 +239,7 @@ pub fn text_width(text: &str, font_size: f64) -> f64 {
 		max_height: None,
 		tilt: 0.0,
 		align: TextAlign::Left,
+		hyphenate: false,
 	};
 
 	// Load Source Sans Pro font data
diff --git a/editor/src/messages/portfolio/document/overlays/utility_types_native.rs b/editor/src/messages/portfolio/document/overlays/utility_types_native.rs
@@ -1111,6 +1111,7 @@ impl OverlayContextInternal {
 			max_height: None,
 			tilt: 0.,
 			align: TextAlign::Left, // We'll handle alignment manually via pivot
+			hyphenate: false,
 		};
 
 		// Load Source Sans Pro font data
diff --git a/editor/src/messages/tool/common_functionality/graph_modification_utils.rs b/editor/src/messages/tool/common_functionality/graph_modification_utils.rs
@@ -422,6 +422,9 @@ pub fn get_text(layer: LayerNodeIdentifier, network_interface: &NodeNetworkInter
 	let Some(&TaggedValue::TextAlign(align)) = inputs[graphene_std::text::text::AlignInput::INDEX].as_value() else {
 		return None;
 	};
+	let Some(&TaggedValue::Bool(hyphenate)) = inputs[graphene_std::text::text::HyphenateInput::INDEX].as_value() else {
+		return None;
+	};
 	let Some(&TaggedValue::Bool(per_glyph_instances)) = inputs[graphene_std::text::text::SeparateGlyphElementsInput::INDEX].as_value() else {
 		return None;
 	};
@@ -434,6 +437,7 @@ pub fn get_text(layer: LayerNodeIdentifier, network_interface: &NodeNetworkInter
 		character_spacing,
 		tilt,
 		align,
+		hyphenate,
 	};
 	Some((text, font, typesetting, per_glyph_instances))
 }
diff --git a/editor/src/messages/tool/tool_messages/text_tool.rs b/editor/src/messages/tool/tool_messages/text_tool.rs
@@ -904,6 +904,7 @@ impl Fsm for TextToolFsmState {
 						max_height: constraint_size.map(|size| size.y),
 						tilt: tool_options.tilt,
 						align: tool_options.align,
+						hyphenate: false,
 					},
 					font: Font::new(tool_options.font.font_family.clone(), tool_options.font.font_style.clone()),
 					color: tool_options.fill.active_color(),
diff --git a/node-graph/libraries/core-types/src/text.rs b/node-graph/libraries/core-types/src/text.rs
@@ -43,6 +43,7 @@ pub struct TypesettingConfig {
 	pub max_height: Option<f64>,
 	pub tilt: f64,
 	pub align: TextAlign,
+	pub hyphenate: bool,
 }
 
 impl Default for TypesettingConfig {
@@ -55,6 +56,7 @@ impl Default for TypesettingConfig {
 			max_height: None,
 			tilt: 0.,
 			align: TextAlign::default(),
+			hyphenate: false,
 		}
 	}
 }
diff --git a/node-graph/nodes/gstd/src/text.rs b/node-graph/nodes/gstd/src/text.rs
@@ -59,6 +59,7 @@ fn text<'i: 'n>(
 	/// To have an effect on a single line of text, *Max Width* must be set.
 	#[widget(ParsedWidgetOverride::Custom = "text_align")]
 	align: TextAlign,
+	hyphenate: bool,
 	/// Whether to split every letterform into its own vector path element. Otherwise, a single compound path is produced.
 	separate_glyph_elements: bool,
 ) -> Table<Vector> {
@@ -70,6 +71,7 @@ fn text<'i: 'n>(
 		max_height: has_max_height.then_some(max_height),
 		tilt,
 		align,
+		hyphenate,
 	};
 
 	to_path(&text, &font, &editor_resources.font_cache, typesetting, separate_glyph_elements)
diff --git a/node-graph/nodes/text/Cargo.toml b/node-graph/nodes/text/Cargo.toml
@@ -20,6 +20,7 @@ node-macro = { workspace = true }
 dyn-any = { workspace = true }
 glam = { workspace = true }
 parley = { workspace = true }
+hyphenation = { workspace = true }
 skrifa = { workspace = true }
 log = { workspace = true }
 
diff --git a/node-graph/nodes/text/src/lib.rs b/node-graph/nodes/text/src/lib.rs
@@ -47,6 +47,7 @@ pub struct TypesettingConfig {
 	pub max_height: Option<f64>,
 	pub tilt: f64,
 	pub align: TextAlign,
+	pub hyphenate: bool,
 }
 
 impl Default for TypesettingConfig {
@@ -59,6 +60,7 @@ impl Default for TypesettingConfig {
 			max_height: None,
 			tilt: 0.,
 			align: TextAlign::default(),
+			hyphenate: false,
 		}
 	}
 }
diff --git a/node-graph/nodes/text/src/text_context.rs b/node-graph/nodes/text/src/text_context.rs
@@ -2,9 +2,11 @@ use super::{Font, FontCache, TypesettingConfig};
 use core::cell::RefCell;
 use core_types::table::Table;
 use glam::DVec2;
+use hyphenation::{Hyphenator, Language, Load, Standard};
 use parley::fontique::{Blob, FamilyId, FontInfo};
-use parley::{AlignmentOptions, FontContext, Layout, LayoutContext, LineHeight, PositionedLayoutItem, StyleProperty};
+use parley::{AlignmentOptions, FontContext, Layout, LayoutContext, LineHeight, OverflowWrap, PositionedLayoutItem, StyleProperty};
 use std::collections::HashMap;
+use std::sync::OnceLock;
 use vector_types::Vector;
 
 use super::path_builder::PathBuilder;
@@ -13,6 +15,17 @@ thread_local! {
 	static THREAD_TEXT: RefCell<TextContext> = RefCell::new(TextContext::default());
 }
 
+static EN_US_DICT: OnceLock<Standard> = OnceLock::new();
+
+fn get_dict_for_language(lang: Language) -> Option<&'static Standard> {
+	match lang {
+		Language::EnglishUS | Language::EnglishGB => EN_US_DICT
+			.get_or_init(|| Standard::from_embedded(Language::EnglishUS).expect("embed_all feature must be enabled"))
+			.into(),
+		_ => None,
+	}
+}
+
 /// Unified thread-local text processing context that combines font and layout management
 /// for efficient text rendering operations.
 #[derive(Default)]
@@ -61,14 +74,25 @@ impl TextContext {
 	}
 
 	/// Create a text layout using the specified font and typesetting configuration
+	// TODO: Cache layout builder to avoid re-shaping text continuously.
 	fn layout_text(&mut self, text: &str, font: &Font, font_cache: &FontCache, typesetting: TypesettingConfig) -> Option<Layout<()>> {
 		// Note that the actual_font may not be the desired font if that font is not yet loaded.
 		// It is important not to cache the default font under the name of another font.
 		let (font_data, actual_font) = self.resolve_font_data(font, font_cache)?;
 		let (font_family, font_info) = self.get_font_info(actual_font, &font_data)?;
 
+		let injected: String;
+		let layout_text = if typesetting.hyphenate && typesetting.max_width.is_some() {
+			// TODO: pull language from typesetting config
+			injected = apply_hyphenation(text, Language::EnglishUS);
+
+			&injected
+		} else {
+			text
+		};
+
 		const DISPLAY_SCALE: f32 = 1.;
-		let mut builder = self.layout_context.ranged_builder(&mut self.font_context, text, DISPLAY_SCALE, false);
+		let mut builder = self.layout_context.ranged_builder(&mut self.font_context, layout_text, DISPLAY_SCALE, false);
 
 		builder.push_default(StyleProperty::FontSize(typesetting.font_size as f32));
 		builder.push_default(StyleProperty::LetterSpacing(typesetting.character_spacing as f32));
@@ -77,8 +101,8 @@ impl TextContext {
 		builder.push_default(StyleProperty::FontStyle(font_info.style()));
 		builder.push_default(StyleProperty::FontWidth(font_info.width()));
 		builder.push_default(LineHeight::FontSizeRelative(typesetting.line_height_ratio as f32));
-
-		let mut layout: Layout<()> = builder.build(text);
+		builder.push_default(StyleProperty::OverflowWrap(OverflowWrap::BreakWord));
+		let mut layout = builder.build(layout_text);
 
 		layout.break_all_lines(typesetting.max_width.map(|mw| mw as f32));
 		layout.align(typesetting.max_width.map(|max_w| max_w as f32), typesetting.align.into(), AlignmentOptions::default());
@@ -133,3 +157,38 @@ impl TextContext {
 		max_height < bounds.y
 	}
 }
+
+/// Apply hyphenation to the given text.
+fn apply_hyphenation(text: &str, lang: Language) -> String {
+	let Some(dict) = get_dict_for_language(lang) else {
+		return text.to_string();
+	};
+	let mut out = String::with_capacity(text.len() + text.len() / 8);
+	let mut word_start: Option<usize> = None;
+
+	fn push_hyphenated(out: &mut String, dict: &hyphenation::Standard, word: &str) {
+		const SOFT_HYPHEN: char = '\u{00AD}';
+		let mut segs = dict.hyphenate(word).into_iter().segments().peekable();
+		while let Some(seg) = segs.next() {
+			out.push_str(seg);
+			if segs.peek().is_some() {
+				out.push(SOFT_HYPHEN);
+			}
+		}
+	}
+
+	for (i, c) in text.char_indices() {
+		if c.is_alphabetic() {
+			word_start.get_or_insert(i);
+		} else {
+			if let Some(start) = word_start.take() {
+				push_hyphenated(&mut out, dict, &text[start..i]);
+			}
+			out.push(c);
+		}
+	}
+	if let Some(start) = word_start {
+		push_hyphenated(&mut out, dict, &text[start..]);
+	}
+	out
+}

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@ pub struct TypesettingConfig {`
`43`	`43`	`pub max_height: Option<f64>,`
`44`	`44`	`pub tilt: f64,`
`45`	`45`	`pub align: TextAlign,`
	`46`	`+ pub hyphenate: bool,`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`impl Default for TypesettingConfig {`
`@@ -55,6 +56,7 @@ impl Default for TypesettingConfig {`
`55`	`56`	`max_height: None,`
`56`	`57`	`tilt: 0.,`
`57`	`58`	`align: TextAlign::default(),`
	`59`	`+ hyphenate: false,`
`58`	`60`	`}`
`59`	`61`	`}`
`60`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,7 @@ pub struct TypesettingConfig {`
`47`	`47`	`pub max_height: Option<f64>,`
`48`	`48`	`pub tilt: f64,`
`49`	`49`	`pub align: TextAlign,`
	`50`	`+ pub hyphenate: bool,`
`50`	`51`	`}`
`51`	`52`
`52`	`53`	`impl Default for TypesettingConfig {`
`@@ -59,6 +60,7 @@ impl Default for TypesettingConfig {`
`59`	`60`	`max_height: None,`
`60`	`61`	`tilt: 0.,`
`61`	`62`	`align: TextAlign::default(),`
	`63`	`+ hyphenate: false,`
`62`	`64`	`}`
`63`	`65`	`}`
`64`	`66`	`}`