@stack-spot/portal-components 0.0.18 → 1.0.0

package/dist/components/{tour → Tour}/StepContainer.js

@@ -4,6 +4,10 @@ import { styled } from 'styled-components';
 import { StepNavigation } from './StepNavigation.js';
 import { StepTitle } from './StepTitle.js';
 import { useTour } from './context.js';
+/**
+ * Tutorial: the overlay component for showing a step on React Tour.
+ * @param props the react props for the component {@link StepContainerProps}.
+ */
 export const StepContainer = ({ title, stepKey, customNavigation, position, children }) => {
     const { finishStep } = useTour();
     return _jsxs(BoxWithPointingArrow, { "$position": position, children: [_jsx(StepTitle, { title: title, onClose: () => finishStep(stepKey) }), children, _jsx(StepNavigation, { stepKey: stepKey, ...(customNavigation || {}) })] });

package/dist/components/Tour/StepContainer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StepContainer.js","sourceRoot":"","sources":["../../../src/components/Tour/StepContainer.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAA;AAEhD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC1C,OAAO,EAAmB,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAsBnC;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,EAAsB,EAAE,EAAE;IAC5G,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,CAAA;IAChC,OAAO,MAAC,oBAAoB,iBAAY,QAAQ,aAC9C,KAAC,SAAS,IAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,GAAI,EAC9D,QAAQ,EACT,KAAC,cAAc,IAAC,OAAO,EAAE,OAAO,KAAM,CAAC,gBAAgB,IAAI,EAAE,CAAC,GAAI,IAC7C,CAAA;AACzB,CAAC,CAAA;AAID,MAAM,oBAAoB,GAAG,MAAM,CAAC,GAAG,CAInC;;;sBAGkB,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;;;;;;;;0BAQpB,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;MAC5C,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,SAAS,KAAK,OAAO,CAAC,CAAC;IAClD;aACS,IAAI,IAAI,MAAM;;KAEtB,CAAC,CAAC,CAAC,EAAE;MACJ,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,SAAS,KAAK,KAAK,CAAC,CAAC;IAClD;;aAES,MAAM,IAAI,MAAM;;KAExB,CAAC,CAAC,CAAC,EAAE;MACJ,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,SAAS,KAAK,MAAM,CAAC,CAAC;IACjD;aACS,IAAI,IAAI,MAAM;;;KAGtB,CAAC,CAAC,CAAC,EAAE;MACJ,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC;IACrD;;aAES,MAAM,IAAI,MAAM;;KAExB,CAAC,CAAC,CAAC,EAAE;;CAET,CAAA"}

package/dist/components/Tour/StepNavigation.d.ts

@@ -0,0 +1,29 @@
+import '@stack-spot/portal-theme/dist/theme.css';
+interface CustomNavigationButton {
+    /**
+     * The text content to render.
+     */
+    text: string;
+    onClick?: () => void;
+}
+export interface NavigationProps {
+    /**
+     * The unique identifier of the step.
+     */
+    stepKey: string;
+    /**
+     * The text and click handler for the button "next".
+     */
+    nextButton?: CustomNavigationButton;
+    /**
+     * The text and click handler for the button "previous".
+     */
+    prevButton?: CustomNavigationButton;
+}
+/**
+ * Tutorial: the component in a React Tour overlay that shows the next and previous buttons (for step navigation).
+ * @param props the react props for the component {@link NavigationProps}.
+ */
+export declare const StepNavigation: ({ stepKey, nextButton, prevButton }: NavigationProps) => import("react/jsx-runtime").JSX.Element;
+export {};
+//# sourceMappingURL=StepNavigation.d.ts.map

package/dist/components/Tour/StepNavigation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StepNavigation.d.ts","sourceRoot":"","sources":["../../../src/components/Tour/StepNavigation.tsx"],"names":[],"mappings":"AACA,OAAO,yCAAyC,CAAA;AAKhD,UAAU,sBAAsB;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,sBAAsB,CAAC;IACpC;;OAEG;IACH,UAAU,CAAC,EAAE,sBAAsB,CAAC;CACrC;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,wCAAyC,eAAe,4CAsBlF,CAAA"}

package/dist/components/{tour → Tour}/StepNavigation.js

@@ -4,6 +4,10 @@ import '@stack-spot/portal-theme/dist/theme.css';
 import { useTranslate } from '@stack-spot/portal-translate';
 import { useTour } from './context.js';
 import { finishTourStep } from './utils.js';
+/**
+ * Tutorial: the component in a React Tour overlay that shows the next and previous buttons (for step navigation).
+ * @param props the react props for the component {@link NavigationProps}.
+ */
 export const StepNavigation = ({ stepKey, nextButton, prevButton }) => {
     const { currentStep, steps, nextStep, prevStep } = useTour();
     const t = useTranslate({ en: { of: 'of', back: 'back' }, pt: { of: 'de', back: 'voltar' } });

package/dist/components/Tour/StepNavigation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StepNavigation.js","sourceRoot":"","sources":["../../../src/components/Tour/StepNavigation.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,yCAAyC,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAyBxC;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAmB,EAAE,EAAE;IACrF,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAA;IAC5D,MAAM,CAAC,GAAG,YAAY,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAA;IAC5F,OAAO,MAAC,IAAI,IAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAC,MAAM,EAAC,EAAE,EAAC,aAAa,EAAC,cAAc,EAAC,eAAe,aACzF,MAAC,IAAI,IAAC,UAAU,EAAC,YAAY,EAAC,WAAW,EAAC,sBAAsB,aAAE,WAAW,GAAG,CAAC,OAAG,CAAC,CAAC,EAAE,OAAG,KAAK,CAAC,MAAM,IAAQ,EAC/G,MAAC,IAAI,IAAC,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,aACrB,WAAW,IAAI,CAAC;wBACf,KAAC,MAAM,IAAC,EAAE,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE;gCACnD,QAAQ,EAAE,EAAE,CAAA;gCACZ,UAAU,EAAE,OAAO,EAAE,EAAE,CAAA;4BACzB,CAAC,EAAE,IAAI,EAAC,IAAI,EAAC,WAAW,EAAC,OAAO,YAC7B,UAAU,EAAE,IAAI,IAAI,CAAC,CAAC,IAAI,GACpB,EACX,KAAC,MAAM,IAAC,EAAE,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE;4BACnD,UAAU,EAAE,OAAO,EAAE,EAAE,CAAA;4BACvB,QAAQ,EAAE,EAAE,CAAA;4BACZ,cAAc,CAAC,OAAO,CAAC,CAAA;wBACzB,CAAC,EAAE,IAAI,EAAC,IAAI,EAAC,WAAW,EAAC,OAAO,YAC7B,UAAU,EAAE,IAAI,IAAI,IAAI,GAClB,IACJ,IACF,CAAA;AACT,CAAC,CAAA"}

package/dist/components/Tour/StepTitle.d.ts

@@ -0,0 +1,17 @@
+interface StepTitleProps {
+    /**
+     * The step's title.
+     */
+    title: string;
+    /**
+     * A function to run once the step is closed.
+     */
+    onClose?: () => void;
+}
+/**
+ * Tutorial: the component in a React Tour overlay that renders the title.
+ * @param props the react props for the component {@link StepTitleProps}.
+ */
+export declare const StepTitle: ({ title, onClose }: StepTitleProps) => import("react/jsx-runtime").JSX.Element;
+export {};
+//# sourceMappingURL=StepTitle.d.ts.map

package/dist/components/Tour/StepTitle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StepTitle.d.ts","sourceRoot":"","sources":["../../../src/components/Tour/StepTitle.tsx"],"names":[],"mappings":"AAGA,UAAU,cAAc;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB;AAED;;;GAGG;AACH,eAAO,MAAM,SAAS,uBAAwB,cAAc,4CAQnD,CAAA"}

package/dist/components/{tour → Tour}/StepTitle.js

@@ -1,5 +1,9 @@
 import { jsxs as _jsxs, jsx as _jsx } from "react/jsx-runtime";
 import { Button, Flex, IconBox, Text } from '@citric/core';
 import { TimesMini } from '@citric/icons';
+/**
+ * Tutorial: the component in a React Tour overlay that renders the title.
+ * @param props the react props for the component {@link StepTitleProps}.
+ */
 export const StepTitle = ({ title, onClose }) => _jsxs(Flex, { w: 12, pl: 5, py: 3, flexWrap: "nowrap", justifyContent: "space-between", alignItems: "center", children: [_jsxs(Text, { appearance: "body2", colorScheme: "inverse.contrastText", weight: "medium", children: [" ", title, " "] }), _jsx(Button, { appearance: "text", size: "sm", onClick: () => onClose?.(), sx: { ':hover': { borderColor: 'transparent !important' } }, children: _jsx(IconBox, { size: "xs", colorIcon: "inverse.contrastText", children: _jsx(TimesMini, {}) }) })] });
 //# sourceMappingURL=StepTitle.js.map

package/dist/components/Tour/StepTitle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StepTitle.js","sourceRoot":"","sources":["../../../src/components/Tour/StepTitle.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAazC;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,EAAkB,EAAE,EAAE,CAC9D,MAAC,IAAI,IAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,QAAQ,EAAC,QAAQ,EAAC,cAAc,EAAC,eAAe,EAAC,UAAU,EAAC,QAAQ,aAC7F,MAAC,IAAI,IAAC,UAAU,EAAC,OAAO,EAAC,WAAW,EAAC,sBAAsB,EAAC,MAAM,EAAC,QAAQ,kBAAG,KAAK,SAAS,EAC5F,KAAC,MAAM,IAAC,UAAU,EAAC,MAAM,EAAC,IAAI,EAAC,IAAI,EAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,WAAW,EAAE,wBAAwB,EAAE,EAAE,YACzH,KAAC,OAAO,IAAC,IAAI,EAAC,IAAI,EAAC,SAAS,EAAC,sBAAsB,YACjD,KAAC,SAAS,KAAG,GACL,GACH,IACJ,CAAA"}

package/dist/components/{tour → Tour}/context.d.ts

@@ -1,11 +1,22 @@
 import { ReactNode } from 'react';
 import { ReactourProps } from 'reactour';
 type TourConfig = Omit<ReactourProps, 'children'>;
+/**
+ * Tutorial: the default configuration for a React Tour.
+ */
 export declare const defaultTourConfig: TourConfig;
+/**
+ * Tutorial: provides the configuration for React Tour.
+ * @param props the configuration for the tour and the content to render.
+ */
 export declare const TourProvider: ({ config, children }: {
     config: TourConfig;
     children: ReactNode;
 }) => import("react/jsx-runtime").JSX.Element;
+/**
+ * Tutorial: retrieves data related to the current step of React Tour.
+ * @returns an object with all the information related to the steps of React Tour.
+ */
 export declare const useTour: () => {
     currentStep: number;
     nextStep: (() => void) | undefined;

package/dist/components/Tour/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../src/components/Tour/context.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAuC,MAAM,OAAO,CAAA;AACtE,OAAa,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAG9C,KAAK,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,CAAA;AAEjD;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,UAU9B,CAAA;AAOF;;;GAGG;AACH,eAAO,MAAM,YAAY;YAAoC,UAAU;cAAY,SAAS;6CAkB3F,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,OAAO;;;;;0BAOM,MAAM;CAK/B,CAAA"}

package/dist/components/{tour → Tour}/context.js

@@ -2,6 +2,9 @@ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import { createContext, useContext, useState } from 'react';
 import Tour from 'reactour';
 import { finishTourStep } from './utils.js';
+/**
+ * Tutorial: the default configuration for a React Tour.
+ */
 export const defaultTourConfig = Object.freeze({
     steps: [],
     isOpen: true,
@@ -17,6 +20,10 @@ const TourContext = createContext({
     tourConfig: defaultTourConfig,
     currentStep: 0,
 });
+/**
+ * Tutorial: provides the configuration for React Tour.
+ * @param props the configuration for the tour and the content to render.
+ */
 export const TourProvider = ({ config, children }) => {
     const [currentStep, setCurrentStep] = useState(0);
     const tourConfig = {
@@ -32,6 +39,10 @@ export const TourProvider = ({ config, children }) => {
             tourConfig,
         }, children: [_jsx(Tour, { ...tourConfig }), children] });
 };
+/**
+ * Tutorial: retrieves data related to the current step of React Tour.
+ * @returns an object with all the information related to the steps of React Tour.
+ */
 export const useTour = () => {
     const { currentStep, tourConfig: { nextStep, prevStep, steps } } = useContext(TourContext);
     return {

package/dist/components/Tour/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../src/components/Tour/context.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAa,aAAa,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AACtE,OAAO,IAAuB,MAAM,UAAU,CAAA;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAIxC;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAe,MAAM,CAAC,MAAM,CAAC;IACzD,KAAK,EAAE,EAAE;IACT,MAAM,EAAE,IAAI;IACZ,cAAc,EAAE,GAAG,EAAE,CAAC,EAAE;IACxB,WAAW,EAAE,KAAK;IAClB,cAAc,EAAE,KAAK;IACrB,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE,KAAK;IACjB,eAAe,EAAE,KAAK;IACtB,gBAAgB,EAAE,IAAI;CACvB,CAAC,CAAA;AAEF,MAAM,WAAW,GAAG,aAAa,CAAkD;IACjF,UAAU,EAAE,iBAAiB;IAC7B,WAAW,EAAE,CAAC;CACf,CAAC,CAAA;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,EAAE,MAAM,EAAE,QAAQ,EAA+C,EAAE,EAAE;IAChG,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,QAAQ,CAAS,CAAC,CAAC,CAAA;IACzD,MAAM,UAAU,GAAe;QAC7B,GAAG,MAAM;QACT,QAAQ,EAAE,WAAW;QACrB,MAAM,EAAE,GAAG,WAAW,EAAE;QACxB,QAAQ,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,WAAW,GAAG,CAAC,CAAC;QAC/C,QAAQ,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,WAAW,GAAG,CAAC,CAAC;QAC/C,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;KACrE,CAAA;IAED,OAAO,MAAC,WAAW,CAAC,QAAQ,IAAC,KAAK,EAAE;YAClC,WAAW;YACX,UAAU;SACX,aACC,KAAC,IAAI,OAAK,UAAU,GAAI,EACvB,QAAQ,IACY,CAAA;AACzB,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,GAAG,EAAE;IAC1B,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,GAAG,UAAU,CAAC,WAAW,CAAC,CAAA;IAC1F,OAAO;QACL,WAAW;QACX,QAAQ;QACR,QAAQ;QACR,KAAK;QACL,UAAU,EAAE,CAAC,OAAe,EAAE,EAAE;YAC9B,cAAc,CAAC,OAAO,CAAC,CAAA;YACvB,QAAQ,EAAE,EAAE,CAAA;QACd,CAAC;KACF,CAAA;AACH,CAAC,CAAA"}

package/dist/components/{tour → Tour}/index.d.ts

@@ -1,7 +1,7 @@
 import { ReactourProps, ReactourStep } from 'reactour';
 export { StepContainer } from './StepContainer.js';
 export { TourProvider, defaultTourConfig, useTour } from './context.js';
-export { isNewTourStep, tourStepBuilder } from './utils.js';
+export { hasFinishedTourStep, isNewTourStep, tourStepBuilder } from './utils.js';
 export { ReactourStep as TourStep };
 export type TourProps = Partial<Omit<ReactourProps, 'children'>> & {
     steps: ReactourStep[];

package/dist/components/Tour/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/Tour/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAEtD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACpE,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAC7E,OAAO,EAAE,YAAY,IAAI,QAAQ,EAAE,CAAA;AACnC,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,GAAG;IAAE,KAAK,EAAE,YAAY,EAAE,CAAA;CAAE,CAAA"}

package/dist/components/{tour → Tour}/index.js

@@ -1,4 +1,4 @@
 export { StepContainer } from './StepContainer.js';
 export { TourProvider, defaultTourConfig, useTour } from './context.js';
-export { isNewTourStep, tourStepBuilder } from './utils.js';
+export { hasFinishedTourStep, isNewTourStep, tourStepBuilder } from './utils.js';
 //# sourceMappingURL=index.js.map

package/dist/components/Tour/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/components/Tour/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACpE,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA"}

package/dist/components/Tour/utils.d.ts

@@ -0,0 +1,50 @@
+import { ReactNode } from 'react';
+import { ReactourStep } from 'reactour';
+import { NavigationProps } from './StepNavigation.js';
+/**
+ * Tutorial: marks the tour step as finished. This sets a cookie, preventing the tour from showing again.
+ * @param key the identifier for the step to mark as finished.
+ */
+export declare const finishTourStep: (key: string) => void;
+/**
+ * Tutorial: verifies if the React Tour step has not finished yet.
+ *
+ * A step has not finished if the array stored as a cookie doesn't include the string value of `step.selector`.
+ * @param step the step config.
+ * @returns true if the step has not yet been marked as finished. False otherwise.
+ */
+export declare const isNewTourStep: (step: ReactourStep) => boolean;
+/**
+ * Tutorial: verifies if the key passed as parameter refers to a React Tour step that has already finished.
+ *
+ * The key refers to a finished step if the array stored as a cookie includes it.
+ * @param key the step's identifier to check.
+ * @returns true if the key refers to a finished step. False otherwise.
+ */
+export declare const hasFinishedTourStep: (key: string) => boolean;
+interface StackspotTourStep extends ReactourStep {
+    /**
+     * The step's title.
+     */
+    title: string;
+    /**
+     * The unique identifier for the step (key).
+     */
+    selector: string;
+    /**
+     * The step's content.
+     */
+    content: ReactNode;
+    /**
+     * A set of properties for customizing the next and previous buttons.
+     */
+    customNavigation?: NavigationProps;
+}
+/**
+ * Tutorial: utility for building a React Tour step. This already includes some default configuration for tours in Stackspot.
+ * @param options the options for building the step: {@link StackspotTourStep}.
+ * @returns the React Tour step.
+ */
+export declare const tourStepBuilder: ({ selector, position, title, content, style, customNavigation, ...rest }: StackspotTourStep) => ReactourStep;
+export {};
+//# sourceMappingURL=utils.d.ts.map

package/dist/components/Tour/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/components/Tour/utils.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACjC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAGvC,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AASlD;;;GAGG;AACH,eAAO,MAAM,cAAc,QAAS,MAAM,SAIzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,SAAU,YAAY,YAA6C,CAAA;AAE7F;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,QAAS,MAAM,YAAkC,CAAA;AAEjF,UAAU,iBAAkB,SAAQ,YAAY;IAC9C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE,SAAS,CAAC;IACnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,eAAe,CAAC;CACpC;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe,6EAQzB,iBAAiB,KAAG,YAkBrB,CAAA"}

package/dist/components/Tour/utils.js

@@ -0,0 +1,54 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { theme } from '@stack-spot/portal-theme';
+import { getCookie, setCookie } from '../../utils/cookie.js';
+import { StepContainer } from './StepContainer.js';
+const TOUR_COOKIE = 'guided-tour-global';
+const getTourCookie = () => {
+    const currentTourObject = getCookie(TOUR_COOKIE);
+    return currentTourObject ? currentTourObject.split(',') : [];
+};
+/**
+ * Tutorial: marks the tour step as finished. This sets a cookie, preventing the tour from showing again.
+ * @param key the identifier for the step to mark as finished.
+ */
+export const finishTourStep = (key) => {
+    const finishedTours = getTourCookie();
+    if (!finishedTours.includes(key))
+        finishedTours.push(key);
+    setCookie(TOUR_COOKIE, finishedTours.toString());
+};
+/**
+ * Tutorial: verifies if the React Tour step has not finished yet.
+ *
+ * A step has not finished if the array stored as a cookie doesn't include the string value of `step.selector`.
+ * @param step the step config.
+ * @returns true if the step has not yet been marked as finished. False otherwise.
+ */
+export const isNewTourStep = (step) => !hasFinishedTourStep(`${step.selector}`);
+/**
+ * Tutorial: verifies if the key passed as parameter refers to a React Tour step that has already finished.
+ *
+ * The key refers to a finished step if the array stored as a cookie includes it.
+ * @param key the step's identifier to check.
+ * @returns true if the key refers to a finished step. False otherwise.
+ */
+export const hasFinishedTourStep = (key) => getTourCookie().includes(key);
+/**
+ * Tutorial: utility for building a React Tour step. This already includes some default configuration for tours in Stackspot.
+ * @param options the options for building the step: {@link StackspotTourStep}.
+ * @returns the React Tour step.
+ */
+export const tourStepBuilder = ({ selector, position, title, content, style, customNavigation, ...rest }) => ({
+    selector,
+    content: (_jsx(StepContainer, { stepKey: selector, position: position, title: title, customNavigation: customNavigation, children: content })),
+    position,
+    style: {
+        backgroundColor: theme.color.inverse[500],
+        width: '256px',
+        padding: 0,
+        top: ['right', 'left'].includes(position) ? '-3px' : '0',
+        ...(style || {}),
+    },
+    ...(rest || {}),
+});
+//# sourceMappingURL=utils.js.map

package/dist/components/Tour/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/components/Tour/utils.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAA;AAGhD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AACzD,OAAO,EAAyB,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAGtE,MAAM,WAAW,GAAG,oBAAoB,CAAA;AAExC,MAAM,aAAa,GAAG,GAAG,EAAE;IACzB,MAAM,iBAAiB,GAAG,SAAS,CAAC,WAAW,CAAC,CAAA;IAChD,OAAO,iBAAiB,CAAC,CAAC,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;AAC9D,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAW,EAAE,EAAE;IAC5C,MAAM,aAAa,GAAa,aAAa,EAAE,CAAA;IAC/C,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACzD,SAAS,CAAC,WAAW,EAAE,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAA;AAClD,CAAC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAkB,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;AAE7F;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,aAAa,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;AAqBjF;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,EAC9B,QAAQ,EACR,QAAQ,EACR,KAAK,EACL,OAAO,EACP,KAAK,EACL,gBAAgB,EAChB,GAAG,IAAI,EACW,EAAgB,EAAE,CAAC,CAAC;IACtC,QAAQ;IACR,OAAO,EAAE,CAAC,KAAC,aAAa,IACtB,OAAO,EAAE,QAAQ,EACjB,QAAQ,EAAE,QAAiC,EAC3C,KAAK,EAAE,KAAK,EACZ,gBAAgB,EAAE,gBAAgB,YACjC,OAAO,GACM,CAAC;IACjB,QAAQ;IACR,KAAK,EAAE;QACL,eAAe,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QACzC,KAAK,EAAE,OAAO;QACd,OAAO,EAAE,CAAC;QACV,GAAG,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAiC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG;QACjF,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;KACjB;IACD,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;CAChB,CAAC,CAAA"}

package/dist/context/anchor.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="react" />
+export type AnchorComponent = (props: React.AnchorHTMLAttributes<HTMLAnchorElement>) => React.ReactElement;
+interface AnchorContext {
+    /**
+     * The component to render by a layout component a link is needed.
+     * @default <a>
+     */
+    anchorTag?: AnchorComponent;
+}
+/**
+ * Some components need to create HTML anchors (links) to other pages in the website. These links, sometimes, must to be managed by a
+ * navigator for React. Since we don't want to couple this library with any specific navigator, you can provide your own component for
+ * creating links, it must follow the same interface of the HTML's `a` tag.
+ *
+ * If this is not used, the tag `<a>` is used by default.
+ * @param props the anchor component (anchorTag) and the content to render (children).
+ */
+export declare const AnchorProvider: ({ children, ...props }: Required<AnchorContext> & {
+    children: React.ReactNode;
+}) => import("react/jsx-runtime").JSX.Element;
+/**
+ * A React hook for retrieving the Link (anchor) component.
+ * @returns the link component declared at {@link AnchorProvider} or a component that renders the tag <a> from HTML if no link component was
+ * provided.
+ */
+export declare function useAnchorTag(): AnchorComponent;
+export {};
+//# sourceMappingURL=anchor.d.ts.map

package/dist/context/anchor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"anchor.d.ts","sourceRoot":"","sources":["../../src/context/anchor.tsx"],"names":[],"mappings":";AAEA,MAAM,MAAM,eAAe,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,KAAK,KAAK,CAAC,YAAY,CAAA;AAE1G,UAAU,aAAa;IACrB;;;OAGG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B;AAMD;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc;cAAkE,MAAM,SAAS;6CAE3G,CAAA;AAED;;;;GAIG;AACH,wBAAgB,YAAY,IAAI,eAAe,CAG9C"}

package/dist/context/anchor.js

@@ -0,0 +1,23 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { createContext, useContext } from 'react';
+const context = createContext({});
+const Anchor = props => _jsx("a", { ...props });
+/**
+ * Some components need to create HTML anchors (links) to other pages in the website. These links, sometimes, must to be managed by a
+ * navigator for React. Since we don't want to couple this library with any specific navigator, you can provide your own component for
+ * creating links, it must follow the same interface of the HTML's `a` tag.
+ *
+ * If this is not used, the tag `<a>` is used by default.
+ * @param props the anchor component (anchorTag) and the content to render (children).
+ */
+export const AnchorProvider = ({ children, ...props }) => (_jsx(context.Provider, { value: props, children: children }));
+/**
+ * A React hook for retrieving the Link (anchor) component.
+ * @returns the link component declared at {@link AnchorProvider} or a component that renders the tag <a> from HTML if no link component was
+ * provided.
+ */
+export function useAnchorTag() {
+    const { anchorTag } = useContext(context);
+    return anchorTag ?? Anchor;
+}
+//# sourceMappingURL=anchor.js.map

package/dist/context/anchor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"anchor.js","sourceRoot":"","sources":["../../src/context/anchor.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AAYjD,MAAM,OAAO,GAAG,aAAa,CAAgB,EAAE,CAAC,CAAA;AAEhD,MAAM,MAAM,GAAoB,KAAK,CAAC,EAAE,CAAC,eAAO,KAAK,GAAI,CAAA;AAEzD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,EAAE,QAAQ,EAAE,GAAG,KAAK,EAA2D,EAAE,EAAE,CAAC,CACjH,KAAC,OAAO,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,YAAG,QAAQ,GAAoB,CAC9D,CAAA;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY;IAC1B,MAAM,EAAE,SAAS,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;IACzC,OAAO,SAAS,IAAI,MAAM,CAAA;AAC5B,CAAC"}

package/dist/hooks/keyboard.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="react" />
+interface Props {
+    /**
+     * A query selector that returns every html element that must be navigable through the keyboard.
+     */
+    querySelectors: string;
+    /**
+     * Function to call when ESC is pressed. or when TAB is pressed at the last item in the list of items returned by the query selector.
+     */
+    onPressEscape?: () => void;
+    /**
+     * Function to call when TAB is pressed at the last item in the list of items returned by the query selector. Will be the same as
+     * onPressEscape if not specified.
+     */
+    onPressLastTab?: () => void;
+}
+/**
+ * Creates listeners for controlling a Menu UI through the keyboard.
+ * - Arrow down: next element in the iterator returned by the query selectors. First element, it the current element is the last.
+ * - Arrow up: previous element in the iterator returned by the query selectors. Last element, it the current element is the first.
+ * - Tab: same as Arrow down, but has a different behavior if the element is the last (see onPressLastTab).
+ * - Esc: determined by onPressEscape.
+ * @param props {@link Props}.
+ * @returns an object with the element controlled by the keyboard (useRef); a function to attach the keyboard events and a function to
+ * detach the keyboard events.
+ */
+export declare function useKeyboardControls({ querySelectors, onPressEscape, onPressLastTab }: Props): {
+    keyboardControlledElement: import("react").RefObject<HTMLDivElement>;
+    attachKeyboardListeners: () => void;
+    detachKeyboardListeners: () => void;
+};
+export {};
+//# sourceMappingURL=keyboard.d.ts.map

package/dist/hooks/keyboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyboard.d.ts","sourceRoot":"","sources":["../../src/hooks/keyboard.tsx"],"names":[],"mappings":";AAEA,UAAU,KAAK;IACb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,IAAI,CAAC;IAC3B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,IAAI,CAAC;CAC7B;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,EAAE,cAAc,EAAE,aAAa,EAAE,cAA8B,EAAE,EAAE,KAAK;;;;EAmD3G"}

package/dist/hooks/keyboard.js

@@ -0,0 +1,59 @@
+import { useCallback, useRef } from 'react';
+/**
+ * Creates listeners for controlling a Menu UI through the keyboard.
+ * - Arrow down: next element in the iterator returned by the query selectors. First element, it the current element is the last.
+ * - Arrow up: previous element in the iterator returned by the query selectors. Last element, it the current element is the first.
+ * - Tab: same as Arrow down, but has a different behavior if the element is the last (see onPressLastTab).
+ * - Esc: determined by onPressEscape.
+ * @param props {@link Props}.
+ * @returns an object with the element controlled by the keyboard (useRef); a function to attach the keyboard events and a function to
+ * detach the keyboard events.
+ */
+export function useKeyboardControls({ querySelectors, onPressEscape, onPressLastTab = onPressEscape }) {
+    const keyboardControlledElement = useRef(null);
+    const listeners = useRef({});
+    listeners.current = { onPressEscape, onPressLastTab };
+    const keyboardControls = useCallback((event) => {
+        const target = event?.target;
+        function getSelectableAnchors() {
+            return keyboardControlledElement.current?.querySelectorAll(querySelectors) ?? [];
+        }
+        function handleArrows(key = event.key) {
+            const anchors = getSelectableAnchors();
+            let i = 0;
+            while (i < anchors.length && document.activeElement !== anchors[i])
+                i++;
+            const next = key === 'ArrowDown' ? (anchors[i + 1] ?? anchors[0]) : (anchors[i - 1] ?? anchors[anchors.length - 1]);
+            next?.focus?.();
+        }
+        const handlers = {
+            Escape: () => {
+                listeners.current.onPressEscape?.();
+                event.stopPropagation();
+                event.preventDefault();
+            },
+            Enter: () => {
+                target?.click();
+            },
+            Tab: () => {
+                const anchors = getSelectableAnchors();
+                if (document.activeElement === anchors[anchors.length - 1])
+                    listeners.current.onPressLastTab?.();
+                else
+                    handleArrows('ArrowDown');
+                event.preventDefault();
+            },
+            ArrowUp: handleArrows,
+            ArrowDown: handleArrows,
+        };
+        handlers[event.key]?.();
+    }, []);
+    const attachKeyboardListeners = useCallback(() => {
+        document.addEventListener('keydown', keyboardControls);
+    }, []);
+    const detachKeyboardListeners = useCallback(() => {
+        document.removeEventListener('keydown', keyboardControls);
+    }, []);
+    return { keyboardControlledElement, attachKeyboardListeners, detachKeyboardListeners };
+}
+//# sourceMappingURL=keyboard.js.map

package/dist/hooks/keyboard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyboard.js","sourceRoot":"","sources":["../../src/hooks/keyboard.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,OAAO,CAAA;AAkB3C;;;;;;;;;GASG;AACH,MAAM,UAAU,mBAAmB,CAAC,EAAE,cAAc,EAAE,aAAa,EAAE,cAAc,GAAG,aAAa,EAAS;IAC1G,MAAM,yBAAyB,GAAG,MAAM,CAAiB,IAAI,CAAC,CAAA;IAC9D,MAAM,SAAS,GAAG,MAAM,CAAkD,EAAE,CAAC,CAAA;IAC7E,SAAS,CAAC,OAAO,GAAG,EAAE,aAAa,EAAE,cAAc,EAAE,CAAA;IAErD,MAAM,gBAAgB,GAAG,WAAW,CAAC,CAAC,KAAoB,EAAE,EAAE;QAC5D,MAAM,MAAM,GAAG,KAAK,EAAE,MAA4B,CAAA;QAElD,SAAS,oBAAoB;YAC3B,OAAO,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC,cAAc,CAAC,IAAI,EAAE,CAAA;QAClF,CAAC;QAED,SAAS,YAAY,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG;YACnC,MAAM,OAAO,GAAG,oBAAoB,EAAE,CAAA;YACtC,IAAI,CAAC,GAAG,CAAC,CAAA;YACT,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,IAAI,QAAQ,CAAC,aAAa,KAAK,OAAO,CAAC,CAAC,CAAC;gBAAE,CAAC,EAAE,CAAA;YACvE,MAAM,IAAI,GAAQ,GAAG,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAA;YACxH,IAAI,EAAE,KAAK,EAAE,EAAE,CAAA;QACjB,CAAC;QAED,MAAM,QAAQ,GAA6C;YACzD,MAAM,EAAE,GAAG,EAAE;gBACX,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAA;gBACnC,KAAK,CAAC,eAAe,EAAE,CAAA;gBACvB,KAAK,CAAC,cAAc,EAAE,CAAA;YACxB,CAAC;YACD,KAAK,EAAE,GAAG,EAAE;gBACV,MAAM,EAAE,KAAK,EAAE,CAAA;YACjB,CAAC;YACD,GAAG,EAAE,GAAG,EAAE;gBACR,MAAM,OAAO,GAAG,oBAAoB,EAAE,CAAA;gBACtC,IAAI,QAAQ,CAAC,aAAa,KAAK,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;oBAAE,SAAS,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAA;;oBAC1F,YAAY,CAAC,WAAW,CAAC,CAAA;gBAC/B,KAAK,CAAC,cAAc,EAAE,CAAA;YACxB,CAAC;YACD,OAAO,EAAE,YAAY;YACrB,SAAS,EAAE,YAAY;SACxB,CAAA;QAED,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,CAAA;IACzB,CAAC,EAAE,EAAE,CAAC,CAAA;IAEN,MAAM,uBAAuB,GAAG,WAAW,CAAC,GAAG,EAAE;QAC/C,QAAQ,CAAC,gBAAgB,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAA;IACxD,CAAC,EAAE,EAAE,CAAC,CAAA;IAEN,MAAM,uBAAuB,GAAG,WAAW,CAAC,GAAG,EAAE;QAC/C,QAAQ,CAAC,mBAAmB,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAA;IAC3D,CAAC,EAAE,EAAE,CAAC,CAAA;IAEN,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,CAAA;AACxF,CAAC"}

package/dist/hooks/service-now.d.ts

@@ -1,10 +1,39 @@
 interface Options {
+    /**
+     * Function to run when the chat button is hidden, i.e. when the user clicks the close button that appears when the chat button is
+     * hovered.
+     */
     onClose?: () => void;
 }
+/**
+ * @returns the iframe loaded by service now, i.e. the chat window; or null if the chat window doesn't exist.
+ */
 export declare function getServiceNowLauncher(): HTMLElement | null;
+/**
+ * Opens the chat window and makes the chat button visible.
+ */
 export declare function openServiceNowChat(): void;
-export declare function addOrRemoveServiceNowLauncher(action: string): void;
+/**
+ * Shows the chat window, i.e. shows the service now iframe and switch the icon in the chat button to "close".
+ */
+export declare function showChatWindow(): void;
+/**
+ * Hides the chat window, i.e. hides the service now iframe and switch the icon in the chat button to "chat".
+ */
+export declare function hideChatWindow(): void;
+/**
+ * A react hook that indicates whether the chat button is visible or not. This is updated whenever the value changes.
+ * @returns true if the chat button is visible and false otherwise.
+ */
 export declare function useServiceNowChatButtonVisibility(): boolean;
+/**
+ * Starts Service Now:
+ *
+ * - Creates the chat window feature by loading the required script.
+ * - Adds a "minimize" button on top of the chat button (left bottom corner). This button appears whenever the user hovers the chat button.
+ * If clicked, the chat button is hidden.
+ * @param options
+ */
 export declare function useServiceNowEffect(options?: Options): void;
 export declare const dictionary: {
     en: {

package/dist/hooks/service-now.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service-now.d.ts","sourceRoot":"","sources":["../../src/hooks/service-now.tsx"],"names":[],"mappings":"AAwCA,UAAU,OAAO;IACf,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB;AAuBD,wBAAgB,qBAAqB,uBAEpC;AAED,wBAAgB,kBAAkB,SAIjC;AAaD,wBAAgB,6BAA6B,CAAC,MAAM,EAAE,MAAM,QAU3D;AAkED,wBAAgB,iCAAiC,YAIhD;AAED,wBAAgB,mBAAmB,CAAC,OAAO,CAAC,EAAE,OAAO,QAIpD;AAED,eAAO,MAAM,UAAU;;;;;;;;;;;;;CAaD,CAAA"}
+{"version":3,"file":"service-now.d.ts","sourceRoot":"","sources":["../../src/hooks/service-now.tsx"],"names":[],"mappings":"AA2CA,UAAU,OAAO;IACf;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB;AAuBD;;GAEG;AACH,wBAAgB,qBAAqB,uBAEpC;AAED;;GAEG;AACH,wBAAgB,kBAAkB,SAIjC;AAuBD;;GAEG;AACH,wBAAgB,cAAc,SAE7B;AAED;;GAEG;AACH,wBAAgB,cAAc,SAE7B;AAyED;;;GAGG;AACH,wBAAgB,iCAAiC,YAIhD;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,CAAC,EAAE,OAAO,QAIpD;AAED,eAAO,MAAM,UAAU;;;;;;;;;;;;;CAaD,CAAA"}