Skip to content

ObfuscateText API

API reference docs for the Stash ObfuscateText component. Learn about the props, CSS, and other APIs of this exported module.

Import

ts
import ObfuscateText from '@leaflink/stash/ObfuscateText.vue';

Props

NameTypeDefaultDescription
textstring '-' The full text
lengthToKeepnumber0Num of characters to keep revealed. Default will obfuscate entire string with length of maskCharCount.
maskCharstring '•' Character to obfuscate text with
maskCharCountnumber10The number of masked characters to display
obfuscateAllbooleanfalseWhether to obfuscate all characters.
position"start" | "end"startPosition to start obfuscating text
showTogglebooleanfalseDisplays a button for toggling text visibility

Slots

None

Events

None