@wix/design-system
Version:
@wix/design-system
50 lines (46 loc) • 2.01 kB
Markdown
### dataHook
- type: string
- description: Applied as data-hook HTML attribute that can be used in the tests
### className
- type: string
- description: Specifies a CSS class name to be appended to the component’s root element.
### data
- type: arrayOf
- description: Array of Funnel Chart items
* `value` - Item's value.
* `label` - Short label under the value.
* `displayValue` - Item's value send by the user.
### fullHeight
- type: bool
- description: When provided, allows bars to take full height
### hideDifferenceBadge
- type: bool
- description: A flag that controls the appearance of the calculated percentage badge
### differenceBadgeSkin
- type: enum
- description: When provided, changes badge skin
### differenceStepSkin
- type: func
- description: Returns the step skin by current index, badge's percentage and raw values
##### Signature:
`({currentIndex: number, difference: string, differenceValue: number}) => 'standard' | 'success'`
### differenceBadgeProps
- type: func
- description: Returns the badge props by current index, badge's percentage and raw values
##### Signature:
`({currentIndex: number, difference: string, differenceValue: number}) => FunnelBadgeCommonProps`
### differenceBadgeTooltipContent
- type: func
- description: Returns the tooltip props by current index, badge's percentage and raw values
##### Signature:
`({currentIndex: number, difference: string, differenceValue: number}) => React.ReactNode`
### differenceBadgeTooltipProps
- type: func
- description: Returns the tooltip props by current index, badge's percentage and raw values
##### Signature:
`({currentIndex: number, difference: string, differenceValue: number}) => TooltipCommonProps`
### onDifferenceBadgeTooltipShow
- type: func
- description: Callback on tooltip content show event by current index, badge's percentage and raw values
##### Signature:
`({currentIndex: number, difference: string, differenceValue: number}) => void`