diff --git a/CHANGELOG.md b/CHANGELOG.md index 383269f..eb4f8ec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] +### Added +- Recipe about how to use slider-layout as carousel + ## [0.7.2] - 2019-12-05 ## [0.7.1] - 2019-11-25 diff --git a/docs/README.md b/docs/README.md index 4075c4a..a9c442a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,6 +4,9 @@ Slider-Layout is a flexible solution for building `sliders` of `blocks` within V ![](https://user-images.githubusercontent.com/27777263/70230361-e839db00-1736-11ea-9f29-7c945c10a5f7.png) +:warning: In order to use the `slider-layout` as a substitute to the `carousel` component, check this [recipe](https://vtex.io/docs/recipes/layout/building-a-carousel-through-lists-and-slider-layout) out. + + ## Configuration 1. Add the slider-layout app to your theme's dependencies in the `manifest.json`, for example: @@ -49,6 +52,7 @@ Slider-Layout is a flexible solution for building `sliders` of `blocks` within V ``` + | Prop name | Type | Description | Default value | | ---------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | | `label` | `String` | Aria label to be used by the `` component. | `'slider'` |