favicon-marquee
Advanced tools
Comparing version 1.1.2 to 1.1.3
{ | ||
"name": "favicon-marquee", | ||
"version": "1.1.2", | ||
"description": "An animated scrolling favicon for your website", | ||
"main": "lib/main.js", | ||
"scripts": { | ||
"build": "webpack --mode production", | ||
"prepublish": "npm run build", | ||
"webpack": "webpack --mode development" | ||
}, | ||
"keywords": [ | ||
"favicon", | ||
"marquee", | ||
"animated", | ||
"front-end" | ||
], | ||
"author": "Sten Laane <sten@laane.xyz> (https://laane.xyz)", | ||
"license": "MIT", | ||
"repository": "https://github.com/StenAL/favicon-marquee", | ||
"devDependencies": { | ||
"@babel/cli": "^7.8.4", | ||
"@babel/core": "^7.9.0", | ||
"@babel/preset-env": "^7.9.5", | ||
"babel-loader": "^8.1.0", | ||
"core-js": "^3.6.4", | ||
"webpack": "^4.42.1", | ||
"webpack-cli": "^3.3.11" | ||
}, | ||
"browserslist": [ | ||
">0.2%", | ||
"not dead", | ||
"not op_mini all" | ||
], | ||
"files": [ | ||
"lib/main.js" | ||
] | ||
"name": "favicon-marquee", | ||
"version": "1.1.3", | ||
"description": "An animated scrolling favicon for your website", | ||
"main": "lib/main.js", | ||
"scripts": { | ||
"build": "webpack --mode production", | ||
"prepublish": "npm run build", | ||
"webpack": "webpack --mode development" | ||
}, | ||
"keywords": [ | ||
"favicon", | ||
"marquee", | ||
"animated", | ||
"front-end" | ||
], | ||
"author": "Sten Laane <sten@laane.xyz> (https://laane.xyz)", | ||
"license": "MIT", | ||
"repository": "https://github.com/StenAL/favicon-marquee", | ||
"devDependencies": { | ||
"@babel/cli": "^7.11.6", | ||
"@babel/core": "^7.11.6", | ||
"@babel/preset-env": "^7.11.5", | ||
"babel-loader": "^8.1.0", | ||
"core-js": "^3.6.5", | ||
"husky": "^4.3.0", | ||
"lint-staged": "^10.4.0", | ||
"prettier": "2.1.2", | ||
"webpack": "^4.44.2", | ||
"webpack-cli": "^3.3.12" | ||
}, | ||
"browserslist": [ | ||
">0.2%", | ||
"not dead", | ||
"not op_mini all" | ||
], | ||
"files": [ | ||
"lib/main.js" | ||
], | ||
"husky": { | ||
"hooks": { | ||
"pre-commit": "lint-staged" | ||
} | ||
}, | ||
"lint-staged": { | ||
"*.{js,css,md}": "prettier --write" | ||
} | ||
} |
# favicon-marquee | ||
![Scrolling text example 1](https://i.imgur.com/o3f9cWL.gif) | ||
![Scrolling text example 2](https://i.imgur.com/OFJRjuK.gif) | ||
@@ -10,3 +11,3 @@ | ||
This package is transpiled and polyfilled to be pre-ES6 compatible which means it | ||
This package is transpiled and polyfilled to be pre-ES6 compatible which means it | ||
works on all modern browsers | ||
@@ -25,8 +26,11 @@ | ||
## Usage | ||
favicon-marquee can be bundled with all major build tools | ||
favicon-marquee can be bundled with all major build tools | ||
``` | ||
import FaviconMarquee from "favicon-marquee"; | ||
``` | ||
or loaded using a script tag and used as a global variable | ||
``` | ||
@@ -38,4 +42,4 @@ <script type="text/javascript" src="path/to/lib/main.js"> | ||
Now that FaviconMarquee is accessible, you can use it by running the following code | ||
Now that FaviconMarquee is accessible, you can use it by running the following code | ||
``` | ||
@@ -48,8 +52,9 @@ const marquee = new FaviconMarquee({ | ||
``` | ||
This will start the marquee in your current tab with the text `easy!` | ||
FaviconMarquee can be customized by passing the following the properties | ||
to its constructor, although sensible defaults are provided: | ||
`text` - text to be displayed in the favicon. This can be any unicode character | ||
to its constructor, although sensible defaults are provided: | ||
`text` - text to be displayed in the favicon. This can be any unicode character | ||
including emojis, cyrillic, hangul, etc. | ||
@@ -65,7 +70,7 @@ `font` - font of the text. This can be any valid CSS `font-family` value | ||
`marginBottom` - the text rendered is displayed at the bottom of the favicon. This | ||
can optionally be used to add some margin to the bottom to center the text instead | ||
can optionally be used to add some margin to the bottom to center the text instead | ||
These properties must be wrapped in an object before passing them to the constructor. | ||
Additionally, a number can be passed into the `start` to control how often (in ms) the | ||
Additionally, a number can be passed into the `start` to control how often (in ms) the | ||
marquee is re-rendered. | ||
@@ -84,7 +89,10 @@ | ||
``` | ||
## Contributing and Issues | ||
Contributions are always welcome. Anyone can open issues and | ||
pull requests on [GitHub](https://github.com/StenAL/favicon-marquee) | ||
pull requests on [GitHub](https://github.com/StenAL/favicon-marquee) | ||
## License | ||
This project is licensed under the [MIT license](https://github.com/StenAL/favicon-marquee/blob/master/LICENSE) |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
8325
93
10