Truncate String

PreviousNext

Truncate a string to a given length.

Docs
utilcnlib

Preview

Loading preview…
registry/default/strings/truncate-string.ts
/**
 * Truncates a string to a given length and appends an ellipsis ("...") if necessary.
 *
 * @param str - The input string.
 * @param length - The maximum length of the string.
 * @returns The truncated string with "..." if it exceeded the limit.
 *
 * @example
 * truncate("Hello TypeScript World", 10); // "Hello Type..."
 */
export function truncateString(str: string, length: number): string {
  return str.length > length ? `${str.slice(0, length)}...` : str;
}

Installation

npx shadcn@latest add @utilcn/truncate-string

Usage

import { TruncateString } from "@/lib/truncate-string"
TruncateString()