Skip to content

Commit b6b7b6b

Browse files
committed
added description to props
1 parent e5ca8ea commit b6b7b6b

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

index.d.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import React from 'react'
22

33
export type ReactSmartSliderProps = {
4-
/*
4+
/**
55
Default undefined.
66
If given defines number of columns per container width.
77
If 1, width of each child is 100%of container width.
@@ -10,30 +10,30 @@ export type ReactSmartSliderProps = {
1010

1111
numCols?: number,
1212

13-
/*
13+
/**
1414
Default 0.
1515
Defines space in pixels between columns.
1616
Spacing is based on padding of each element.
1717
*/
1818

1919
spacing?: number,
2020

21-
/*
21+
/**
2222
Default undefined.
2323
Overrides base style of track.
2424
*/
2525

2626
trackProps?: React.CSSProperties,
2727

28-
/*
28+
/**
2929
Default rectangle.
3030
Base rectangle element has adaptive width, dependent on length of children.
3131
Provided JSX.Element replaces original thumb.
3232
*/
3333

3434
thumb?: JSX.Element,
3535

36-
/*
36+
/**
3737
Default false.
3838
Defines direction of scrollbar - horizontal in default.
3939
If true, it resize automatically.

tslint.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@
7474
"no-empty": false,
7575
"no-object-literal-type-assertion": false,
7676
"no-submodule-imports": false,
77-
"no-console": false
77+
"no-console": false,
78+
"jsdoc-format": false
7879
}
7980
}

0 commit comments

Comments
 (0)