mirror of
https://github.com/outline/outline.git
synced 2026-11-21 13:34:02 +03:00
229 lines
6.3 KiB
TypeScript
229 lines
6.3 KiB
TypeScript
import Tippy, { TippyProps } from "@tippyjs/react";
|
|
import { transparentize } from "polished";
|
|
import * as React from "react";
|
|
import styled, { createGlobalStyle } from "styled-components";
|
|
import { roundArrow } from "tippy.js";
|
|
import { s } from "@shared/styles";
|
|
import useMobile from "~/hooks/useMobile";
|
|
import { useTooltipContext } from "./TooltipContext";
|
|
|
|
export type Props = Omit<TippyProps, "content" | "theme"> & {
|
|
/** The content to display in the tooltip. */
|
|
content?: React.ReactChild | React.ReactChild[];
|
|
/** A keyboard shortcut to display next to the content */
|
|
shortcut?: React.ReactNode;
|
|
/** Whether to show the shortcut on a new line */
|
|
shortcutOnNewline?: boolean;
|
|
};
|
|
|
|
/**
|
|
* A tooltip component that wraps Tippy and provides a consistent look and feel. Optionally
|
|
* displays a keyboard shortcut next to the content.
|
|
*
|
|
* Wrap this component in a TooltipProvider to allow multiple tooltips to share the same
|
|
* singleton instance (delay, animation, etc).
|
|
*/
|
|
function Tooltip({
|
|
shortcut,
|
|
shortcutOnNewline,
|
|
content: tooltip,
|
|
delay = 500,
|
|
...rest
|
|
}: Props) {
|
|
const isMobile = useMobile();
|
|
const singleton = useTooltipContext();
|
|
|
|
let content = <>{tooltip}</>;
|
|
|
|
if (!tooltip || isMobile) {
|
|
return rest.children ?? null;
|
|
}
|
|
|
|
if (shortcut) {
|
|
content = (
|
|
<>
|
|
{tooltip}
|
|
{shortcutOnNewline ? <br /> : " "}
|
|
{typeof shortcut === "string" ? (
|
|
shortcut
|
|
.split("+")
|
|
.map((key, i) => (
|
|
<Shortcut key={`${key}${i}`}>
|
|
{key.length === 1 ? key.toUpperCase() : key}
|
|
</Shortcut>
|
|
))
|
|
) : (
|
|
<Shortcut>{shortcut}</Shortcut>
|
|
)}
|
|
</>
|
|
);
|
|
}
|
|
|
|
return (
|
|
<Tippy
|
|
arrow={roundArrow}
|
|
content={content}
|
|
delay={delay}
|
|
animation="shift-away"
|
|
singleton={singleton}
|
|
duration={[200, 150]}
|
|
inertia
|
|
{...rest}
|
|
/>
|
|
);
|
|
}
|
|
|
|
const Shortcut = styled.kbd`
|
|
position: relative;
|
|
top: -1px;
|
|
|
|
margin-left: 2px;
|
|
display: inline-block;
|
|
padding: 2px 4px;
|
|
font-size: 12px;
|
|
font-family: ${s("fontFamilyMono")};
|
|
line-height: 10px;
|
|
color: ${s("tooltipText")};
|
|
border: 1px solid ${(props) => transparentize(0.75, props.theme.tooltipText)};
|
|
vertical-align: middle;
|
|
border-radius: 3px;
|
|
`;
|
|
|
|
export const TooltipStyles = createGlobalStyle`
|
|
.tippy-box[data-animation=fade][data-state=hidden]{
|
|
opacity:0
|
|
}
|
|
[data-tippy-root]{
|
|
max-width:calc(100vw - 10px)
|
|
}
|
|
.tippy-box{
|
|
position:relative;
|
|
background-color: ${s("tooltipBackground")};
|
|
color: ${s("tooltipText")};
|
|
border-radius:4px;
|
|
font-size:13px;
|
|
line-height:1.4;
|
|
white-space:normal;
|
|
outline:0;
|
|
transition-property:transform,visibility,opacity
|
|
}
|
|
.tippy-box[data-placement^=top]>.tippy-arrow{
|
|
bottom:0
|
|
}
|
|
.tippy-box[data-placement^=top]>.tippy-arrow:before{
|
|
bottom:-7px;
|
|
left:0;
|
|
border-width:8px 8px 0;
|
|
border-top-color:initial;
|
|
transform-origin:center top
|
|
}
|
|
.tippy-box[data-placement^=bottom]>.tippy-arrow{
|
|
top:0
|
|
}
|
|
.tippy-box[data-placement^=bottom]>.tippy-arrow:before{
|
|
top:-7px;
|
|
left:0;
|
|
border-width:0 8px 8px;
|
|
border-bottom-color:initial;
|
|
transform-origin:center bottom
|
|
}
|
|
.tippy-box[data-placement^=left]>.tippy-arrow{
|
|
right:0
|
|
}
|
|
.tippy-box[data-placement^=left]>.tippy-arrow:before{
|
|
border-width:8px 0 8px 8px;
|
|
border-left-color:initial;
|
|
right:-7px;
|
|
transform-origin:center left
|
|
}
|
|
.tippy-box[data-placement^=right]>.tippy-arrow{
|
|
left:0
|
|
}
|
|
.tippy-box[data-placement^=right]>.tippy-arrow:before{
|
|
left:-7px;
|
|
border-width:8px 8px 8px 0;
|
|
border-right-color:initial;
|
|
transform-origin:center right
|
|
}
|
|
.tippy-box[data-inertia][data-state=visible]{
|
|
transition-timing-function:cubic-bezier(.54,1.5,.38,1.11)
|
|
}
|
|
.tippy-arrow{
|
|
width:16px;
|
|
height:16px;
|
|
color: ${s("tooltipBackground")};
|
|
}
|
|
.tippy-arrow:before{
|
|
content:"";
|
|
position:absolute;
|
|
border-color:transparent;
|
|
border-style:solid
|
|
}
|
|
.tippy-content{
|
|
position:relative;
|
|
padding:5px 9px;
|
|
z-index:1
|
|
}
|
|
|
|
/* Arrow Styles */
|
|
.tippy-box[data-placement^=top]>.tippy-svg-arrow{
|
|
bottom:0
|
|
}
|
|
.tippy-box[data-placement^=top]>.tippy-svg-arrow:after,.tippy-box[data-placement^=top]>.tippy-svg-arrow>svg{
|
|
top:16px;
|
|
transform:rotate(180deg)
|
|
}
|
|
.tippy-box[data-placement^=bottom]>.tippy-svg-arrow{
|
|
top:0
|
|
}
|
|
.tippy-box[data-placement^=bottom]>.tippy-svg-arrow>svg{
|
|
bottom:16px
|
|
}
|
|
.tippy-box[data-placement^=left]>.tippy-svg-arrow{
|
|
right:0
|
|
}
|
|
.tippy-box[data-placement^=left]>.tippy-svg-arrow:after,.tippy-box[data-placement^=left]>.tippy-svg-arrow>svg{
|
|
transform:rotate(90deg);
|
|
top:calc(50% - 3px);
|
|
left:11px
|
|
}
|
|
.tippy-box[data-placement^=right]>.tippy-svg-arrow{
|
|
left:0
|
|
}
|
|
.tippy-box[data-placement^=right]>.tippy-svg-arrow:after,.tippy-box[data-placement^=right]>.tippy-svg-arrow>svg{
|
|
transform:rotate(-90deg);
|
|
top:calc(50% - 3px);
|
|
right:11px
|
|
}
|
|
.tippy-svg-arrow{
|
|
width:16px;
|
|
height:16px;
|
|
fill: ${s("tooltipBackground")};
|
|
text-align:initial
|
|
}
|
|
.tippy-svg-arrow,.tippy-svg-arrow>svg{
|
|
position:absolute
|
|
}
|
|
|
|
/* Animation */
|
|
.tippy-box[data-animation=shift-away][data-state=hidden]{opacity:0}.tippy-box[data-animation=shift-away][data-state=hidden][data-placement^=top]{transform:translateY(10px)}.tippy-box[data-animation=shift-away][data-state=hidden][data-placement^=bottom]{transform:translateY(-10px)}.tippy-box[data-animation=shift-away][data-state=hidden][data-placement^=left]{transform:translateX(10px)}.tippy-box[data-animation=shift-away][data-state=hidden][data-placement^=right]{transform:translateX(-10px)}
|
|
|
|
.tippy-box[data-animation=shift-away][data-state=hidden]{
|
|
opacity:0
|
|
}
|
|
.tippy-box[data-animation=shift-away][data-state=hidden][data-placement^=top]{
|
|
transform:translateY(10px)
|
|
}
|
|
.tippy-box[data-animation=shift-away][data-state=hidden][data-placement^=bottom]{
|
|
transform:translateY(-10px)
|
|
}
|
|
.tippy-box[data-animation=shift-away][data-state=hidden][data-placement^=left]{
|
|
transform:translateX(10px)
|
|
}
|
|
.tippy-box[data-animation=shift-away][data-state=hidden][data-placement^=right]{
|
|
transform:translateX(-10px)
|
|
}
|
|
`;
|
|
|
|
export default Tooltip;
|