Tooltip
Tooltips
display informative text when users hover over, focus on, or tap an element.
Basic Usage
Any Paragon component or export may be added to the code example.
Light version
Any Paragon component or export may be added to the code example.
Theme Variables (SCSS)#
$tooltip-font-size: $font-size-sm !default;$tooltip-max-width: 200px !default;$tooltip-color: $white !default;$tooltip-bg: $black !default;$tooltip-border-radius: $border-radius !default;$tooltip-opacity: 1 !default;$tooltip-padding-y: .5rem !default;$tooltip-padding-x: .5rem !default;$tooltip-margin: 0 !default;$tooltip-box-shadow: drop-shadow(0 2px 4px rgba(0, 0, 0, .15))drop-shadow(0 2px 8px rgba(0, 0, 0, .15)) !default;$tooltip-arrow-width: .8rem !default;$tooltip-arrow-height: .4rem !default;$tooltip-arrow-color: $tooltip-bg !default;$tooltip-color-light: $black !default;$tooltip-bg-light: $white !default;$tooltip-arrow-color-light: $white !default;
Props API#
- id
string
An html id attribute, necessary for accessibility.
- placement
enum
'auto-start' | 'auto' | 'auto-end' | 'top-start' | 'top' | 'top-end' | 'right-start' | 'right' | 'right-end' | 'bottom-end' | 'bottom' | 'bottom-start' | 'left-end' | 'left' | 'left-start'Default'right'Sets the direction the
Tooltip
is positioned towards.This is generally provided by the
Overlay
component positioning the tooltip. - arrowProps
shape
{ref:func
|shape
{current:},element
,style:}shape
{},An
Overlay
injected set of props for positioning theTooltip
arrow.This is generally provided by the
Overlay
component positioning the tooltip. - show
bool
Whether the
Overlay
is shown. - popper
shape
{}A
Popper.js
config object passed to the the underlying popper instance. - bsPrefix
string
Default'tooltip'Overrides underlying component base CSS class name
- children
node
Specifies the content of the
Tooltip
- className
string
Specifies class name to append to the base element
- variant
string
The visual style of the
Tooltip
Usage Insights#
Tooltip
Project Name | Paragon Version | Instance Count | |
---|---|---|---|
frontend-app-admin-portal | 20.26.3 | 7 | |
frontend-app-authn | 20.34.0 | 1 | |
frontend-app-course-authoring | 20.32.0 | 1 | |
frontend-app-discussions | 20.15.0 | 19 | |
frontend-app-gradebook | 19.25.4 | 1 | |
frontend-app-learner-record | 20.28.4 | 1 | |
frontend-app-learning | 20.28.4 | 1 | |
frontend-app-publisher | 20.28.5 | 2 | |
frontend-lib-content-components | 20.32.0 | 3 | |
prospectus | 20.28.3 | 6 |