@atlaskit/contextual-survey 2.1.4 → 2.1.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/constants/package.json +8 -1
- package/dist/cjs/version.json +1 -1
- package/dist/es2019/version.json +1 -1
- package/dist/esm/version.json +1 -1
- package/package.json +12 -12
- package/report.api.md +39 -38
- package/tmp/api-report-tmp.d.ts +61 -0
- package/types/package.json +8 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @atlaskit/contextual-survey
|
|
2
2
|
|
|
3
|
+
## 2.1.6
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
|
|
9
|
+
## 2.1.5
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
|
|
14
|
+
|
|
3
15
|
## 2.1.4
|
|
4
16
|
|
|
5
17
|
### Patch Changes
|
package/constants/package.json
CHANGED
|
@@ -4,5 +4,12 @@
|
|
|
4
4
|
"module": "../dist/esm/constants.js",
|
|
5
5
|
"module:es2019": "../dist/es2019/constants.js",
|
|
6
6
|
"sideEffects": false,
|
|
7
|
-
"types": "../dist/types/constants.d.ts"
|
|
7
|
+
"types": "../dist/types/constants.d.ts",
|
|
8
|
+
"typesVersions": {
|
|
9
|
+
">=4.0 <4.5": {
|
|
10
|
+
"*": [
|
|
11
|
+
"../dist/types-ts4.0/constants.d.ts"
|
|
12
|
+
]
|
|
13
|
+
}
|
|
14
|
+
}
|
|
8
15
|
}
|
package/dist/cjs/version.json
CHANGED
package/dist/es2019/version.json
CHANGED
package/dist/esm/version.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/contextual-survey",
|
|
3
|
-
"version": "2.1.
|
|
3
|
+
"version": "2.1.6",
|
|
4
4
|
"description": "A React component used to ask the user for feedback",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -23,14 +23,14 @@
|
|
|
23
23
|
}
|
|
24
24
|
},
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@atlaskit/button": "^16.
|
|
27
|
-
"@atlaskit/checkbox": "^12.
|
|
28
|
-
"@atlaskit/form": "^8.
|
|
29
|
-
"@atlaskit/icon": "^21.
|
|
30
|
-
"@atlaskit/textarea": "^4.
|
|
31
|
-
"@atlaskit/theme": "^12.
|
|
32
|
-
"@atlaskit/tokens": "^0.
|
|
33
|
-
"@atlaskit/tooltip": "^17.
|
|
26
|
+
"@atlaskit/button": "^16.4.0",
|
|
27
|
+
"@atlaskit/checkbox": "^12.4.0",
|
|
28
|
+
"@atlaskit/form": "^8.7.0",
|
|
29
|
+
"@atlaskit/icon": "^21.11.0",
|
|
30
|
+
"@atlaskit/textarea": "^4.5.0",
|
|
31
|
+
"@atlaskit/theme": "^12.2.0",
|
|
32
|
+
"@atlaskit/tokens": "^0.11.0",
|
|
33
|
+
"@atlaskit/tooltip": "^17.6.0",
|
|
34
34
|
"@babel/runtime": "^7.0.0",
|
|
35
35
|
"@emotion/core": "^10.0.9",
|
|
36
36
|
"react-transition-group": "^4.4.1"
|
|
@@ -39,11 +39,11 @@
|
|
|
39
39
|
"react": "^16.8.0"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
|
-
"@atlaskit/checkbox": "^12.
|
|
42
|
+
"@atlaskit/checkbox": "^12.4.0",
|
|
43
43
|
"@atlaskit/docs": "*",
|
|
44
44
|
"@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
|
|
45
|
-
"@testing-library/react": "^
|
|
46
|
-
"typescript": "4.
|
|
45
|
+
"@testing-library/react": "^12.1.5",
|
|
46
|
+
"typescript": "4.5.5"
|
|
47
47
|
},
|
|
48
48
|
"keywords": [
|
|
49
49
|
"atlaskit",
|
package/report.api.md
CHANGED
|
@@ -1,15 +1,25 @@
|
|
|
1
|
-
|
|
1
|
+
<!-- API Report Version: 2.3 -->
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
## API Report File for "@atlaskit/contextual-survey"
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
|
|
6
|
+
> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
|
|
7
|
+
|
|
8
|
+
### Table of contents
|
|
9
|
+
|
|
10
|
+
- [Main Entry Types](#main-entry-types)
|
|
11
|
+
|
|
12
|
+
### Main Entry Types
|
|
13
|
+
|
|
14
|
+
<!--SECTION START: Main Entry Types-->
|
|
6
15
|
|
|
7
16
|
```ts
|
|
8
17
|
/// <reference types="react" />
|
|
9
18
|
|
|
10
19
|
import { ReactNode } from 'react';
|
|
11
20
|
|
|
12
|
-
|
|
21
|
+
// @public (undocumented)
|
|
22
|
+
export const ContextualSurvey: ({
|
|
13
23
|
question,
|
|
14
24
|
statement,
|
|
15
25
|
onDismiss,
|
|
@@ -20,61 +30,52 @@ export declare const ContextualSurvey: ({
|
|
|
20
30
|
textPlaceholder,
|
|
21
31
|
}: Props) => JSX.Element;
|
|
22
32
|
|
|
23
|
-
|
|
33
|
+
// @public (undocumented)
|
|
34
|
+
export enum DismissTrigger {
|
|
35
|
+
// (undocumented)
|
|
24
36
|
AutoDismiss = 'AUTO_DISMISS',
|
|
25
|
-
|
|
37
|
+
// (undocumented)
|
|
26
38
|
Finished = 'FINISHED',
|
|
39
|
+
// (undocumented)
|
|
40
|
+
Manual = 'MANUAL',
|
|
41
|
+
// (undocumented)
|
|
27
42
|
Unmount = 'UNMOUNT',
|
|
28
43
|
}
|
|
29
44
|
|
|
30
|
-
|
|
45
|
+
// @public (undocumented)
|
|
46
|
+
type FormValues = {
|
|
31
47
|
feedbackScore: number;
|
|
32
48
|
canContact: boolean;
|
|
33
49
|
writtenFeedback: string;
|
|
34
50
|
};
|
|
35
51
|
|
|
36
|
-
|
|
52
|
+
// @public (undocumented)
|
|
53
|
+
export type OnDismissArgs = {
|
|
37
54
|
trigger: DismissTrigger;
|
|
38
55
|
};
|
|
39
56
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
* Example: "It is easy to find what I am looking for in Jira"
|
|
47
|
-
*/
|
|
57
|
+
// @public (undocumented)
|
|
58
|
+
interface Props {
|
|
59
|
+
getUserHasAnsweredMailingList: () => Promise<boolean>;
|
|
60
|
+
onDismiss: (args: OnDismissArgs) => void;
|
|
61
|
+
onMailingListAnswer: (answer: boolean) => Promise<void>;
|
|
62
|
+
onSubmit: (formValues: FormValues) => Promise<void>;
|
|
48
63
|
question: string;
|
|
49
|
-
|
|
64
|
+
statement?: string;
|
|
50
65
|
textLabel?: string;
|
|
51
|
-
/** Text placeholder for the survey text area
|
|
52
|
-
* Example: "Tell us why"
|
|
53
|
-
*/
|
|
54
66
|
textPlaceholder?: string;
|
|
55
|
-
/** Callback that is triggered when the survey should be dismissed */
|
|
56
|
-
onDismiss: (args: OnDismissArgs) => void;
|
|
57
|
-
/** Gets whether user has already signed up to the Atlassian Research Group list.
|
|
58
|
-
* If `true` is returned then the user will not be prompted to sign up to the Research Group.
|
|
59
|
-
*/
|
|
60
|
-
getUserHasAnsweredMailingList: () => Promise<boolean>;
|
|
61
|
-
/** Callback that is triggered when the survey is submitted, it will get the survey data as a parameter */
|
|
62
|
-
onSubmit: (formValues: FormValues) => Promise<void>;
|
|
63
|
-
/** Callback that is triggered when the user clicks 'Yes' or 'No' to sign up to the Atlassian Research Group */
|
|
64
|
-
onMailingListAnswer: (answer: boolean) => Promise<void>;
|
|
65
67
|
}
|
|
66
68
|
|
|
67
|
-
|
|
68
|
-
|
|
69
|
+
// @public (undocumented)
|
|
70
|
+
type Props_2 = {
|
|
69
71
|
shouldShow: boolean;
|
|
70
|
-
/** A function that returns Node to be rendered (`<ContextualSurvey/>`)
|
|
71
|
-
* Using a function as child so that the child node does
|
|
72
|
-
* not need to be evaluated if it is not mounted
|
|
73
|
-
*/
|
|
74
72
|
children: () => ReactNode;
|
|
75
73
|
};
|
|
76
74
|
|
|
77
|
-
|
|
75
|
+
// @public (undocumented)
|
|
76
|
+
export function SurveyMarshal(props: Props_2): JSX.Element;
|
|
78
77
|
|
|
79
|
-
|
|
78
|
+
// (No @packageDocumentation comment for this package)
|
|
80
79
|
```
|
|
80
|
+
|
|
81
|
+
<!--SECTION END: Main Entry Types-->
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
## API Report File for "@atlaskit/contextual-survey"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
/// <reference types="react" />
|
|
8
|
+
|
|
9
|
+
import { ReactNode } from 'react';
|
|
10
|
+
|
|
11
|
+
// @public (undocumented)
|
|
12
|
+
export const ContextualSurvey: ({ question, statement, onDismiss, onSubmit, onMailingListAnswer, getUserHasAnsweredMailingList, textLabel, textPlaceholder, }: Props) => JSX.Element;
|
|
13
|
+
|
|
14
|
+
// @public (undocumented)
|
|
15
|
+
export enum DismissTrigger {
|
|
16
|
+
// (undocumented)
|
|
17
|
+
AutoDismiss = "AUTO_DISMISS",
|
|
18
|
+
// (undocumented)
|
|
19
|
+
Finished = "FINISHED",
|
|
20
|
+
// (undocumented)
|
|
21
|
+
Manual = "MANUAL",
|
|
22
|
+
// (undocumented)
|
|
23
|
+
Unmount = "UNMOUNT"
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
// @public (undocumented)
|
|
27
|
+
type FormValues = {
|
|
28
|
+
feedbackScore: number;
|
|
29
|
+
canContact: boolean;
|
|
30
|
+
writtenFeedback: string;
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
// @public (undocumented)
|
|
34
|
+
export type OnDismissArgs = {
|
|
35
|
+
trigger: DismissTrigger;
|
|
36
|
+
};
|
|
37
|
+
|
|
38
|
+
// @public (undocumented)
|
|
39
|
+
interface Props {
|
|
40
|
+
getUserHasAnsweredMailingList: () => Promise<boolean>;
|
|
41
|
+
onDismiss: (args: OnDismissArgs) => void;
|
|
42
|
+
onMailingListAnswer: (answer: boolean) => Promise<void>;
|
|
43
|
+
onSubmit: (formValues: FormValues) => Promise<void>;
|
|
44
|
+
question: string;
|
|
45
|
+
statement?: string;
|
|
46
|
+
textLabel?: string;
|
|
47
|
+
textPlaceholder?: string;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
// @public (undocumented)
|
|
51
|
+
type Props_2 = {
|
|
52
|
+
shouldShow: boolean;
|
|
53
|
+
children: () => ReactNode;
|
|
54
|
+
};
|
|
55
|
+
|
|
56
|
+
// @public (undocumented)
|
|
57
|
+
export function SurveyMarshal(props: Props_2): JSX.Element;
|
|
58
|
+
|
|
59
|
+
// (No @packageDocumentation comment for this package)
|
|
60
|
+
|
|
61
|
+
```
|
package/types/package.json
CHANGED
|
@@ -4,5 +4,12 @@
|
|
|
4
4
|
"module": "../dist/esm/types.js",
|
|
5
5
|
"module:es2019": "../dist/es2019/types.js",
|
|
6
6
|
"sideEffects": false,
|
|
7
|
-
"types": "../dist/types/types.d.ts"
|
|
7
|
+
"types": "../dist/types/types.d.ts",
|
|
8
|
+
"typesVersions": {
|
|
9
|
+
">=4.0 <4.5": {
|
|
10
|
+
"*": [
|
|
11
|
+
"../dist/types-ts4.0/types.d.ts"
|
|
12
|
+
]
|
|
13
|
+
}
|
|
14
|
+
}
|
|
8
15
|
}
|