Skip to content

Commit

Permalink
Merge pull request #69 from Gauravdarkslayer/0.0.7-beta.13
Browse files Browse the repository at this point in the history
0.0.7-beta.13 released
  • Loading branch information
Gauravdarkslayer authored Oct 21, 2024
2 parents 088d7df + 17b2b65 commit 5840dbc
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
8 changes: 6 additions & 2 deletions projects/ngx-stories/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ export class AppComponent {
|--------------------|-----------------------|----------|--------------------------------------------------------------------------------------------------------------|
| `storyGroups` | `StoryGroup[]` | Yes | An input property that accepts an array of story groups. Each group contains a list of stories to display. |
| `options` | `NgxStoriesOptions` | No | Configuration options for the story display. Options include `width` and `height` to customize the dimensions. |
| `backlitColor` | `String` | No | Background color for stories by default it's `#1b1b1b`. |
| `triggerOnEnd` | `EventEmitter<void>` | No | Output event that is triggered when the user reaches the end of all stories. |
| `triggerOnExit` | `EventEmitter<void>` | No | Output event that is triggered when the user manually exits the story view. |
| `triggerOnSwipeUp` | `EventEmitter<void>` | No | Output event that is triggered when the user performs a swipe-up gesture, typically for additional actions. |
Expand All @@ -64,8 +65,10 @@ export class AppComponent {

```ts
interface NgxStoriesOptions {
width: number,
height: number,
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 @@ -76,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
2 changes: 1 addition & 1 deletion projects/ngx-stories/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ngx-stories",
"version": "0.0.7-beta.12",
"version": "0.0.7-beta.13",
"peerDependencies": {
"@angular/common": "^18.2.0",
"@angular/core": "^18.2.0",
Expand Down

0 comments on commit 5840dbc

Please sign in to comment.