zero-tooltip 1.4.3 → 2.0.0

package/src/types/scrollContainer.ts

@@ -1,6 +1,6 @@
-export type ScrollContainer = {
-    'element': HTMLElement | Window,
-    'eventController': AbortController
-}
-
+export type ScrollContainer = {
+    'element': HTMLElement | Window,
+    'eventController': AbortController
+}
+
 export type ScrollContainers = ScrollContainer[]

package/src/types/tooltipConfig.ts

@@ -1,24 +1,91 @@
-import TooltipPosition from "./tooltipPosition"
-import TooltipPositions from "./tooltipPositions"
-
-type TooltipConfig = {
-    appendTo?: string,
-    defaultPosition?: TooltipPosition,
-    positions?: Partial<TooltipPositions>,
-    offsetFromSource?: number,
-    offsetFromViewport?: number,
-    minWidth?: number,
-    maxWidth?: number,
-    tooltipBorderWidth?: number,
-    tooltipClasses?: string,
-    textClasses?: string,
-    arrowSize?: number,
-    arrowClasses?: string,
-    arrowMinOffsetFromTooltipCorner?: number,
-    zIndex?: number | string,
-    showDelay?: number,
-    hideDelay?: number,
-    showWarnings?: boolean,
-}
-
-export default TooltipConfig
+import TooltipPosition from "./tooltipPosition"
+import TooltipPositions from "./tooltipPositions"
+
+type TooltipConfig = {
+    /**
+     * A valid CSS query selector to specify where Tooltip gets appended.
+     */
+    appendTo?: string,
+
+    /**
+     * Position of tooltip component relative to element that is being hovered.
+     */
+    defaultPosition?: TooltipPosition,
+
+    /**
+     * Ordered list of fallback positions in case tooltip does not have enough space in default position. If none of given positions will have enough space for tooltip, then it will not be rendered.
+     */
+    positions?: Partial<TooltipPositions>,
+
+    /**
+     * Tooltip offset in px from element that's being hovered *(arrow size is not added to this value)*
+     */
+    offsetFromSource?: number,
+
+    /**
+     * Minimal allowed tooltip offset in `px` from viewport sides
+     */
+    offsetFromViewport?: number,
+
+    /**
+     * Minimal tooltip width in `px` that will be allowed to render
+     */
+    minWidth?: number,
+
+    /**
+     * Maximal tooltip width in `px` that will be allowed to render
+     */
+    maxWidth?: number,
+
+    /**
+     * Tooltip container border width in `px`
+     */
+    tooltipBorderWidth?: number,
+
+    /**
+     * List of classes that will be added to tooltip element
+     */
+    tooltipClasses?: string,
+
+    /**
+     * List of classes that will be added to text element
+     */
+    textClasses?: string,
+
+    /**
+     * Length of arrow hypotenuse in `px` (arrow is generated using border width property, creating square which gets divided in four triangles, thus `arrowSize` is length of square side)
+     */
+    arrowSize?: number,
+
+    /**
+     * List of classes that will be added to arrow element
+     */
+    arrowClasses?: string,
+
+    /**
+     * Minimal allowed arrow offset in `px` from tooltip corner. Used in situations when tooltip does not have enough space to be centered relative to element that is being hover, thus arrow is rendered closer to one of the tooltip corners
+     */
+    arrowMinOffsetFromTooltipCorner?: number,
+
+    /**
+     * `z-index` css property value of tooltip
+     */
+    zIndex?: number | string,
+
+    /**
+     * Delay in milliseconds after which to show tooltip while hovering over element
+     */
+    showDelay?: number,
+
+    /**
+     * Delay in milliseconds after which to hide tooltip when leaving element boundaries
+     */
+    hideDelay?: number,
+
+    /**
+     * Whether to show warning about empty tooltip text value in cases when tooltip was expected to be shown
+     */
+    showWarnings?: boolean,
+}
+
+export default TooltipConfig

package/src/types/tooltipLocalConfig.ts

@@ -1,9 +1,21 @@
-import TooltipConfig from "./tooltipConfig"
-
-type TooltipLocalConfig = {
-    content: string,
-    show?: boolean,
-    alwaysOn?: boolean,
-} & TooltipConfig
-
-export default TooltipLocalConfig
+import TooltipConfig from "./tooltipConfig"
+
+type TooltipLocalConfig = {
+    /**
+     * Tooltip text. Text is rendered as HTML, thus it's possible to give simple HTML structure, e.g., `<h1>Tooltip text</h1>`
+     */
+    content: string,
+
+    /**
+     * Define whether tooltip should be shown on hover (enabled/disabled). Default value is `false` if `alwaysOn` is set, otherwise it's `true`.
+     */
+    show?: boolean,
+
+    /**
+     * Define whether to show tooltip (on mount) without needing hover trigger
+     * If `alwaysOn` is set, `show` will be set to `false` by default.
+     */
+    alwaysOn?: boolean,
+} & TooltipConfig
+
+export default TooltipLocalConfig

package/src/types/tooltipPosition.ts

@@ -1,4 +1,4 @@
-type TooltipPosition = 'left' | 'top' | 'right' | 'bottom'
-
-export default TooltipPosition
-
+type TooltipPosition = 'left' | 'top' | 'right' | 'bottom'
+
+export default TooltipPosition
+

package/src/types/tooltipPositions.ts

@@ -1,10 +1,10 @@
-import TooltipPosition from "./tooltipPosition"
-
-type TooltipPositions = {
-    left: [ TooltipPosition, TooltipPosition, TooltipPosition, TooltipPosition]
-    top: [ TooltipPosition, TooltipPosition, TooltipPosition, TooltipPosition]
-    right: [ TooltipPosition, TooltipPosition, TooltipPosition, TooltipPosition]
-    bottom: [ TooltipPosition, TooltipPosition, TooltipPosition, TooltipPosition]
-}
-
-export default TooltipPositions
+import TooltipPosition from "./tooltipPosition"
+
+type TooltipPositions = {
+    left: [ TooltipPosition, TooltipPosition, TooltipPosition, TooltipPosition]
+    top: [ TooltipPosition, TooltipPosition, TooltipPosition, TooltipPosition]
+    right: [ TooltipPosition, TooltipPosition, TooltipPosition, TooltipPosition]
+    bottom: [ TooltipPosition, TooltipPosition, TooltipPosition, TooltipPosition]
+}
+
+export default TooltipPositions