Guide
Reference
Roadmap
Guide
Reference
Roadmap

useLoremIpsum

Tags:
Utilities
DevOnly

A React Hook that helps to generate Lorem Ipsum text. Useful for testing and placeholder text.

Demo

Source
[Stable] Do aute fugiat sit anim dolor excepteur quis do irure culpa?
[Unstable] Velit voluptate ipsum do deserunt nisi consequat, esse ut in cillum.
[Length: 2] Sint adipiscing cupidatat laborum et, quis velit. Aliqua est irure excepteur non qui aute aliqua?

Usage

See API for more details.

Source

Click links below to view source on GitHub.

🪝 Hook🎨 Demo📄 Document

API

const text = useLoremIpsum(length) // 1 sentence by default
const text = useLoremIpsum(options)

Length

A number that represents the number of sentences to generate.

Options

export interface UseLoremIpsumOptions {
  /**
   * The length of the generated text sentence.
   *
   * @defaultValue 1
   */
  length?: number
  /**
   * The minimum number of words in a sentence.
   *
   * @defaultValue ['.', '!', '?']
   */
  sentenceEnds?: string[]
  /**
   * Whether to keep the same value between renders.
   *
   * @defaultValue true
   */
  stable?: boolean
}

Returns

A string that represents the generated text.