curved-line

1.0.1 • Public • Published

CurvedLine

CurvedLine (curved-line) is a CSS Houdini implementation to create a custom horizontal line.

CSS Houdini Lines

Getting started

The future of CSS is getting exciting with the arrival of CSS Houdini. Using its Paint API, we can create our custom style implementation.

The browser supports for Paint API is also getting better, and with a polyfill, we can support out more browsers.

1. Load the worklet

Using CDN is the easiest way to add the library:

if ('paintWorklet' in CSS) {
  CSS.paintWorklet.addModule('"https://unpkg.com/curved-line@1.0.0/curved-line.js');
}

Or, download the code and import it to your web page:

if ('paintWorklet' in CSS) {
  CSS.paintWorklet.addModule('path/to/curved-line.js');
}

You can use the polyfill

To add support for all moder browsers, you can load the worklet with css-paint-polyfill fallback.

<script>
  ;(async function() {
    if (CSS['paintWorklet'] === undefined)
      await import('https://unpkg.com/css-paint-polyfill@next/dist/css-paint-polyfill.js')

    CSS.paintWorklet.addModule('https://unpkg.com/curved-line@1.0.0/curved-line.js')
  })()
</script>

3. Ready to use it in your CSS!

To use CurvedLine worlet you need define some custom properties with values and add the value paint(curved-line) on background-image property.

The worklet has default values if you don't define these

.element {
  --curved-lineHeight: 30;             /* default: element height */
  --curved-lineWidth: 5;               /* default: 3 */
  --curved-lineColor: midnightblue;    /* default: 'black' */
  --curved-lineSpread: 20;             /* default: 50 */

  background-image: paint(curved-line);
}
property description default value
--curved-lineHeight: Line height, the height of the curved line element height
--curved-lineWidth Line width, the width of the line 3
--curved-lineColor Line color, the line color 'black'
--curved-lineSpread Line spread, the curve interval length 20

See Also

License

MIT License

Copyright (c) 2020 Hazmi

Readme

Keywords

none

Package Sidebar

Install

npm i curved-line

Weekly Downloads

268

Version

1.0.1

License

ISC

Unpacked Size

31.2 kB

Total Files

5

Last publish

Collaborators

  • hazmi