https://github.com/spearwolf/spw-border-waves
waves as web component
https://github.com/spearwolf/spw-border-waves
html javascript webcomponent
Last synced: 27 days ago
JSON representation
waves as web component
- Host: GitHub
- URL: https://github.com/spearwolf/spw-border-waves
- Owner: spearwolf
- Created: 2021-11-20T16:47:26.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-26T13:04:49.000Z (about 4 years ago)
- Last Synced: 2025-03-15T18:40:08.927Z (about 1 year ago)
- Topics: html, javascript, webcomponent
- Language: JavaScript
- Homepage:
- Size: 7.52 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Waves as Web Component
## Usage
1. Build
```sh
$ npm run build
$ copy build/spw-border-waves.js $TO_YOUR_PUBLIC_STATIC_ASSETS_DIRECTORY
```
2. Integrate as web component
```html
```
## Development
```sh
$ npm run start
```
### Roadmap v1.0
- [x] add pause-offset to now/delta-time.. (switch browser tab and come back _issue_)
- [x] set initial seed (random-as-default? time?)
- [x] read from custom styles/css properties
- [x] color
- [x] align-border {top|bottom}
- [x] add signals/properties for
- [x] wave-frequency
- [x] wave-speed
- [x] align-border {top|bottom}
- [ ] remove/deactivate-by-default console debug logs
- [ ] add console ascii art banner :wink:
- [ ] add check and warning when script is loaded multiple times
- [ ] npm package output, for _no-install-usage_ by using e.g. https://skypack.dev
- [ ] add custom-elements.json to npm pkg
- [ ] cheat-sheet documentation
- [ ] add to README
- [ ] check/verify cleanup on dispose, disconnect ..
- [ ] do not render if element is outside of viewport
## Support
Need help? Please [open an issue](https://github.com/spearwolf/spw-border-waves/issues/new) for support.
## License
This project is licensed under MIT.