Skip to content

Commit

Permalink
updated Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jesvijonathan committed May 12, 2023
1 parent 0c0a1e9 commit 17d90f7
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 35 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Feel free to report an issue or request a feature in this repository :)
<br>
<br>

v0.7 | 12 May 2023 | Jesvi Jonathan
Last updated :<code> <i>v0.7 (12 May 2023)</i></code>

<br>

Expand Down Expand Up @@ -113,8 +113,6 @@ You can add minified version of the script by replacing <code>jos.js</code> with
```

2. (<b>Or</b>) Use <code>JOS.init(options);</code> to overide the default settings with your custom settings.
- <code>options : Object </code>
- <code>Default : {}</code>

```html
<!-- Global Parameters -->
Expand Down Expand Up @@ -214,7 +212,7 @@ Example : [Custom Timing Function]()
<div id="myElement"></div>
```

2. Create an element that you want to jos animate & add the <code>data-jos_anchor</code> attribute to it :
1. Create an element that you want to animate & add the <code>data-jos_anchor</code> attribute to it, with the id starting with suffix <code>#</code> :

```html
<!-- My animated element -->
Expand Down
33 changes: 2 additions & 31 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,10 @@
crossorigin="anonymous"
/>

<!-- <script defer src="../dist/jos.js"></script> -->
<!-- <link rel="stylesheet" href="../dev/jos.css" id="jos-stylesheet" /> -->

<!-- <script defer src="../dist/jos.js"></script> -->

<!-- https://cdn.jsdelivr.net/gh/jesvijonathan/JOS-Animation-Library -->
<!-- <base
href="https://jesvijonathan.github.io/JOS-Animation-Library/"
Expand Down Expand Up @@ -632,36 +633,6 @@ <h3>
//JOS.stop();
//JOS.destroy();
//JOS.restart();
// JOS.Logger("JOS Initialized", 0);
// JOS.Logger("JOS Initialized", 1);
// JOS.Logger("JOS Initialized", 2);
// JOS.Logger("JOS Initialized", 3);
// JOS.Logger("JOS Initialized", 4);
// JOS.Logger("JOS Initialized", 5);
// JOS.Logger("JOS Initialized", 6);
//JOS.Logger("JOS Initialized", 7);

//inititalize JOS class

// Initialize JOS with default settings

// Initialize JOS with default settings

// jos_default_disable: false, // Disable JOS gloabaly | Values : 'true', 'false'
// jos_default_once: false, // Disable JOS after first animation | Values : 'true', 'false'
// jos_default_animation: "fade", // JOS global animation type | Values : 'fade', 'slide', 'zoom', 'flip', 'fade-right', 'fade-left', 'fade-up', 'fade-down', 'zoom-in-right', 'zoom-in-left', 'zoom-in-up', 'zoom-in-down', 'zoom-out-right', 'zoom-out-left', 'zoom-out-up', 'zoom-out-down', 'flip-right', 'flip-left', 'flip-up', 'flip-down, "my-custom-animation"
// jos_default_timingFunction: "ease-in-out", // JOS global timing function | Values : 'ease', 'ease-in', 'ease-out', 'ease-in-out', 'linear', 'step-start', 'step-end', 'steps()', 'cubic-bezier()', 'my-custom-timing-function'
// jos_default_threshold: 0, // Set gloabal the threshold for the element to be visible | Values : 0-1
// jos_default_debounce: 0, // Set global the debounce time/rate for listening to scroll events | Values : 0-1000
// jos_default_delay: 0, // Set global the delay for the animation to start | Values : 0,1,2,3,4,5
// jos_default_duration: 0.4, // Set global the duration for the animation playback | Values : flota : 0-1 & int : 0,1,2,3,4,5
// jos_default_animate_out: false, // Set whether elements should animate out while scrolling past them | Values : 'true', 'false'
// jos_rootMargin_top: "-10%", // Set by which percent the element should animate out (Recommended value between 10% to -30%)
// jos_rootMargin_bottom: "-40%", // Set by which percent the element should animate out (Recommended value between -10% to -60%)

// jos_default_intersectionRatio: intersectionRatio_set(), // Set the intersection ratio between which the element should be visible | Values : 0-1 (automaticaly set)
// jos_default_rootMargin:
// jos_rootMargin_top + " 0% " + jos_rootMargin_bottom + " 0%", // Set the root margin for the element to be visible | Values : _% _% _% _% (automaticaly set)
</script>

<script>
Expand Down

0 comments on commit 17d90f7

Please sign in to comment.