mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 19:32:37 +08:00
6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
4.3 KiB
4.3 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "CustomScrollbar" keywords = ["grafana","documentation","sdk","@grafana/ui"] type = "docs" draft = true +++
CustomScrollbar class
Wraps component into component from react-custom-scrollbars
Signature
export declare class CustomScrollbar extends Component<Props>
Import
import { CustomScrollbar } from '@grafana/ui';
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| constructor(props) | Constructs a new instance of the CustomScrollbar class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| defaultProps | static |
Partial<Props> |
|
| renderThumb | (thumb: "thumb-horizontal" | "thumb-vertical", passedProps: any) => JSX.Element |
||
| renderThumbHorizontal | (passedProps: any) => JSX.Element |
||
| renderThumbVertical | (passedProps: any) => JSX.Element |
||
| renderTrack | (track: "track-vertical" | "track-horizontal", hideTrack: boolean | undefined, passedProps: any) => JSX.Element |
||
| renderTrackHorizontal | (passedProps: any) => JSX.Element |
||
| renderTrackVertical | (passedProps: any) => JSX.Element |
||
| renderView | (passedProps: any) => JSX.Element |
Methods
| Method | Modifiers | Description |
|---|---|---|
| componentDidMount() | ||
| componentDidUpdate() | ||
| render() | ||
| updateAfterMount() | ||
| updateScroll() |
constructor(props)
Constructs a new instance of the CustomScrollbar class
Signature
constructor(props: Props);
Parameters
| Parameter | Type | Description |
|---|---|---|
| props | Props |
defaultProps property
Signature
static defaultProps: Partial<Props>;
renderThumb property
Signature
renderThumb: (thumb: "thumb-horizontal" | "thumb-vertical", passedProps: any) => JSX.Element;
renderThumbHorizontal property
Signature
renderThumbHorizontal: (passedProps: any) => JSX.Element;
renderThumbVertical property
Signature
renderThumbVertical: (passedProps: any) => JSX.Element;
renderTrack property
Signature
renderTrack: (track: "track-vertical" | "track-horizontal", hideTrack: boolean | undefined, passedProps: any) => JSX.Element;
renderTrackHorizontal property
Signature
renderTrackHorizontal: (passedProps: any) => JSX.Element;
renderTrackVertical property
Signature
renderTrackVertical: (passedProps: any) => JSX.Element;
renderView property
Signature
renderView: (passedProps: any) => JSX.Element;
componentDidMount method
Signature
componentDidMount(): void;
Returns:
void
componentDidUpdate method
Signature
componentDidUpdate(): void;
Returns:
void
render method
Signature
render(): JSX.Element;
Returns:
JSX.Element
updateAfterMount method
Signature
updateAfterMount(): void;
Returns:
void
updateScroll method
Signature
updateScroll(): void;
Returns:
void