Overlapping slider documentation #1
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Merge main to docs
phucbm
requested changes
Oct 1, 2022
README.md
Outdated
| ```html | ||
| <!-- No Js init --> | ||
| <div data-overlapping-slider> | ||
| <!-- Slider 1 --> |
There was a problem hiding this comment.
- It should be "Slide 1" instead of "Slider 1".
- Just put in 3 slides for demo, keep it as simple, as succinct as possible, like:
<!-- Init with HTML attribute -->
<div data-overlapping-slider>
<div>Slide 1</div>
<div>Slide 2</div>
<div>Slide 3</div>
<div>By looking at this demo HTML, we would immediately know what we need to have to run the script, no extra things in the demo.
There was a problem hiding this comment.
Should you read the number 2 one more time? @vuquangpham
| |-----------------------------|--------------------------------------|--------------------------------------------| | ||
| | `data-os-autoplay="2` | `autoplay: 2` | Add autoplay option through html attribute | | ||
| | `data-os-swipe` | `swipe: true` | Add swipe option through html attribute | | ||
| | `data-overlapping-slider` | `data-overlapping-slider="slider-1"` | Pass an specific id for each slider | |
There was a problem hiding this comment.
This attribute should be placed on top as it is the main one for initialization.
There was a problem hiding this comment.
I have moved it to the top (after the initialize section). Please check it again!
❌ Deploy Preview for overlapping-slider failed.
|
phucbm
requested changes
Oct 5, 2022
README.md
Outdated
| |-----------------------------|----------------------------------------------------------------------------------------| | ||
| | `onPause: (data) => {}` | Trigger after turning off the autoplay setting. | | ||
| | `onPlay: (data) => {}` | Trigger after turning on the autoplay setting. | | ||
| | `onChange: (data,el) => {}` | When you call this event, your Overlapping Slider will re-initialize with new options. | |
There was a problem hiding this comment.
Trigger after turning off the autoplay setting.
- When talking about an event, the verb "fire" would be more accurate than "trigger".
- I can't find anything in common between
onChangeandre-initialize with new options.
| |-----------------------------|--------------------------------------|--------------------------------------------| | ||
| | `data-os-autoplay="2` | `autoplay: 2` | Add autoplay option through html attribute | | ||
| | `data-os-swipe` | `swipe: true` | Add swipe option through html attribute | | ||
| | `data-overlapping-slider` | `data-overlapping-slider="slider-1"` | Pass an specific id for each slider | |
README.md
Outdated
| ```html | ||
| <!-- No Js init --> | ||
| <div data-overlapping-slider> | ||
| <!-- Slider 1 --> |
There was a problem hiding this comment.
Should you read the number 2 one more time? @vuquangpham
phucbm
approved these changes
Oct 7, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation for Overlapping Slider