@carbon/ibm-products
Version:
Carbon for IBM Products
50 lines (45 loc) • 1.85 kB
JavaScript
/**
* Copyright IBM Corp. 2020, 2025
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/
;
/**
* Reserved for future expansion, i.e. "RING".
*/
/**
* Describes the style and behavior of a Coachmark.
* @param TOOLTIP includes a caret pointing to the animated beacon.
* @param FLOATING includes a drag handle across the top.
* @param FIXED is fixed to the bottom-right of the viewport.
* @param STACKED is fixed to the bottom-right of the viewport, includes links to show more, stackable Coachmarks if included.
*/
let COACHMARK_OVERLAY_KIND = /*#__PURE__*/function (COACHMARK_OVERLAY_KIND) {
COACHMARK_OVERLAY_KIND["TOOLTIP"] = "tooltip";
COACHMARK_OVERLAY_KIND["FLOATING"] = "floating";
COACHMARK_OVERLAY_KIND["FIXED"] = "fixed";
COACHMARK_OVERLAY_KIND["STACKED"] = "stacked";
return COACHMARK_OVERLAY_KIND;
}({});
/**
* Where to render the Coachmark relative to its target.
* Applies only to Floating and Tooltip Coachmarks.
*/
let COACHMARK_ALIGNMENT = /*#__PURE__*/function (COACHMARK_ALIGNMENT) {
COACHMARK_ALIGNMENT["BOTTOM"] = "bottom";
COACHMARK_ALIGNMENT["BOTTOM_LEFT"] = "bottom-left";
COACHMARK_ALIGNMENT["BOTTOM_RIGHT"] = "bottom-right";
COACHMARK_ALIGNMENT["LEFT"] = "left";
COACHMARK_ALIGNMENT["LEFT_TOP"] = "left-top";
COACHMARK_ALIGNMENT["LEFT_BOTTOM"] = "left-bottom";
COACHMARK_ALIGNMENT["RIGHT"] = "right";
COACHMARK_ALIGNMENT["RIGHT_TOP"] = "right-top";
COACHMARK_ALIGNMENT["RIGHT_BOTTOM"] = "right-bottom";
COACHMARK_ALIGNMENT["TOP"] = "top";
COACHMARK_ALIGNMENT["TOP_LEFT"] = "top-left";
COACHMARK_ALIGNMENT["TOP_RIGHT"] = "top-right";
return COACHMARK_ALIGNMENT;
}({});
exports.COACHMARK_ALIGNMENT = COACHMARK_ALIGNMENT;
exports.COACHMARK_OVERLAY_KIND = COACHMARK_OVERLAY_KIND;