Skip to content

Commit

Permalink
Merge pull request #68 from Gauravdarkslayer/story-index-readme-update
Browse files Browse the repository at this point in the history
Story index readme update
  • Loading branch information
Gauravdarkslayer authored Oct 20, 2024
2 parents 1a0d43c + 9f0066a commit 088d7df
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@ export class AppComponent {

```ts
interface NgxStoriesOptions {
width: number,
height: number,
currentStoryIndex: 0,
currentStoryGroupIndex: 0
width: number, // width of story
height: number, // height of story
currentStoryIndex: 0, // index from where stories should start
currentStoryGroupIndex: 0 // index from where story group should start
}
```

Expand All @@ -79,6 +79,7 @@ interface NgxStoriesOptions {
* Swipe Gestures (Mobile Friendly): Allow users to swipe left or right to navigate through the stories.
* Hold to Pause: Pause the story progress when the user holds their finger on the screen.
* Events: Trigger events when the user reaches the end of the stories or when they exit the carousel.
* Keyboard navigation

## Contributing
[Contributing Guide](https://github.com/Gauravdarkslayer/ngx-stories/blob/main/CONTRIBUTING.md)
Expand Down

0 comments on commit 088d7df

Please sign in to comment.