A next-generation tool to create blazing-fast documentation sites
API
created:3/5/2021
updated:3/5/2021
loc
51
comments
22%
passed
14
coverage
75%

PropsTable

avatar of atanasster

Displays the component's properties as well as configurable controls to interact with the component.

Tests results

Status
Full name
Title
Time(ms)
PropsTable.test.ts(14 tests)
passed
PropsTable > overview
snapshot
333
passed
PropsTable > overview
accessibility
1723
passed
PropsTable > subcomponents
snapshot
63
passed
PropsTable > subcomponents
accessibility
476
passed
PropsTable > extraColumns
snapshot
185
passed
PropsTable > extraColumns
accessibility
1705
passed
PropsTable > controls
snapshot
82
passed
PropsTable > controls
accessibility
631
passed
PropsTable > title
snapshot
69
total 14 tests

Tests coverage

Kind
Total
Covered
Skipped
%
PropsTable.tsx
lines
13
13
0
100%
functions
2
2
0
100%
statements
15
15
0
100%
branches
4
3
0
75%

A11y tests

Name
Description
Default
Custom
optionalArray
any[]
-
OPTIONALARRAY
optionalArrayOf
number[]
-
OPTIONALARRAYOF
optionalBool
boolean
-
OPTIONALBOOL
optionalElement
any
-
OPTIONALELEMENT
optionalElementType
Element
-
OPTIONALELEMENTTYPE
optionalEnum
NewsPhotos
-
OPTIONALENUM
optionalFunc
(args: any) => any
-
OPTIONALFUNC
optionalMessage
Message
-
OPTIONALMESSAGE
optionalNode
any
-
OPTIONALNODE
optionalNumber
number
21
OPTIONALNUMBER
optionalObject
object
-
OPTIONALOBJECT
optionalObjectOf
{ [key: string]: number; }
-
OPTIONALOBJECTOF
optionalObjectWithShape
{ optionalProperty?: string; requiredProperty: number; }
-
OPTIONALOBJECTWITHSHAPE
optionalObjectWithStrictShape
{ optionalProperty?: string; requiredProperty: number; }
-
OPTIONALOBJECTWITHSTRICTSHAPE
optionalString
string
-
OPTIONALSTRING
optionalSymbol
symbol
-
OPTIONALSYMBOL
optionalUnion
stringnumberMessage
-
OPTIONALUNION
requiredAny
any
-
REQUIREDANY
requiredFunc
(prop: any) => any
-
REQUIREDFUNC

Viewport

Name
Description
Default
Custom
optionalArray
any[]
-
OPTIONALARRAY
optionalArrayOf
number[]
-
OPTIONALARRAYOF
optionalBool
boolean
-
OPTIONALBOOL
optionalElement
any
-
OPTIONALELEMENT
optionalElementType
Element
-
OPTIONALELEMENTTYPE
optionalEnum
NewsPhotos
-
OPTIONALENUM
optionalFunc
(args: any) => any
-
OPTIONALFUNC
optionalMessage
Message
-
OPTIONALMESSAGE
optionalNode
any
-
OPTIONALNODE
optionalNumber
number
21
OPTIONALNUMBER
optionalObject
object
-
OPTIONALOBJECT
optionalObjectOf
{ [key: string]: number; }
-
OPTIONALOBJECTOF
optionalObjectWithShape
{ optionalProperty?: string; requiredProperty: number; }
-
OPTIONALOBJECTWITHSHAPE
optionalObjectWithStrictShape
{ optionalProperty?: string; requiredProperty: number; }
-
OPTIONALOBJECTWITHSTRICTSHAPE
optionalString
string
-
OPTIONALSTRING
optionalSymbol
symbol
-
OPTIONALSYMBOL
optionalUnion
stringnumberMessage
-
OPTIONALUNION
requiredAny
any
-
REQUIREDANY
requiredFunc
(prop: any) => any
-
REQUIREDFUNC
320px
Name
Description
Default
Custom
optionalArray
any[]
-
OPTIONALARRAY
optionalArrayOf
number[]
-
OPTIONALARRAYOF
optionalBool
boolean
-
OPTIONALBOOL
optionalElement
any
-
OPTIONALELEMENT
optionalElementType
Element
-
OPTIONALELEMENTTYPE
optionalEnum
NewsPhotos
-
OPTIONALENUM
optionalFunc
(args: any) => any
-
OPTIONALFUNC
optionalMessage
Message
-
OPTIONALMESSAGE
optionalNode
any
-
OPTIONALNODE
optionalNumber
number
21
OPTIONALNUMBER
optionalObject
object
-
OPTIONALOBJECT
optionalObjectOf
{ [key: string]: number; }
-
OPTIONALOBJECTOF
optionalObjectWithShape
{ optionalProperty?: string; requiredProperty: number; }
-
OPTIONALOBJECTWITHSHAPE
optionalObjectWithStrictShape
{ optionalProperty?: string; requiredProperty: number; }
-
OPTIONALOBJECTWITHSTRICTSHAPE
optionalString
string
-
OPTIONALSTRING
optionalSymbol
symbol
-
OPTIONALSYMBOL
optionalUnion
stringnumberMessage
-
OPTIONALUNION
requiredAny
any
-
REQUIREDANY
requiredFunc
(prop: any) => any
-
REQUIREDFUNC
375px
Name
Description
Default
Custom
optionalArray
any[]
-
OPTIONALARRAY
optionalArrayOf
number[]
-
OPTIONALARRAYOF
optionalBool
boolean
-
OPTIONALBOOL
optionalElement
any
-
OPTIONALELEMENT
optionalElementType
Element
-
OPTIONALELEMENTTYPE
optionalEnum
NewsPhotos
-
OPTIONALENUM
optionalFunc
(args: any) => any
-
OPTIONALFUNC
optionalMessage
Message
-
OPTIONALMESSAGE
optionalNode
any
-
OPTIONALNODE
optionalNumber
number
21
OPTIONALNUMBER
optionalObject
object
-
OPTIONALOBJECT
optionalObjectOf
{ [key: string]: number; }
-
OPTIONALOBJECTOF
optionalObjectWithShape
{ optionalProperty?: string; requiredProperty: number; }
-
OPTIONALOBJECTWITHSHAPE
optionalObjectWithStrictShape
{ optionalProperty?: string; requiredProperty: number; }
-
OPTIONALOBJECTWITHSTRICTSHAPE
optionalString
string
-
OPTIONALSTRING
optionalSymbol
symbol
-
OPTIONALSYMBOL
optionalUnion
stringnumberMessage
-
OPTIONALUNION
requiredAny
any
-
REQUIREDANY
requiredFunc
(prop: any) => any
-
REQUIREDFUNC
768px
Name
Description
Default
Custom
optionalArray
any[]
-
OPTIONALARRAY
optionalArrayOf
number[]
-
OPTIONALARRAYOF
optionalBool
boolean
-
OPTIONALBOOL
optionalElement
any
-
OPTIONALELEMENT
optionalElementType
Element
-
OPTIONALELEMENTTYPE
optionalEnum
NewsPhotos
-
OPTIONALENUM
optionalFunc
(args: any) => any
-
OPTIONALFUNC
optionalMessage
Message
-
OPTIONALMESSAGE
optionalNode
any
-
OPTIONALNODE
optionalNumber
number
21
OPTIONALNUMBER
optionalObject
object
-
OPTIONALOBJECT
optionalObjectOf
{ [key: string]: number; }
-
OPTIONALOBJECTOF
optionalObjectWithShape
{ optionalProperty?: string; requiredProperty: number; }
-
OPTIONALOBJECTWITHSHAPE
optionalObjectWithStrictShape
{ optionalProperty?: string; requiredProperty: number; }
-
OPTIONALOBJECTWITHSTRICTSHAPE
optionalString
string
-
OPTIONALSTRING
optionalSymbol
symbol
-
OPTIONALSYMBOL
optionalUnion
stringnumberMessage
-
OPTIONALUNION
requiredAny
any
-
REQUIREDANY
requiredFunc
(prop: any) => any
-
REQUIREDFUNC
1024px