#48 : Apply anchor settings

This commit is contained in:
Vadim
2021-08-14 00:42:17 +03:00
parent aa0b1cb59c
commit f76fe0b5c6

View File

@@ -9,9 +9,9 @@
import colors from './data/colors.json' import colors from './data/colors.json'
</script> </script>
# Features # Features!anchorId:features;
## Single item ## Single item!anchorId:features-single-item;
<Carousel> <Carousel>
{#each colors as { color, text } (color)} {#each colors as { color, text } (color)}
<Color {color} {text} /> <Color {color} {text} />
@@ -28,7 +28,7 @@
<Divider /> <Divider />
## Multiple items ## Multiple items!anchorId:features-multiple-items;
<Carousel> <Carousel>
{#each _.chunk(colors, 3) as colorsChunk, chunkIndex (chunkIndex)} {#each _.chunk(colors, 3) as colorsChunk, chunkIndex (chunkIndex)}
<div style="display: flex;"> <div style="display: flex;">
@@ -53,7 +53,7 @@
<Divider /> <Divider />
## Autoplay ## Autoplay!anchorId:features-autoplay;
<Carousel <Carousel
autoplay autoplay
autoplayDuration={2000} autoplayDuration={2000}
@@ -76,7 +76,7 @@
<Divider /> <Divider />
## Autoplay with duration progress ## Autoplay with duration progress!anchorId:features-autoplay-duration-progress;
<Carousel <Carousel
autoplay autoplay
autoplayDuration={5000} autoplayDuration={5000}
@@ -101,7 +101,7 @@
<Divider /> <Divider />
## Autoplay with pause on focus ## Autoplay with pause on focus!anchorId:features-autoplay-pause-on-focus;
**For desktop** - hover over the carousel to toggle the autoplay. **For desktop** - hover over the carousel to toggle the autoplay.
**For touchable devices** - tap the carousel to toggle the autoplay. **For touchable devices** - tap the carousel to toggle the autoplay.
@@ -132,7 +132,7 @@
<Divider /> <Divider />
## Lazy loading of images ## Lazy loading of images!anchorId:features-lazy-loading;
<Carousel <Carousel
let:loaded let:loaded
> >
@@ -161,7 +161,7 @@
<Divider /> <Divider />
## Arrows customization ## Arrows customization!anchorId:features-arrows-customization;
<Carousel <Carousel
let:showPrevPage let:showPrevPage
let:showNextPage let:showNextPage
@@ -196,7 +196,7 @@
<Divider /> <Divider />
## Dots customization ## Dots customization!anchorId:features-dots-customization;
<Carousel <Carousel
let:currentPageIndex let:currentPageIndex
let:pagesCount let:pagesCount
@@ -239,12 +239,13 @@
<Divider /> <Divider />
## Use case ## Use case!anchorId:features-use-cases;
<AlbumsPreview /> <AlbumsPreview />
<Divider /> <Divider />
# Installation # Installation!anchorId:installation;
```bash ```bash
yarn add svelte-carousel yarn add svelte-carousel
``` ```
@@ -262,7 +263,7 @@ Import component
<Divider /> <Divider />
# Props # Props!anchorId:props;
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
|---------------------------|------------|-----------------|-----------------------------------------------| |---------------------------|------------|-----------------|-----------------------------------------------|
@@ -281,9 +282,9 @@ Import component
<Divider /> <Divider />
# Events # Events!anchorId:events;
## `pageChange` ## `pageChange`!anchorId:events-page-change;
Is dispatched on page change Is dispatched on page change
| Payload field | Type | Description | | Payload field | Type | Description |
@@ -302,9 +303,9 @@ Is dispatched on page change
<Divider /> <Divider />
# Slots # Slots!anchorId:slots;
## `prev` and `next` ## `prev` and `next`!anchorId:slots-prev-next;
They are used for customizing prev and next buttons. They are used for customizing prev and next buttons.
Slot props: Slot props:
@@ -329,7 +330,7 @@ Slot props:
</Carousel> </Carousel>
``` ```
## `dots` ## `dots`!anchorId:slots-dots;
This slot is used for customizing dots appearance. This slot is used for customizing dots appearance.
@@ -354,7 +355,7 @@ Slot props:
</Carousel> </Carousel>
``` ```
## Default slot ## Default slot!anchorId:slots-default;
This slot takes content for the carousel. This slot takes content for the carousel.
@@ -377,9 +378,9 @@ Slot props:
<Divider /> <Divider />
# Methods # Methods!anchorId:methods;
## `goTo` ## `goTo`!anchorId:methods-go-to;
Navigates to a page by index. `(pageIndex, options) => Promise<void>`. Navigates to a page by index. `(pageIndex, options) => Promise<void>`.
Arguments: Arguments:
@@ -406,7 +407,7 @@ Arguments:
<button class="button" on:click={goToStartPage}>Go</button> <button class="button" on:click={goToStartPage}>Go</button>
``` ```
## `goToPrev` ## `goToPrev`!anchorId:methods-go-to-prev;
Navigates to the previous page. `(options) => Promise<void>`. Navigates to the previous page. `(options) => Promise<void>`.
Arguments: Arguments:
@@ -432,7 +433,7 @@ Arguments:
<button class="button" on:click={goToPrevPage}>Go</button> <button class="button" on:click={goToPrevPage}>Go</button>
``` ```
## `goToNext` ## `goToNext`!anchorId:methods-go-to-next;
Navigates to the next page. `(options) => Promise<void>`. Navigates to the next page. `(options) => Promise<void>`.
Arguments: Arguments: