npm.io
1.0.1 • Published 3 years ago

@fred78290/vue3-content-placeholders

Licence
MIT
Version
1.0.1
Deps
1
Size
18 kB
Vulns
0
Weekly
0
Stars
2

vue3-content-placeholders

npm vue3

This is a port of vue-content-placeholders for vue2 to vue3 from Michał Sajnóg repository

Vue addon for rendering fake content while data is fetching to provide better UX and lower bounce rate.

example


Installation

  • via npm: npm install @fred78290/vue3-content-placeholders --save
  • via yarn: yarn add @fred78290/vue3-content-placeholders

Usage

Include plugin in your main.js file.

import {createApp} from 'vue'
import VueContentPlaceholders from '@fred78290/vue3-content-placeholders'
import '@fred78290/vue3-content-placeholders/style.css'

const app = createApp(...)

...

app.use(VueContentPlaceholders)
Examples:
<content-placeholders>
  <content-placeholders-heading :img="true" />
  <content-placeholders-text :lines="3" />
</content-placeholders>

rendered example

<content-placeholders :rounded="true">
  <content-placeholders-img />
  <content-placeholders-heading />
</content-placeholders>

rendered example

Available components and properties
  • root <content-placeholders>

    • Boolean animated (default: true)
    • Boolean rounded (default: false) - border radius
    • Boolean centered (default: false)

    these properties define how all children components will act

  • <content-placeholders-heading />

    • Boolean img (default: false)
  • <content-placeholders-text />

    • Number lines (default: 4)
  • <content-placeholders-img />


License

See the LICENSE file for license rights and limitations (MIT).

Keywords