@atlaskit/contextual-survey 3.1.2 → 4.0.0

package/dist/esm/compiled/SurveyForm.js

@@ -1,131 +0,0 @@
-/* SurveyForm.tsx generated by @compiled/babel-plugin v0.36.1 */
-import _extends from "@babel/runtime/helpers/extends";
-import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
-import "./SurveyForm.compiled.css";
-import * as React from 'react';
-import { ax, ix } from "@compiled/react/runtime";
-import { useCallback, useRef, useState } from 'react';
-import { Transition } from 'react-transition-group';
-import Button from '@atlaskit/button/new';
-import { Checkbox } from '@atlaskit/checkbox';
-import Form, { CheckboxField, Field, FormFooter } from '@atlaskit/form';
-import Heading from '@atlaskit/heading';
-import { Stack, Text } from '@atlaskit/primitives/compiled';
-import Textarea from '@atlaskit/textarea';
-import FeedbackScoreButtons from './FeedbackScoreButtons';
-var transitionBaseStyles = null;
-var getExpandedHeight = function getExpandedHeight(ref, state) {
-  if (!ref.current) {
-    return '0';
-  }
-  switch (state) {
-    case 'entering':
-      return "".concat(ref.current.scrollHeight, "px");
-    case 'entered':
-      // needed for TextField auto height expand
-      return "none";
-    default:
-      return '0';
-  }
-};
-var transitionDuration = 200;
-export default (function (_ref) {
-  var question = _ref.question,
-    statement = _ref.statement,
-    textPlaceholder = _ref.textPlaceholder,
-    textLabel = _ref.textLabel,
-    onSubmit = _ref.onSubmit;
-  var _useState = useState(false),
-    _useState2 = _slicedToArray(_useState, 2),
-    expanded = _useState2[0],
-    setExpanded = _useState2[1];
-  var _useState3 = useState(false),
-    _useState4 = _slicedToArray(_useState3, 2),
-    canContactDefault = _useState4[0],
-    setCanContactDefault = _useState4[1];
-  var hasAutoFilledCanContactRef = useRef(false);
-  var expandedAreaRef = useRef(null);
-  var onScoreSelect = useCallback(function () {
-    setExpanded(true);
-  }, [setExpanded]);
-
-  // On the first type the user types some feedback we auto select
-  // the option for allowing feedback. This automatic selection only
-  // happens once. After that it is up to the user to control
-  var onFeedbackChange = useCallback(function () {
-    if (hasAutoFilledCanContactRef.current) {
-      return;
-    }
-    hasAutoFilledCanContactRef.current = true;
-    setCanContactDefault(true);
-  }, []);
-  return /*#__PURE__*/React.createElement("section", {
-    "aria-labelledby": "contextualSurveyQuestion"
-  }, /*#__PURE__*/React.createElement(Stack, {
-    space: "space.150"
-  }, /*#__PURE__*/React.createElement(Heading, {
-    id: "contextualSurveyQuestion",
-    size: "xsmall"
-  }, question), statement && /*#__PURE__*/React.createElement(Text, {
-    as: "p",
-    id: "contextualSurveyStatement"
-  }, statement)), /*#__PURE__*/React.createElement(Form, {
-    onSubmit: onSubmit
-  }, function (_ref2) {
-    var formProps = _ref2.formProps,
-      submitting = _ref2.submitting;
-    return /*#__PURE__*/React.createElement("form", formProps, /*#__PURE__*/React.createElement(Field, {
-      name: "feedbackScore",
-      isDisabled: submitting,
-      isRequired: true
-    }, function (_ref3) {
-      var fieldProps = _ref3.fieldProps;
-      return /*#__PURE__*/React.createElement(FeedbackScoreButtons, _extends({}, fieldProps, {
-        onChange: function onChange(score) {
-          fieldProps.onChange(score);
-          onScoreSelect();
-        }
-      }));
-    }), /*#__PURE__*/React.createElement(Transition, {
-      in: expanded,
-      timeout: transitionDuration,
-      mountOnEnter: true
-    }, function (state) {
-      return /*#__PURE__*/React.createElement("div", {
-        style: {
-          transition: "max-height ".concat(transitionDuration, "ms ease-in-out"),
-          maxHeight: getExpandedHeight(expandedAreaRef, state)
-        },
-        ref: expandedAreaRef,
-        className: ax(["_1reo15vq _18m915vq"])
-      }, /*#__PURE__*/React.createElement(Field, {
-        name: "writtenFeedback",
-        defaultValue: "",
-        isDisabled: submitting
-      }, function (_ref4) {
-        var fieldProps = _ref4.fieldProps;
-        return /*#__PURE__*/React.createElement(Textarea, _extends({}, fieldProps, {
-          "aria-label": textLabel,
-          placeholder: textPlaceholder,
-          onChange: function onChange(event) {
-            fieldProps.onChange(event);
-            onFeedbackChange();
-          }
-        }));
-      }), /*#__PURE__*/React.createElement(CheckboxField, {
-        name: "canContact",
-        isDisabled: submitting,
-        defaultIsChecked: canContactDefault
-      }, function (_ref5) {
-        var fieldProps = _ref5.fieldProps;
-        return /*#__PURE__*/React.createElement(Checkbox, _extends({}, fieldProps, {
-          label: "Atlassian can contact me about this feedback"
-        }));
-      }), /*#__PURE__*/React.createElement(FormFooter, null, /*#__PURE__*/React.createElement(Button, {
-        type: "submit",
-        appearance: "primary",
-        isLoading: submitting
-      }, "Submit")));
-    }));
-  }));
-});

package/dist/esm/compiled/SurveyMarshal.js

@@ -1,54 +0,0 @@
-/* SurveyMarshal.tsx generated by @compiled/babel-plugin v0.36.1 */
-import "./SurveyMarshal.compiled.css";
-import * as React from 'react';
-import { ax, ix } from "@compiled/react/runtime";
-import { Transition } from 'react-transition-group';
-import { layers } from '@atlaskit/theme/constants';
-import { surveyInnerWidth, surveyOffset } from '../constants';
-var animationDuration = 300;
-var offscreen = {
-  translateX: "".concat(surveyInnerWidth + surveyOffset, "px"),
-  opacity: '0'
-};
-var getAnimationProps = function getAnimationProps(state) {
-  switch (state) {
-    case 'entered':
-      {
-        return {
-          translateX: '0',
-          opacity: '1'
-        };
-      }
-    case 'entering':
-    case 'unmounted':
-    case 'exited':
-    case 'exiting':
-      {
-        return offscreen;
-      }
-  }
-};
-var transitionBaseStyles = null;
-export default function SurveyMarshal(props) {
-  var children = props.children,
-    shouldShow = props.shouldShow;
-  return /*#__PURE__*/React.createElement(Transition, {
-    in: shouldShow,
-    timeout: animationDuration,
-    unmountOnExit: true
-  }, function (state) {
-    var _getAnimationProps = getAnimationProps(state),
-      translateX = _getAnimationProps.translateX,
-      opacity = _getAnimationProps.opacity;
-    return /*#__PURE__*/React.createElement("div", {
-      className: ax(["_kqsw1n9t _1xi28err _94n58err _k8m01rjc"]),
-      style: {
-        opacity: opacity,
-        transition: "all ".concat(animationDuration, "ms ease-in-out"),
-        zIndex: layers.flag(),
-        transform: "translateX(".concat(translateX, ")"),
-        "--_1hx5ohh": ix("".concat(surveyOffset, "px"))
-      }
-    }, children());
-  });
-}

package/dist/esm/compiled/useEscapeToDismiss.js

@@ -1,64 +0,0 @@
-import { useEffect, useRef } from 'react';
-export var escape = 27;
-function bind(target, eventName, handler, options) {
-  target.addEventListener(eventName, handler, options);
-  return function unbind() {
-    target.removeEventListener(eventName, handler, options);
-  };
-}
-function shouldDismiss(target) {
-  if (!target) {
-    return true;
-  }
-  if (!(target instanceof HTMLElement)) {
-    return true;
-  }
-
-  // Closest doesn't exist for ie11
-  // Because we cannot be sure if in a text area - just don't allow dismissing
-  if (!target.closest) {
-    return false;
-  }
-  var inTextArea = Boolean(target.closest('textarea'));
-
-  // Allow dismissing if not in a textarea
-  return !inTextArea;
-}
-export default function useEscapeToDismiss(_ref) {
-  var onDismiss = _ref.onDismiss;
-  var onDismissRef = useRef(onDismiss);
-
-  // Defensively accounting for consumer passing in a new function
-  // each time. We just want to call the latest one
-  useEffect(function () {
-    onDismissRef.current = onDismiss;
-  }, [onDismiss]);
-  useEffect(function () {
-    var unbind;
-    function onKeyDown(event) {
-      if (event.keyCode !== escape) {
-        return;
-      }
-
-      // Escape pressed
-
-      // We don't want to close if the user is typing in the text area
-      if (!shouldDismiss(event.target)) {
-        return;
-      }
-      if (unbind) {
-        // only want to call dismiss once
-        unbind();
-      }
-      onDismissRef.current();
-    }
-    unbind = bind(window, 'keydown',
-    // @ts-ignore: the typescript for this is lame
-    onKeyDown, {
-      passive: true
-    });
-
-    // double calls to unbind is fine
-    return unbind;
-  }, []);
-}

package/dist/esm/fg-components.js

@@ -1,19 +0,0 @@
-import React from 'react';
-import { fg } from '@atlaskit/platform-feature-flags';
-import { default as CompiledContextualSurvey } from './compiled/ContextualSurvey';
-import { default as CompiledSurveyMarshal } from './compiled/SurveyMarshal';
-// exported props for FG check
-import { default as EmotionContextualSurvey } from './components/ContextualSurvey';
-import { default as EmotionSurveyMarshal } from './components/SurveyMarshal';
-export var ContextualSurvey = function ContextualSurvey(props) {
-  return (
-    // eslint-disable-next-line @repo/internal/react/no-unsafe-spread-props
-    fg('platform_contextual_survey_enable_compiled_fg') ? /*#__PURE__*/React.createElement(CompiledContextualSurvey, props) : /*#__PURE__*/React.createElement(EmotionContextualSurvey, props)
-  );
-};
-export var SurveyMarshal = function SurveyMarshal(props) {
-  return (
-    // eslint-disable-next-line @repo/internal/react/no-unsafe-spread-props
-    fg('platform_contextual_survey_enable_compiled_fg') ? /*#__PURE__*/React.createElement(CompiledSurveyMarshal, props) : /*#__PURE__*/React.createElement(EmotionSurveyMarshal, props)
-  );
-};

package/dist/types/compiled/ContextualSurvey.d.ts

@@ -1,40 +0,0 @@
-import React from 'react';
-import { type FormValues } from '../types';
-export declare enum DismissTrigger {
-    AutoDismiss = "AUTO_DISMISS",
-    Manual = "MANUAL",
-    Finished = "FINISHED",
-    Unmount = "UNMOUNT"
-}
-export type OnDismissArgs = {
-    trigger: DismissTrigger;
-};
-interface Props {
-    /** Optional statement, to be used in conjunction with the question for the survey
-     * Example: "How strongly do you agree or disagree with this statement"
-     */
-    statement?: string;
-    /** Question used for the survey
-     * Example: "It is easy to find what I am looking for in Jira"
-     */
-    question: string;
-    /** Accessible label text for the survey text area */
-    textLabel?: string;
-    /** Text placeholder for the survey text area
-     * Example: "Tell us why"
-     */
-    textPlaceholder?: string;
-    /** Callback that is triggered when the survey should be dismissed */
-    onDismiss: (args: OnDismissArgs) => void;
-    /** Gets whether user has already signed up to the Atlassian Research Group list.
-     * If `true` is returned then the user will not be prompted to sign up to the Research Group.
-     */
-    getUserHasAnsweredMailingList: () => Promise<boolean>;
-    /** Callback that is triggered when the survey is submitted, it will get the survey data as a parameter */
-    onSubmit: (formValues: FormValues) => Promise<void>;
-    /** Callback that is triggered when the user clicks 'Yes' or 'No' to sign up to the Atlassian Research Group */
-    onMailingListAnswer: (answer: boolean) => Promise<void>;
-}
-export declare const AUTO_DISAPPEAR_DURATION: number;
-declare const _default: ({ question, statement, onDismiss, onSubmit, onMailingListAnswer, getUserHasAnsweredMailingList, textLabel, textPlaceholder, }: Props) => React.JSX.Element;
-export default _default;

package/dist/types/compiled/FeedbackAcknowledgement.d.ts

@@ -1,3 +0,0 @@
-import React from 'react';
-declare const _default: () => React.JSX.Element;
-export default _default;

package/dist/types/compiled/FeedbackScoreButtons.d.ts

@@ -1,11 +0,0 @@
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-/// <reference types="react" />
-interface Props {
-    onChange: (value: number) => void;
-    value: number | undefined;
-}
-declare const _default: ({ onChange, value }: Props) => JSX.Element;
-export default _default;

package/dist/types/compiled/SignUpPrompt.d.ts

@@ -1,10 +0,0 @@
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-/// <reference types="react" />
-interface Props {
-    onAnswer: (answer: boolean) => Promise<void>;
-}
-declare const _default: ({ onAnswer }: Props) => JSX.Element;
-export default _default;

package/dist/types/compiled/SignUpSuccess.d.ts

@@ -1,5 +0,0 @@
-import React from 'react';
-interface Props {
-}
-declare const _default: ({}: Props) => React.JSX.Element;
-export default _default;

package/dist/types/compiled/SuccessContainer.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="react" />
-interface Props {
-    children: React.ReactNode;
-}
-declare const _default: ({ children }: Props) => JSX.Element;
-export default _default;

package/dist/types/compiled/SurveyContainer.d.ts

@@ -1,11 +0,0 @@
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-/// <reference types="react" />
-interface Props {
-    children: React.ReactNode;
-    onDismiss: () => void;
-}
-declare const _default: ({ children, onDismiss }: Props) => JSX.Element;
-export default _default;

package/dist/types/compiled/SurveyForm.d.ts

@@ -1,12 +0,0 @@
-/// <reference types="react" />
-import { type OnSubmitHandler } from '@atlaskit/form';
-import { type FormValues } from '../types';
-interface Props {
-    question: string;
-    statement?: string;
-    textPlaceholder: string;
-    textLabel: string;
-    onSubmit: OnSubmitHandler<FormValues>;
-}
-declare const _default: ({ question, statement, textPlaceholder, textLabel, onSubmit }: Props) => JSX.Element;
-export default _default;

package/dist/types/compiled/SurveyMarshal.d.ts

@@ -1,16 +0,0 @@
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-import { type ReactNode } from 'react';
-type Props = {
-    /** Whether the form should be rendered */
-    shouldShow: boolean;
-    /** A function that returns Node to be rendered (`<ContextualSurvey/>`)
-     * Using a function as child so that the child node does
-     * not need to be evaluated if it is not mounted
-     */
-    children: () => ReactNode;
-};
-export default function SurveyMarshal(props: Props): JSX.Element;
-export {};

package/dist/types/compiled/useEscapeToDismiss.d.ts

@@ -1,6 +0,0 @@
-export declare const escape: number;
-type Args = {
-    onDismiss: () => void;
-};
-export default function useEscapeToDismiss({ onDismiss }: Args): void;
-export {};

package/dist/types/fg-components.d.ts

@@ -1,5 +0,0 @@
-import React from 'react';
-import { type Props as ContextualSurveyProps } from './components/ContextualSurvey';
-import { type Props as SurveyMarshalProps } from './components/SurveyMarshal';
-export declare const ContextualSurvey: (props: ContextualSurveyProps) => React.JSX.Element;
-export declare const SurveyMarshal: (props: SurveyMarshalProps) => React.JSX.Element;

package/dist/types-ts4.5/compiled/ContextualSurvey.d.ts

@@ -1,40 +0,0 @@
-import React from 'react';
-import { type FormValues } from '../types';
-export declare enum DismissTrigger {
-    AutoDismiss = "AUTO_DISMISS",
-    Manual = "MANUAL",
-    Finished = "FINISHED",
-    Unmount = "UNMOUNT"
-}
-export type OnDismissArgs = {
-    trigger: DismissTrigger;
-};
-interface Props {
-    /** Optional statement, to be used in conjunction with the question for the survey
-     * Example: "How strongly do you agree or disagree with this statement"
-     */
-    statement?: string;
-    /** Question used for the survey
-     * Example: "It is easy to find what I am looking for in Jira"
-     */
-    question: string;
-    /** Accessible label text for the survey text area */
-    textLabel?: string;
-    /** Text placeholder for the survey text area
-     * Example: "Tell us why"
-     */
-    textPlaceholder?: string;
-    /** Callback that is triggered when the survey should be dismissed */
-    onDismiss: (args: OnDismissArgs) => void;
-    /** Gets whether user has already signed up to the Atlassian Research Group list.
-     * If `true` is returned then the user will not be prompted to sign up to the Research Group.
-     */
-    getUserHasAnsweredMailingList: () => Promise<boolean>;
-    /** Callback that is triggered when the survey is submitted, it will get the survey data as a parameter */
-    onSubmit: (formValues: FormValues) => Promise<void>;
-    /** Callback that is triggered when the user clicks 'Yes' or 'No' to sign up to the Atlassian Research Group */
-    onMailingListAnswer: (answer: boolean) => Promise<void>;
-}
-export declare const AUTO_DISAPPEAR_DURATION: number;
-declare const _default: ({ question, statement, onDismiss, onSubmit, onMailingListAnswer, getUserHasAnsweredMailingList, textLabel, textPlaceholder, }: Props) => React.JSX.Element;
-export default _default;

package/dist/types-ts4.5/compiled/FeedbackAcknowledgement.d.ts

@@ -1,3 +0,0 @@
-import React from 'react';
-declare const _default: () => React.JSX.Element;
-export default _default;

package/dist/types-ts4.5/compiled/FeedbackScoreButtons.d.ts

@@ -1,11 +0,0 @@
-/// <reference types="react" />
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-interface Props {
-    onChange: (value: number) => void;
-    value: number | undefined;
-}
-declare const _default: ({ onChange, value }: Props) => JSX.Element;
-export default _default;

package/dist/types-ts4.5/compiled/SignUpPrompt.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="react" />
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-interface Props {
-    onAnswer: (answer: boolean) => Promise<void>;
-}
-declare const _default: ({ onAnswer }: Props) => JSX.Element;
-export default _default;

package/dist/types-ts4.5/compiled/SignUpSuccess.d.ts

@@ -1,5 +0,0 @@
-import React from 'react';
-interface Props {
-}
-declare const _default: ({}: Props) => React.JSX.Element;
-export default _default;

package/dist/types-ts4.5/compiled/SuccessContainer.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="react" />
-interface Props {
-    children: React.ReactNode;
-}
-declare const _default: ({ children }: Props) => JSX.Element;
-export default _default;

package/dist/types-ts4.5/compiled/SurveyContainer.d.ts

@@ -1,11 +0,0 @@
-/// <reference types="react" />
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-interface Props {
-    children: React.ReactNode;
-    onDismiss: () => void;
-}
-declare const _default: ({ children, onDismiss }: Props) => JSX.Element;
-export default _default;

package/dist/types-ts4.5/compiled/SurveyForm.d.ts

@@ -1,12 +0,0 @@
-/// <reference types="react" />
-import { type OnSubmitHandler } from '@atlaskit/form';
-import { type FormValues } from '../types';
-interface Props {
-    question: string;
-    statement?: string;
-    textPlaceholder: string;
-    textLabel: string;
-    onSubmit: OnSubmitHandler<FormValues>;
-}
-declare const _default: ({ question, statement, textPlaceholder, textLabel, onSubmit }: Props) => JSX.Element;
-export default _default;

package/dist/types-ts4.5/compiled/SurveyMarshal.d.ts

@@ -1,16 +0,0 @@
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-import { type ReactNode } from 'react';
-type Props = {
-    /** Whether the form should be rendered */
-    shouldShow: boolean;
-    /** A function that returns Node to be rendered (`<ContextualSurvey/>`)
-     * Using a function as child so that the child node does
-     * not need to be evaluated if it is not mounted
-     */
-    children: () => ReactNode;
-};
-export default function SurveyMarshal(props: Props): JSX.Element;
-export {};

package/dist/types-ts4.5/compiled/useEscapeToDismiss.d.ts

@@ -1,6 +0,0 @@
-export declare const escape: number;
-type Args = {
-    onDismiss: () => void;
-};
-export default function useEscapeToDismiss({ onDismiss }: Args): void;
-export {};

package/dist/types-ts4.5/fg-components.d.ts

@@ -1,5 +0,0 @@
-import React from 'react';
-import { type Props as ContextualSurveyProps } from './components/ContextualSurvey';
-import { type Props as SurveyMarshalProps } from './components/SurveyMarshal';
-export declare const ContextualSurvey: (props: ContextualSurveyProps) => React.JSX.Element;
-export declare const SurveyMarshal: (props: SurveyMarshalProps) => React.JSX.Element;