Skip to content

Commit 86aa948

Browse files
committed
Correct README
1 parent 41772e8 commit 86aa948

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,7 @@ npm install @webwriter/slides
4141
| :-------------------: | :--: | :---------: | :-----: | :------: |
4242
| `activeSlideIndex` | `number` | Index of the currently active slide. | `0` ||
4343
| `activeSlide` | `WebwriterSlide` | The active slide element based on the activeSlideIndex. | - ||
44-
| `type` (`type`) | `'tabs' \| 'slides'` | Defines the type of view for the slideshow.
45-
- "slides": Show content as sequential slides.
46-
- "tabs": Show content using tabs. | `'slides'` | ✓ |
44+
| `type` (`type`) | `'tabs' \| 'slides'` | Defines the type of view for the slideshow.<br>- "slides": Show content as sequential slides.<br>- "tabs": Show content using tabs. | `'slides'` ||
4745
| `hasNextSlide` | `boolean` | False if slideshow is on the last slide. | - ||
4846
| `hasPreviousSlide` | `boolean` | False if slideshow is on the first slide. | - ||
4947

@@ -52,9 +50,7 @@ npm install @webwriter/slides
5250
## Methods
5351
| Name | Description | Parameters |
5452
| :--: | :---------: | :-------: |
55-
| `_handleKeyDown` | Handles keyboard navigation for the slideshow.
56-
ArrowRight advances to the next slide, ArrowLeft goes back.
57-
Only possible in preview mode. | `e: KeyboardEvent`
53+
| `_handleKeyDown` | Handles keyboard navigation for the slideshow.<br>ArrowRight advances to the next slide, ArrowLeft goes back.<br>Only possible in preview mode. | `e: KeyboardEvent`
5854
| `addSlide` | Add a new empty slide element. Optionally insert after given index. | `index: number`
5955
| `duplicateSlide` | Duplicate an existing slide at given index. | `index: number`
6056
| `removeActiveSlide` | Remove the currently active slide element. | -
@@ -110,8 +106,7 @@ npm install @webwriter/slides
110106
| Name (Attribute Name) | Type | Description | Default | Reflects |
111107
| :-------------------: | :--: | :---------: | :-----: | :------: |
112108
| `active` (`active`) | `boolean` | Indicates whether the slide is currently active/visible. | `false` ||
113-
| `thumbnail` (`thumbnail`) | `string` | Data URI string for the slide thumbnail (e.g., "data:image/png;base64,...").
114-
Used to display a preview image for the slide. | `""` | ✓ |
109+
| `thumbnail` (`thumbnail`) | `string` | Data URI string for the slide thumbnail (e.g., "data:image/png;base64,...").<br>Used to display a preview image for the slide. | `""` ||
115110

116111
*Fields including [properties](https://developer.mozilla.org/en-US/docs/Glossary/Property/JavaScript) and [attributes](https://developer.mozilla.org/en-US/docs/Glossary/Attribute) define the current state of the widget and offer customization options.*
117112

0 commit comments

Comments
 (0)