carousels.rst 1.4 KB

12345678910111213141516171819202122232425262728293031
  1. Carousels
  2. =========
  3. A representation of a carousel, slider or similar construct.
  4. See :ref:`carousel-block`
  5. Usage
  6. -----
  7. 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.
  8. Fields
  9. ------
  10. Slider
  11. ~~~~~~
  12. **Name**: A unique name for your carousel. It can be anything, it is just used as a personal reference to easily tell them apart.
  13. **Show Controls**: A toggle to determine if the carousel has arrows to control which slide shows.
  14. **Show Indicators**: A toggle to determine if the carousel will show dots at the bottom to indicate how many slides there are.
  15. **Animation**: Determines the type of animation that happens when a slide is transitioned.
  16. Slides
  17. ~~~~~~
  18. To add a slide to your carousel, click the "Add Slides" button.
  19. **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.
  20. **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.
  21. **Custom CSS class**: If you need to add a specific css class for this slide, add it here.
  22. **Custom ID**: If you need to add a specific ID for this slide, add it here.
  23. **Content**: A streamfield that contains the content blocks for the slide.