ElementOptions: { autoSetItemsWidth: boolean; carouselSelector: string; defaultNCols: number; itemSelector: string; itemsSelector: string; leftArrowSelector: string; nColsDataAttribute: string; rightArrowSelector: string; topicAllSelector?: string; topicButtonActiveClass: string; topicDataAttribute: string; topicSelector: string; transitionTeleport: string; transitionTransform: string }

Options for the initialization of an Element object

Type declaration

  • autoSetItemsWidth: boolean

    Wether the width of each item should be set automatically based on the number of columns

  • carouselSelector: string

    Css selector used for the carousel container

  • defaultNCols: number

    Default number of columns if the nColsDataAttribute was not found

  • itemSelector: string

    Css selector used to identify the items of the carousel

  • itemsSelector: string

    Css selector used to identify the items flex-box of the carousel

  • leftArrowSelector: string

    Css selector for the left arrow button

  • nColsDataAttribute: string

    Data attribute in the carousel element that indicates the number of columns

  • rightArrowSelector: string

    Css selector for the right arrow button

  • Optional topicAllSelector?: string

    Css selector for button that handles the selection or deselection of all topics

  • topicButtonActiveClass: string

    Class added to an active topic button

  • topicDataAttribute: string

    The data-[attribute] that will be used to identify and filter using topics

  • topicSelector: string

    Css selector for the topic buttons

  • transitionTeleport: string

    Transform property applied to the items element when it needs to teleport. Can be useful if you already expect the element to have some transition applied.

  • transitionTransform: string

    Transform property applied to the items element when sliding to another item

Generated using TypeDoc