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] Veniam aute est enim nostrud ipsum culpa!
[Unstable] Velit officia ullamco qui excepteur laborum adipiscing voluptate tempor?
[Length: 2] Proident dolore amet magna laboris ut nostrud dolor lorem do qui. Dolor veniam velit sit qui aliqua eu fugiat fugiat labore.

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.