2
0

carousels.rst 1.4 KB

123456789101112131415161718192021222324252627282930
  1. Carousels
  2. =========
  3. A representation of a carousel, slider or similar construct.
  4. Usage
  5. -----
  6. You define your carousels in the Snippets > Carousel section of the admin. Once defined, any page with a body streamfield can show that carousel by selecting it with a carousel block.
  7. Fields
  8. ------
  9. Slider
  10. ~~~~~~
  11. **Name**: A unique name for your carousel. It can be anything, it is just used as a personal reference to easily tell them apart.
  12. **Show Controls**: A toggle to determine if the carousel has arrows to control which slide shows.
  13. **Show Indicators**: A toggle to determine if the carousel will show dots at the bottom to indicate how many slides there are.
  14. **Animation**: Determines the type of animation that happens when a slide is transitioned.
  15. Slides
  16. ~~~~~~
  17. To add a slide to your carousel, click the "Add Slides" button.
  18. **Image**: The background image you want to use for your slide. This is optional. It is recommended to at least set this field or the **Background color** field.
  19. **Background color**: The background color you want to use for your slide. This is optional. It is recommended to at lest set this field or the **Image** field.
  20. **Custom CSS class**: If you need to add a specific css class for this slide, add it here.
  21. **Custom ID**: If you need to add a specific ID for this slide, add it here.
  22. **Content**: A streamfield that contains the content blocks for the slide.