You are here

Home » API reference » Flickity Carousel 8.2

flickity.schema.yml in Flickity Carousel 8.2

Same filename and directory in other branches
  1. 8 config/schema/flickity.schema.yml
  2. 3.0.x config/schema/flickity.schema.yml
config/schema/flickity.schema.yml

File

config/schema/flickity.schema.yml
View source 
  1. flickity.group.*:

  2.   type: config_entity

  3.   label: 'Group'

  4.   mapping:

  5.     id:

  6.       type: string

  7.       label: 'ID'

  8.     label:

  9.       type: label

  10.       label: 'Label'

  11.     settings:

  12.       type: mapping

  13.       label: 'Settings'

  14.       mapping:

  15.         images_loaded:

  16.           type: boolean

  17.           label: 'imagesLoaded'

  18.           text: 'Provides support for imagesLoaded plugin.'

  19.         cell_selector:

  20.           type: string

  21.           label: 'Cell selector'

  22.           text: 'Specify selector for cell elements.'

  23.         initial_index:

  24.           type: integer

  25.           label: 'Initial index'

  26.           text: 'Zero-based index of the initial selected cell.'

  27.         accessibility:

  28.           type: boolean

  29.           label: 'Accessibility'

  30.           text: 'Enable keyboard navigation. Users can tab to a Flickity gallery, and pressing left & right keys to change cells.'

  31.         set_gallery_size:

  32.           type: boolean

  33.           label: 'Set gallery size'

  34.           text: 'Sets the height of the gallery to the height of the tallest cell.'

  35.         resize:

  36.           type: boolean

  37.           label: 'Resize'

  38.           text: 'Adjusts sizes and positions when window is resized.'

  39.         cell_align:

  40.           type: string

  41.           label: 'Cell align'

  42.           text: 'Align cells within the gallery element.'

  43.         contain:

  44.           type: boolean

  45.           label: 'Contain'

  46.           text: 'Contains cells to gallery element to prevent excess scroll at beginning or end.'

  47.         percent_position:

  48.           type: boolean

  49.           label: 'Percent position'

  50.           text: 'Sets positioning in percent values, rather than pixel values.'

  51.         right_to_left:

  52.           type: boolean

  53.           label: 'Right to left'

  54.           text: 'Enables right-to-left layout.'

  55.         draggable:

  56.           type: boolean

  57.           label: 'Draggable'

  58.           text: 'Enables dragging and flicking.'

  59.         free_scroll:

  60.           type: boolean

  61.           label: 'Free scroll'

  62.           text: 'Enables content to be freely scrolled and flicked without aligning cells to an end position.'

  63.         lazy_load:

  64.           type: integer

  65.           label: 'Lazy load'

  66.           text: 'Loads cell images when a cell is selected.'

  67.         auto_play:

  68.           type: integer

  69.           label: 'Auto play'

  70.           text: 'Automatically advances to the next cell.'

  71.         wrap_around:

  72.           type: boolean

  73.           label: 'Wrap around'

  74.           text: 'At the end of cells, wrap-around to the other end for infinite scrolling.'

  75.         group_cells:

  76.           type: integer

  77.           label: 'Group Cells'

  78.           text: 'Groups cells together in slides. Flicking, page dots, and previous/next buttons are mapped to group slides, not individual cells.'

  79.         adaptive_height:

  80.           type: boolean

  81.           label: 'Adaptive Height'

  82.           text: 'Changes height of carousel to fit height of selected slide.'

  83.         watch_css:

  84.           type: boolean

  85.           label: 'Watch CSS'

  86.           text: 'You can enable and disable Flickity with CSS.'

  87.         as_nav_for:

  88.           type: string

  89.           label: 'As nav for'

  90.           text: 'Use one Flickity gallery as navigation for another.'

  91.         drag_threshold:

  92.           type: integer

  93.           label: 'Drag Threshold'

  94.           text: 'The number of pixels a mouse or touch has to move before dragging begins.'

  95.         selected_attraction:

  96.           type: float

  97.           label: 'Selected attraction'

  98.           text: 'Attracts the position of the slider to the selected cell. Higher attraction makes the slider move faster.'

  99.         friction:

  100.           type: float

  101.           label: 'Friction'

  102.           text: 'Slows the movement of slider. Higher friction makes the slider feel stickier and less bouncy.'

  103.         free_scroll_friction:

  104.           type: float

  105.           label: 'Free scroll friction'

  106.           text: 'Slows movement of slider when freeScroll: true. Higher friction makes the slider feel stickier.'

  107.         prev_next_buttons:

  108.           type: boolean

  109.           label: 'Previous next buttons'

  110.           text: 'Creates and enables previous & next buttons.'

  111.         page_dots:

  112.           type: boolean

  113.           label: 'Page dots'

  114.           text: 'Creates and enables page dots (pagination).'