65 lines
1.3 KiB
Plaintext
65 lines
1.3 KiB
Plaintext
---
|
|
title: Highlight Text
|
|
description: A text component that smoothly reveals an animated highlight effect.
|
|
author:
|
|
name: imskyleen
|
|
url: https://github.com/imskyleen
|
|
---
|
|
|
|
<ComponentPreview name="highlight-text-demo" />
|
|
|
|
## Installation
|
|
|
|
<ComponentInstallation name="highlight-text" />
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
<HighlightText text="Hello world!" />
|
|
```
|
|
|
|
## Props
|
|
|
|
<TypeTable
|
|
type={{
|
|
text: {
|
|
description: 'The text to be highlighted',
|
|
type: 'string',
|
|
required: true,
|
|
},
|
|
className: {
|
|
description: 'The className of the component',
|
|
type: 'string',
|
|
required: false,
|
|
},
|
|
inView: {
|
|
description: 'Enable animation when in view.',
|
|
type: 'boolean',
|
|
default: 'false',
|
|
required: false,
|
|
},
|
|
inViewMargin: {
|
|
description: 'The margin of the in view.',
|
|
type: 'string',
|
|
required: false,
|
|
default: '0px',
|
|
},
|
|
inViewOnce: {
|
|
description: 'Enable animation when in view once.',
|
|
type: 'boolean',
|
|
required: false,
|
|
default: 'true',
|
|
},
|
|
transition: {
|
|
description: 'The transition of the highlight text',
|
|
type: 'Transition',
|
|
required: false,
|
|
default: "{ duration: 2, ease: 'easeInOut' }",
|
|
},
|
|
}}
|
|
/>
|
|
|
|
## Credits
|
|
|
|
- Credits to [Aceternity UI](https://ui.aceternity.com/components/hero-highlight) for the inspiration
|