@atlaskit/onboarding 14.0.3 → 14.1.1

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.
Files changed (9) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/dist/cjs/components/spotlight-card.js +1 -0
  3. package/dist/es2019/components/spotlight-card.js +1 -0
  4. package/dist/esm/components/spotlight-card.js +1 -0
  5. package/dist/types/components/spotlight-card.d.ts +2 -70
  6. package/dist/types/types.d.ts +65 -1
  7. package/dist/types-ts4.5/components/spotlight-card.d.ts +2 -70
  8. package/dist/types-ts4.5/types.d.ts +65 -1
  9. package/package.json +3 -11
package/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # @atlaskit/onboarding
2
2
 
3
+ ## 14.1.1
4
+
5
+ ### Patch Changes
6
+
7
+ - [#153897](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/153897)
8
+ [`86e45dd6e3502`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/86e45dd6e3502) -
9
+ Export SpotlightCard prop types
10
+
11
+ ## 14.1.0
12
+
13
+ ### Minor Changes
14
+
15
+ - [#154745](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/154745)
16
+ [`7618d9837e247`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7618d9837e247) -
17
+ Tidy up design-system-closed-all-when-click-outside and sibling-dropdown-close-issue to provide
18
+ better keyboard navigation.
19
+
20
+ ### Patch Changes
21
+
22
+ - Updated dependencies
23
+
3
24
  ## 14.0.3
4
25
 
5
26
  ### Patch Changes
package/dist/cjs/components/spotlight-card.js CHANGED
@@ -45,6 +45,7 @@ var containerStyles = {
45
45
  var containerShadowStyles = {
46
46
  root: "_16qszucj"
47
47
  };
48
+
48
49
  /**
49
50
  * __Spotlight card__
50
51
  *
package/dist/es2019/components/spotlight-card.js CHANGED
@@ -31,6 +31,7 @@ const containerStyles = {
31
31
  const containerShadowStyles = {
32
32
  root: "_16qszucj"
33
33
  };
34
+
34
35
  /**
35
36
  * __Spotlight card__
36
37
  *
package/dist/esm/components/spotlight-card.js CHANGED
@@ -35,6 +35,7 @@ var containerStyles = {
35
35
  var containerShadowStyles = {
36
36
  root: "_16qszucj"
37
37
  };
38
+
38
39
  /**
39
40
  * __Spotlight card__
40
41
  *
package/dist/types/components/spotlight-card.d.ts CHANGED
@@ -1,73 +1,5 @@
1
- /**
2
- * @jsxRuntime classic
3
- * @jsx jsx
4
- */
5
- import { type ComponentType, type ReactNode, type Ref } from 'react';
6
- import { type Actions } from '../types';
7
- interface SpotlightCardProps {
8
- /**
9
- * Buttons to render in the footer.
10
- */
11
- actions?: Actions;
12
- /**
13
- * An optional element rendered to the left of the footer actions.
14
- */
15
- actionsBeforeElement?: ReactNode;
16
- /**
17
- * The content of the card.
18
- */
19
- children?: ReactNode;
20
- /**
21
- * The container elements rendered by the component.
22
- */
23
- components?: {
24
- Header?: ComponentType<any>;
25
- Footer?: ComponentType<any>;
26
- };
27
- /**
28
- * The heading to be rendered above the body content.
29
- */
30
- heading?: ReactNode;
31
- /**
32
- * Specifies the heading level in the document structure.
33
- * If not specified, level 4 will be applied by default.
34
- */
35
- headingLevel?: 1 | 2 | 3 | 4 | 5 | 6;
36
- /**
37
- * An optional element rendered to the right of the heading, usually used to number steps in a multi-step flow.
38
- */
39
- headingAfterElement?: ReactNode;
40
- /**
41
- * The image src to render above the heading.
42
- */
43
- image?: string | ReactNode;
44
- /**
45
- * Removes elevation styles if set.
46
- */
47
- isFlat?: boolean;
48
- /**
49
- * Specifies the width of the card component. Accepts either a number or the string '100%'.
50
- * When a number is provided, the width is set in pixels. When '100%' is provided, the width
51
- * is set to occupy 100% of the parent container's width. Regardless of whether `width` is set,
52
- * the width is constrained to a minimum width of 160px and a maximum width of 600px.
53
- */
54
- width?: number | '100%';
55
- /**
56
- * @deprecated
57
- * Use `ref` instead.
58
- */
59
- innerRef?: Ref<HTMLDivElement> | null;
60
- /**
61
- * A `testId` prop is provided for specified elements,
62
- * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
63
- * serving as a hook for automated tests.
64
- */
65
- testId?: string;
66
- /**
67
- * The ID of heading.
68
- */
69
- headingId?: string;
70
- }
1
+ /// <reference types="react" />
2
+ import { type SpotlightCardProps } from '../types';
71
3
  /**
72
4
  * __Spotlight card__
73
5
  *
package/dist/types/types.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { type ComponentType, type MouseEvent, type ReactNode } from 'react';
1
+ import { type ComponentType, type MouseEvent, type ReactNode, type Ref } from 'react';
2
2
  import { type CustomThemeButtonProps } from '@atlaskit/button/types';
3
3
  interface Action extends Omit<CustomThemeButtonProps, 'children'> {
4
4
  key?: string;
@@ -106,3 +106,67 @@ export interface SpotlightProps {
106
106
  */
107
107
  titleId?: string;
108
108
  }
109
+ export interface SpotlightCardProps {
110
+ /**
111
+ * Buttons to render in the footer.
112
+ */
113
+ actions?: Actions;
114
+ /**
115
+ * An optional element rendered to the left of the footer actions.
116
+ */
117
+ actionsBeforeElement?: ReactNode;
118
+ /**
119
+ * The content of the card.
120
+ */
121
+ children?: ReactNode;
122
+ /**
123
+ * The container elements rendered by the component.
124
+ */
125
+ components?: {
126
+ Header?: ComponentType<any>;
127
+ Footer?: ComponentType<any>;
128
+ };
129
+ /**
130
+ * The heading to be rendered above the body content.
131
+ */
132
+ heading?: ReactNode;
133
+ /**
134
+ * Specifies the heading level in the document structure.
135
+ * If not specified, level 4 will be applied by default.
136
+ */
137
+ headingLevel?: 1 | 2 | 3 | 4 | 5 | 6;
138
+ /**
139
+ * An optional element rendered to the right of the heading, usually used to number steps in a multi-step flow.
140
+ */
141
+ headingAfterElement?: ReactNode;
142
+ /**
143
+ * The image src to render above the heading.
144
+ */
145
+ image?: string | ReactNode;
146
+ /**
147
+ * Removes elevation styles if set.
148
+ */
149
+ isFlat?: boolean;
150
+ /**
151
+ * Specifies the width of the card component. Accepts either a number or the string '100%'.
152
+ * When a number is provided, the width is set in pixels. When '100%' is provided, the width
153
+ * is set to occupy 100% of the parent container's width. Regardless of whether `width` is set,
154
+ * the width is constrained to a minimum width of 160px and a maximum width of 600px.
155
+ */
156
+ width?: number | '100%';
157
+ /**
158
+ * @deprecated
159
+ * Use `ref` instead.
160
+ */
161
+ innerRef?: Ref<HTMLDivElement> | null;
162
+ /**
163
+ * A `testId` prop is provided for specified elements,
164
+ * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
165
+ * serving as a hook for automated tests.
166
+ */
167
+ testId?: string;
168
+ /**
169
+ * The ID of heading.
170
+ */
171
+ headingId?: string;
172
+ }
package/dist/types-ts4.5/components/spotlight-card.d.ts CHANGED
@@ -1,73 +1,5 @@
1
- /**
2
- * @jsxRuntime classic
3
- * @jsx jsx
4
- */
5
- import { type ComponentType, type ReactNode, type Ref } from 'react';
6
- import { type Actions } from '../types';
7
- interface SpotlightCardProps {
8
- /**
9
- * Buttons to render in the footer.
10
- */
11
- actions?: Actions;
12
- /**
13
- * An optional element rendered to the left of the footer actions.
14
- */
15
- actionsBeforeElement?: ReactNode;
16
- /**
17
- * The content of the card.
18
- */
19
- children?: ReactNode;
20
- /**
21
- * The container elements rendered by the component.
22
- */
23
- components?: {
24
- Header?: ComponentType<any>;
25
- Footer?: ComponentType<any>;
26
- };
27
- /**
28
- * The heading to be rendered above the body content.
29
- */
30
- heading?: ReactNode;
31
- /**
32
- * Specifies the heading level in the document structure.
33
- * If not specified, level 4 will be applied by default.
34
- */
35
- headingLevel?: 1 | 2 | 3 | 4 | 5 | 6;
36
- /**
37
- * An optional element rendered to the right of the heading, usually used to number steps in a multi-step flow.
38
- */
39
- headingAfterElement?: ReactNode;
40
- /**
41
- * The image src to render above the heading.
42
- */
43
- image?: string | ReactNode;
44
- /**
45
- * Removes elevation styles if set.
46
- */
47
- isFlat?: boolean;
48
- /**
49
- * Specifies the width of the card component. Accepts either a number or the string '100%'.
50
- * When a number is provided, the width is set in pixels. When '100%' is provided, the width
51
- * is set to occupy 100% of the parent container's width. Regardless of whether `width` is set,
52
- * the width is constrained to a minimum width of 160px and a maximum width of 600px.
53
- */
54
- width?: number | '100%';
55
- /**
56
- * @deprecated
57
- * Use `ref` instead.
58
- */
59
- innerRef?: Ref<HTMLDivElement> | null;
60
- /**
61
- * A `testId` prop is provided for specified elements,
62
- * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
63
- * serving as a hook for automated tests.
64
- */
65
- testId?: string;
66
- /**
67
- * The ID of heading.
68
- */
69
- headingId?: string;
70
- }
1
+ /// <reference types="react" />
2
+ import { type SpotlightCardProps } from '../types';
71
3
  /**
72
4
  * __Spotlight card__
73
5
  *
package/dist/types-ts4.5/types.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { type ComponentType, type MouseEvent, type ReactNode } from 'react';
1
+ import { type ComponentType, type MouseEvent, type ReactNode, type Ref } from 'react';
2
2
  import { type CustomThemeButtonProps } from '@atlaskit/button/types';
3
3
  interface Action extends Omit<CustomThemeButtonProps, 'children'> {
4
4
  key?: string;
@@ -106,3 +106,67 @@ export interface SpotlightProps {
106
106
  */
107
107
  titleId?: string;
108
108
  }
109
+ export interface SpotlightCardProps {
110
+ /**
111
+ * Buttons to render in the footer.
112
+ */
113
+ actions?: Actions;
114
+ /**
115
+ * An optional element rendered to the left of the footer actions.
116
+ */
117
+ actionsBeforeElement?: ReactNode;
118
+ /**
119
+ * The content of the card.
120
+ */
121
+ children?: ReactNode;
122
+ /**
123
+ * The container elements rendered by the component.
124
+ */
125
+ components?: {
126
+ Header?: ComponentType<any>;
127
+ Footer?: ComponentType<any>;
128
+ };
129
+ /**
130
+ * The heading to be rendered above the body content.
131
+ */
132
+ heading?: ReactNode;
133
+ /**
134
+ * Specifies the heading level in the document structure.
135
+ * If not specified, level 4 will be applied by default.
136
+ */
137
+ headingLevel?: 1 | 2 | 3 | 4 | 5 | 6;
138
+ /**
139
+ * An optional element rendered to the right of the heading, usually used to number steps in a multi-step flow.
140
+ */
141
+ headingAfterElement?: ReactNode;
142
+ /**
143
+ * The image src to render above the heading.
144
+ */
145
+ image?: string | ReactNode;
146
+ /**
147
+ * Removes elevation styles if set.
148
+ */
149
+ isFlat?: boolean;
150
+ /**
151
+ * Specifies the width of the card component. Accepts either a number or the string '100%'.
152
+ * When a number is provided, the width is set in pixels. When '100%' is provided, the width
153
+ * is set to occupy 100% of the parent container's width. Regardless of whether `width` is set,
154
+ * the width is constrained to a minimum width of 160px and a maximum width of 600px.
155
+ */
156
+ width?: number | '100%';
157
+ /**
158
+ * @deprecated
159
+ * Use `ref` instead.
160
+ */
161
+ innerRef?: Ref<HTMLDivElement> | null;
162
+ /**
163
+ * A `testId` prop is provided for specified elements,
164
+ * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
165
+ * serving as a hook for automated tests.
166
+ */
167
+ testId?: string;
168
+ /**
169
+ * The ID of heading.
170
+ */
171
+ headingId?: string;
172
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/onboarding",
3
- "version": "14.0.3",
3
+ "version": "14.1.1",
4
4
  "description": "An onboarding spotlight introduces new features to users through focused messages or multi-step tours.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -43,12 +43,12 @@
43
43
  "@atlaskit/ds-lib": "^4.0.0",
44
44
  "@atlaskit/heading": "^5.2.0",
45
45
  "@atlaskit/layering": "^2.1.0",
46
- "@atlaskit/modal-dialog": "^14.1.0",
46
+ "@atlaskit/modal-dialog": "^14.2.0",
47
47
  "@atlaskit/motion": "^5.1.0",
48
48
  "@atlaskit/platform-feature-flags": "^1.1.0",
49
49
  "@atlaskit/popper": "^7.0.0",
50
50
  "@atlaskit/portal": "^5.1.0",
51
- "@atlaskit/primitives": "^14.4.0",
51
+ "@atlaskit/primitives": "^14.7.0",
52
52
  "@atlaskit/tokens": "^4.8.0",
53
53
  "@babel/runtime": "^7.0.0",
54
54
  "@compiled/react": "^0.18.3",
@@ -90,14 +90,6 @@
90
90
  "scroll-lock-replacement": {
91
91
  "type": "boolean"
92
92
  },
93
- "design-system-closed-all-when-click-outside": {
94
- "type": "boolean",
95
- "referenceOnly": true
96
- },
97
- "sibling-dropdown-close-issue": {
98
- "type": "boolean",
99
- "referenceOnly": true
100
- },
101
93
  "platform_design_system_team_transition_group_r18": {
102
94
  "type": "boolean",
103
95
  "referenceOnly": true