attach - arguments

Possible arguments that can be used in attach method.

bar

General settings for scrollbar "bar" thickness and offset.

^{_{Default value}}

bar: {
  y: {
    width: 6,
    offset: [0, 0],
  },
  x: {
    height: 6,
    offset: [0, 0],
  },
},

^_Type

bar?: {
  y?: {
    width?: number;
    offset?: [number, number];
  };
  x?: {
    height?: number;
    offset?: [number, number];
  };
};

className

ClassName used to target HTMLElement that has overflow: auto on it, meaning is scrollable container.

^{_{Default value}}

className: "light-scrollbar",

^_Type

className?: string;

disableFocusPrevent

By default emitting focus event is disabled, means when scroll is initialized from this container no focus event will be emitted.

^{_{Default value}}

disableFocusPrevent: true,

^_Type

disableFocusPrevent?: boolean;

wrapperPlacement

In order to create custom scrollbar, at this moment only possible solution is to wrap scrollable container with wrapper. This plugin can create wrapper inside your container and switch node and its all classes/attrs/listeners from original container to inner child, or create outside wrapper.

^{_{Default value}}

wrapperPlacement: WrapperPlacement.inside,

^_Type

wrapperPlacement?: WrapperPlacement;

export enum WrapperPlacement {
  "inside" = "inside",
  "outside" = "outside",
}

wrapperElement

There is possibility to create wrapper element from given HTMLElement passed via this parameter.

^{_{Default value}}

null

^_Type

wrapperElement?: HTMLElement;

showOnHover

Scrollbars can be visible only when hover on container.

^{_{Default value}}

showOnHover: false,

^_Type

showOnHover?: number | false