Skip to content

Documentation for classNames is incorrect. #709

@sdthornton

Description

@sdthornton

Current documentation for the classNames option shows the following:

classNames: {
  // defaults
  content: 'simplebar-content',
  scrollContent: 'simplebar-scroll-content',
  scrollbar: 'simplebar-scrollbar',
  track: 'simplebar-track'
}

However, of the keys listed, only scrollbar actually functions as intended. The other three have no effect on the markup.

Per the source code type it looks like the docs could just be updated to:

classNames: {
  // defaults
  contentEl: 'simplebar-content',
  contentWrapper: 'simplebar-content-wrapper',
  offset: 'simplebar-offset',
  mask: 'simplebar-mask',
  wrapper: 'simplebar-wrapper',
  placeholder: 'simplebar-placeholder',
  scrollbar: 'simplebar-scrollbar',
  track: 'simplebar-track',
  heightAutoObserverWrapperEl: 'simplebar-height-auto-observer-wrapper',
  heightAutoObserverEl: 'simplebar-height-auto-observer',
  visible: 'simplebar-visible',
  horizontal: 'simplebar-horizontal',
  vertical: 'simplebar-vertical',
  hover: 'simplebar-hover',
  dragging: 'simplebar-dragging',
  scrolling: 'simplebar-scrolling',
  scrollable: 'simplebar-scrollable',
  mouseEntered: 'simplebar-mouse-entered',
},

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions