@minskylab/realshadow/README.md

A simple library to give shadows based on the current real time for any html element.

# Real Shadow

Realshadow adds a real time based shadow for any HTML Element.
It works with the current time calculating each `1 second` the shadow based on the current hour. You can see the below image for more details.

![realshadow how it works](https://i.imgur.com/MPCmzGb.png)

## Demo

See this codepen: [https://codepen.io/bregydoc/pen/RwoXPVJ](https://codepen.io/bregydoc/pen/RwoXPVJ).

## How to use

Only need to add this line at the end of your `body` tag:

```html
<script src="https://unpkg.com/@minskylab/realshadow/umd/index.min.js" type="text/javascript"></script>
```

Now, you can apply the real shadow only adding the `data-rs-kind` data tag with options `drop|box|text|both`:

### Basic Example

```html
<div data-rs-kind="box" />
<span data-rs-kind="text"> HELLO WORLD </span>
```

### Options

You can configure the behavior of your realshadow using the below data tags.

```env
data-rs-kind="box" # Shadow kind
```

```env
data-rs-from-hour="06" # Sunset hour
```

```env
data-rs-to-hour="18" # Sunrise hour
```

```env
data-rs-distance="10" # Shadow distance
```

```env
data-rs-color="#0d1117" # Shadow color
```

```env
data-rs-blur-radius="2" # Shadow blur radius (in pixels)
```

```env
data-rs-hour="10:00" # Forced static hour
```

#### Shadow kind

The shadow kind: `drop|box|text|both`.

box-shadow: [Official Documentation](https://developer.mozilla.org/en-US/docs/Web/CSS/box-shadow).
text-shadow: [Official Documentation](https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow).
drop (filter): [Official Documentation](https://developer.mozilla.org/en-US/docs/Web/CSS/filter).

---

## Contribute

I need to complete this documentation, if you want to help only make an issue or pull request. Thanks.