JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 5
  • Score
    100M100P100Q35821F
  • License MIT

Diagonally cross out text using data attribute

Package Exports

  • crossout

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (crossout) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Crossout

Diagonally crosses out words using data attribute

Usage

npm install crossout

<script src="path/to/crossout.js"></script>

<span data-crossedout>consectetur adipisicing</span>
<script>
    new Crossout();
</script>

Settings

  • thickness (default: 2): How thick the line will be
  • color (default: #000000): The colour of the line
  • rounded (default: false): Whether to round the edges of the line
  • extension (default: 0): How far out to extend the line past text width
  • reverseDirection (default: false): Whether to go bottom left to top right or top left to bottom right

Global

Global settings are configured when making a new Crossout object, example:

new Crossout({thickness: 4, color: '#ab6789'});

If not specified, the defaults above will be used

Local

Local settings are configured in the data attribute of the spans, example:

<span data-crossedout='{rounded: true, extension: 16, reverseDirection: true}'>...</span>

Local settings will override global settings