@atlaskit/contextual-survey 2.0.11

package/dist/esm/constants.js

@@ -0,0 +1,4 @@
+import { gridSize } from '@atlaskit/theme/constants';
+export var surveyInnerWidth = gridSize() * 55; // 440
+
+export var surveyOffset = gridSize() * 6; // 48

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export { default as ContextualSurvey, DismissTrigger } from './components/ContextualSurvey';
+export { default as SurveyMarshal } from './components/SurveyMarshal';

package/dist/esm/types.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/version.json

@@ -0,0 +1,5 @@
+{
+	"name": "@atlaskit/contextual-survey",
+	"version": "2.0.11",
+	"sideEffects": false
+}

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

@@ -0,0 +1,39 @@
+import { FormValues } from '../types';
+export declare enum DismissTrigger {
+    AutoDismiss = "AUTO_DISMISS",
+    Manual = "MANUAL",
+    Finished = "FINISHED",
+    Unmount = "UNMOUNT"
+}
+export declare 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) => JSX.Element;
+export default _default;

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

@@ -0,0 +1,2 @@
+declare const _default: () => JSX.Element;
+export default _default;

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

@@ -0,0 +1,6 @@
+interface Props {
+    onChange: (value: number) => void;
+    value: number | undefined;
+}
+declare const _default: ({ onChange, value }: Props) => JSX.Element;
+export default _default;

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

@@ -0,0 +1,5 @@
+interface Props {
+    onAnswer: (answer: boolean) => Promise<void>;
+}
+declare const _default: ({ onAnswer }: Props) => JSX.Element;
+export default _default;

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

@@ -0,0 +1,4 @@
+interface Props {
+}
+declare const _default: ({}: Props) => JSX.Element;
+export default _default;

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

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

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

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

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

@@ -0,0 +1,11 @@
+import { OnSubmitHandler } from '@atlaskit/form';
+import { 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/components/SurveyMarshal.d.ts

@@ -0,0 +1,13 @@
+/** @jsx jsx */
+import { ReactNode } from 'react';
+declare 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/components/useEscapeToDismiss.d.ts

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

package/dist/types/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const surveyInnerWidth: number;
+export declare const surveyOffset: number;

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export { default as ContextualSurvey, DismissTrigger, } from './components/ContextualSurvey';
+export type { OnDismissArgs } from './components/ContextualSurvey';
+export { default as SurveyMarshal } from './components/SurveyMarshal';

package/dist/types/types.d.ts

@@ -0,0 +1,5 @@
+export declare type FormValues = {
+    feedbackScore: number;
+    canContact: boolean;
+    writtenFeedback: string;
+};

package/docs/0-intro.tsx

@@ -0,0 +1,115 @@
+import React from 'react';
+
+import {
+  AtlassianInternalWarning,
+  code,
+  DevPreviewWarning,
+  Example,
+  md,
+  Props,
+} from '@atlaskit/docs';
+
+const BasicExample = require('../examples/00-usage').default;
+
+export default md`
+  ${(
+    <>
+      <div style={{ marginBottom: '0.5rem' }}>
+        <AtlassianInternalWarning />
+      </div>
+      <div style={{ marginTop: '0.5rem' }}>
+        <DevPreviewWarning />
+      </div>
+    </>
+  )}
+
+  This component is used to ask for feedback from the user, without affecting their usage of the page. It is styled similar to a \`flag\`.
+
+  The user flow for this component is:
+
+  #### Phase 1: Feedback
+
+  - Choosing a feedback score
+  - **(Optional)** Writing extra feedback in a \`textarea\`
+  - **(Optional)** User selects if they can be contacted about their feedback.
+  This is automatically set to \`true\` on the first change event for the \`textarea\`. It is set to \`false\` by default.
+
+  #### Phase 2 (Optional): Atlassian Research Signup
+
+  This phase will be entered when:
+
+  1. The user has selected they want to be contacted about their feedback
+  2. \`getUserHasAnsweredMailingList()\` has resolved to \`false\`
+
+  If this phase is not entered then a thank you message is displayed.
+
+  In this phase a prompt is opened which asks the user if they want to join the **Atlassian Research Group**.
+
+  After \`onMailingListAnswer()\` has resolved:
+
+  - If the user selected **yes** a thank you message is displayed
+  - If the user selected **no** the survey is closed.
+
+  #### Dismissing
+
+  \`onDismiss\` will be called when the survey is finished. This can happen when:
+
+  - The user explicitly closes the survey
+  - The user finishes the survey. The survey will be auto dismissed after a small delay
+  - The \`<SurveyComponent/>\` is unmounted
+
+  \`onDismiss\` will only ever be called once
+
+  \`onDismiss\` is called with arguments: \`{ trigger: DismissTrigger }\`. This can be used to distinguish between different rationales for dismissing
+
+  ${code`
+  // Types
+
+  export enum DismissTrigger {
+    AutoDismiss = 'AUTO_DISMISS',
+    Manual = 'MANUAL',
+    Finished = 'FINISHED',
+    Unmount = 'UNMOUNT',
+  }
+
+  export type OnDismissArgs = { trigger: DismissTrigger };
+
+  onDismiss: (args: OnDismissArgs) => void;
+
+  // These types are exported publicly for you to use
+
+  import {DismissTrigger, OnDismissArgs} from '@atlaskit/contextual-survey';
+  `}
+
+  #### Responsibilities
+
+  - \`<SurveyMarshal/>\`: Responsible for placement and animation for the survey.
+  - \`<ContextualSurvey/>\`: Renders the survey questions
+
+  ## Usage
+
+  ${code`import { ContextualSurvey, SurveyMarshal } from '@atlaskit/avatar';`}
+
+  ${(
+    <Example
+      packageName="@atlaskit/contextual-survey"
+      Component={() => <BasicExample height="500px" />}
+      title="Basic example"
+      source={require('!!raw-loader!../examples/00-usage')}
+    />
+  )}
+
+  ${(
+    <Props
+      heading="Contextual Survey Props"
+      props={require('!!extract-react-types-loader!../src/components/ContextualSurvey')}
+    />
+  )}
+
+${(
+  <Props
+    heading="Survey Marshal Props"
+    props={require('!!extract-react-types-loader!../src/components/SurveyMarshal')}
+  />
+)}
+`;

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@atlaskit/contextual-survey",
+  "version": "2.0.11",
+  "description": "A React component used to ask the user for feedback",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+  "author": "Atlassian Pty Ltd",
+  "license": "Apache-2.0",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "module:es2019": "dist/es2019/index.js",
+  "types": "dist/types/index.d.ts",
+  "sideEffects": false,
+  "atlaskit:src": "src/index.ts",
+  "atlassian": {
+    "team": "Personalization",
+    "deprecatedAutoEntryPoints": true,
+    "releaseModel": "continuous",
+    "website": {
+      "name": "Contextual Survey"
+    }
+  },
+  "dependencies": {
+    "@atlaskit/button": "^16.0.0",
+    "@atlaskit/checkbox": "^12.1.0",
+    "@atlaskit/form": "^8.4.0",
+    "@atlaskit/icon": "^21.9.0",
+    "@atlaskit/textarea": "^4.0.0",
+    "@atlaskit/theme": "^12.0.0",
+    "@atlaskit/tooltip": "^17.5.0",
+    "@babel/runtime": "^7.0.0",
+    "@emotion/core": "^10.0.9",
+    "react-transition-group": "^4.4.1"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0"
+  },
+  "devDependencies": {
+    "@atlaskit/checkbox": "^12.1.0",
+    "@atlaskit/docs": "*",
+    "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
+    "@testing-library/react": "^8.0.1",
+    "typescript": "3.9.6"
+  },
+  "keywords": [
+    "atlaskit",
+    "react",
+    "ui"
+  ],
+  "techstack": {
+    "@atlassian/frontend": {
+      "import-structure": "atlassian-conventions"
+    }
+  },
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../../../tsconfig.json",
+  "include": [
+    "./src/**/*.ts",
+    "./src/**/*.tsx",
+    "./docs/**/*.ts",
+    "./docs/**/*.tsx",
+    "./examples/**/*.ts",
+    "./examples/**/*.tsx",
+    "./example-helpers/**/*.ts",
+    "./example-helpers/**/*.tsx"
+  ],
+  "compilerOptions": {
+    "baseUrl": "./"
+  }
+}

package/types/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@atlaskit/contextual-survey/types",
+  "main": "../dist/cjs/types.js",
+  "module": "../dist/esm/types.js",
+  "module:es2019": "../dist/es2019/types.js",
+  "types": "../dist/types/types.d.ts"
+}