Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for classNames is incorrect. #709

Open
sdthornton opened this issue Nov 12, 2024 · 0 comments
Open

Documentation for classNames is incorrect. #709

sdthornton opened this issue Nov 12, 2024 · 0 comments

Comments

@sdthornton
Copy link

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',
},
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant