url-animations
v1.0.8
Published
Animations in your Browser URL Field
Downloads
6
Maintainers
lunarfang_416Readme
URL Animations
Add loading animations to your website in your browser URL field.
https://user-images.githubusercontent.com/73078183/209571272-a7110cbf-7fb4-4b21-b198-1f9968b92a00.mov
Usage
Install the NPM package using npm i url-animations
To use the Animations you must first decide what animation to use. You can choose from the different stock animations from here.
import { URLAnimations, Animations } from 'url-animations';
const URL = URLAnimations();
URL.start(Animations.deafult)
// specify Animation here
setTimeout(() => {
URL.stop(); // Stop Animation
}, 5000)To implement your own animation you can implement the BaseAnimation interface from scratch (More info in Contribution Section). Or implement a class adhering to the BaseAnimation interface (see ./src/animations/custom).
However, if you do not want to create an animation interface/class from scratch, you can use the Custom Animation Class to specify a sequence of frames along with the frameRate (aka speed of animation), which is defaulted to 500. If you want to test this out, you can do to the demo and configure your custom sequence using the custom option.
import { URLAnimations, Animations, Custom } from 'url-animations';
const URL = URLAnimations();
URL.start(new Custom(["5", "4", "3", "2", "1"], 600))
// Pass Custom Object as Parameter
setTimeout(() => {
URL.stop(); // Stop Animation
}, 5000)
Vanilla JS
The package can be used in Vanilla JS as well. Using an open source npm package CDN like jsdelivr, unpkg etc. you can include it in your html file and use it as such:
<body>
<script src="https://cdn.jsdelivr.net/npm/url-animations/dist/index.js"></script>
<script>
const { URLAnimation, Animations } = window.url_animations;
const URL = URLAnimation();
URL.start(ANIMATIONS.shark);
setTimeout(() => {
URL.stop();
}, 5000)
</script>
</body>
API
URLAnimation
Core Functionality of URL Animation.
URL.start(animation: BaseAnimation)
- Commences Specified Animaiton
URL.stop()
- Stops current running Animation
const URLAnimation: () => {
start: (animation: BaseAnimation) => void;
stop: () => void;
};Animations
Contains All stock URL Animation implementations to use. Can demo here.
export declare const Animations: {
[key: string]: BaseAnimation;
};Custom
Custom Animation class to quickly specify sequence of frames for your URL Animation.
class Custom implements BaseAnimation {
name: string;
creator: string;
baseState: State;
constructor(frames?: string[], frameRate?: number);
nextState(timestamp: number, state: State): {
nextFrame: string;
state: State;
};
}Types
BaseAnimation
Interface struture Type to follow when implementing a Animation from scratch. Multiple xample implementations can be found at src/animations
interface BaseAnimation {
name: string;
creator: string;
baseState: any;
nextState(timestamp: number, state: Object): {
nextFrame: string;
state: Object;
};
}Contribution
- Create a seperate branch using
git checkout -b [branch-name] - Create a unique file name which reflects your ascii animation in the
src/animationsdirectory - Implement the Animation by implementing the
BaseAnimationinterface, you can find it atsrc/animations/base.ts. More info about theBaseAnimationinterface can be found in thesrc/animations/base.tsfile. - All animation data related to your ASCII Art must be encapsulated within the Animation Object you implement. As long as the interface is implemented, the way in which you create the frames for your animations do not matter, so you have complete freedome in that department.
- In the
src/index.tsimport your Animation Object and add it to theexportswith the other animations like this:
import YourAnimation from './yourAnimation.ts'
...
export const Animatinos: { [key: string]: BaseAnimation } = {
...,
YourAnimation : YourAnimation
}
- Create a PR with a small description about the animation (ideally a gif illustrating the animation in action)