generaltranslation 8.1.0: Locale-aware text truncation

Overview

generaltranslation@8.1.0 introduces formatCutoff(), a locale-aware text truncation function that handles character limits with appropriate terminators for different languages.

Motivation

UI text truncation typically relies on CSS text-overflow: ellipsis or simple string slicing, but these approaches don't account for locale-specific conventions. Different languages use different ellipsis characters, spacing, and punctuation rules when text is cut off.

Additionally, when AI translations are constrained to character limits, there's often a need to strictly enforce those limits on the client side as a fallback.

Usage

formatCutoff() is available both as a GT instance method and standalone function:

import { GT, formatCutoff } from 'generaltranslation'
 
const gt = new GT({ targetLocale: 'en-US' })
 
// Basic truncation
gt.formatCutoff('Hello, world!', { maxChars: 9 })
// Returns: 'Hello, w…'
 
// Standalone function
formatCutoff('Hello, world!', {
  locales: 'fr-FR',
  maxChars: 9
})
// Returns: 'Hello, w\u202F…'  // Note the narrow space before ellipsis

Locale-specific terminators

Different locales use different ellipsis styles:

// Chinese and Japanese use double ellipsis
formatCutoff('你好世界', { locales: 'zh-CN', maxChars: 4 })
// Returns: '你好……'
 
// French uses narrow non-breaking space before ellipsis
formatCutoff('Bonjour', { locales: 'fr-FR', maxChars: 6 })
// Returns: 'Bonj\u202F…'

Custom terminators

Override default behavior with custom terminators and separators:

gt.formatCutoff('Long text here', {
  maxChars: 13,
  terminator: '...',
  separator: ' '
})
// Returns: 'Long text ...'

Foundation for UI libraries

This functionality serves as the base layer for UI-specific implementations in gt-react and gt-next, which will expose subsets of this functionality appropriate for their frameworks.