@svag/shadow

@svag/shadow is a shadow from a window.

yarn add -E @svag/shadow

Table Of Contents

• Table Of Contents
• API
  • shadow(options: ShadowOptions)
    • ShadowOptions
• TODO
• Copyright

API

The package is available by importing its default function:

import shadow from '@svag/shadow'

shadow(
  options: ShadowOptions,
): void

Creates a shadow for a window with given width and height.

ShadowOptions: Options to generate macOS like shadow using a blur filter.

import Shadow from '@svag/shadow'

const shadow = Shadow({
  width: 250,
  height: 250,
})

console.log(shadow)

<defs>
  <filter x="-22%" y="-10%" width="144%" height="142%" id="shadow">
    <feOffset dx="0" dy="25" in="SourceAlpha" result="so"/>
    <feGaussianBlur stdDeviation="27.5" in="so" result="sb"/>
    <feColorMatrix values="0 0 0 0 0   0 0 0 0 0   0 0 0 0 0  0 0 0 0.5 0" type="matrix" in="sb" result="sm"/>
    <feMerge>
      <feMergeNode in="sm"/>
      <feMergeNode in="SourceGraphic"/>
    </feMerge>
  </filter>
</defs>

TODO

• API returns a string.
• Update the image refernce to display on NPM.
• Export types.
• Cut example before console.log.

Copyright

(c) SVaG 2018