Skip to content

KuangPF/ribbons

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

80 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Ribbons

๐ŸŒˆ Add a flowing, smart ribbon to the background. demo

Build Status codecov PRs Welcome

English | ็ฎ€ไฝ“ไธญๆ–‡

๐Ÿ“ฆ Install

CDN

<script src="https://cdn.jsdelivr.net/npm/better-ribbons/dist/ribbons.min.js"></script>

If you are using native ES Modules, there is also an ES Modules compatible build:

<script type="module">
  import Ribbons from 'https://cdn.jsdelivr.net/npm/better-ribbons/dist/ribbons.esm.js'
</script>

npm

npm i better-ribbons -S

๐Ÿ”จ Usage

Initialize a Ribbons instance

import Ribbons from 'better-ribbons'

const ribbonsInstacne = new Ribbons()
/* custom option */
const ribbonsOption = new Ribbons(
  {
    size: 100,
    alpha: 0.7
    zIndex: 0.5
  }
)

๐Ÿบ Options

  • size

    • Description: The size of each ribbon
    • Default: 90
    • Type: number
  • alpha

    • Description: ribbon transparency
    • Default: 0.6
    • Type: number
  • zIndex

    • Description: ribbon 'z-index` attribute
    • Default: -1
    • Type: number

โ˜•๏ธ Screenshot

img

LICENSE

MIT ยฉ KuangPF