@atlaskit/inline-message 11.4.2 → 11.4.3

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 CHANGED
@@ -1,5 +1,11 @@
1
1
  # @atlaskit/inline-message
2
2
 
3
+ ## 11.4.3
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+
3
9
  ## 11.4.2
4
10
 
5
11
  ### Patch Changes
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/inline-message",
3
- "version": "11.4.2",
3
+ "version": "11.4.3",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/inline-message",
3
- "version": "11.4.2",
3
+ "version": "11.4.3",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/inline-message",
3
- "version": "11.4.2",
3
+ "version": "11.4.3",
4
4
  "sideEffects": false
5
5
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/inline-message",
3
- "version": "11.4.2",
3
+ "version": "11.4.3",
4
4
  "description": "An inline message lets users know when important information is available or when an action is required.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -12,14 +12,6 @@
12
12
  "module": "dist/esm/index.js",
13
13
  "module:es2019": "dist/es2019/index.js",
14
14
  "types": "dist/types/index.d.ts",
15
- "typesVersions": {
16
- ">=4.0 <4.5": {
17
- "*": [
18
- "dist/types-ts4.0/*",
19
- "dist/types-ts4.0/index.d.ts"
20
- ]
21
- }
22
- },
23
15
  "sideEffects": false,
24
16
  "atlaskit:src": "src/index.tsx",
25
17
  "atlassian": {
@@ -32,11 +24,11 @@
32
24
  }
33
25
  },
34
26
  "dependencies": {
35
- "@atlaskit/button": "^16.3.0",
27
+ "@atlaskit/button": "^16.4.0",
36
28
  "@atlaskit/icon": "^21.11.0",
37
29
  "@atlaskit/inline-dialog": "^13.4.0",
38
30
  "@atlaskit/theme": "^12.2.0",
39
- "@atlaskit/tokens": "^0.10.0",
31
+ "@atlaskit/tokens": "^0.11.0",
40
32
  "@babel/runtime": "^7.0.0",
41
33
  "@emotion/react": "^11.7.1"
42
34
  },
package/report.api.md CHANGED
@@ -1,21 +1,27 @@
1
- ## API Report File for "@atlaskit/inline-message".
1
+ ## API Report File for "@atlaskit/inline-message"
2
2
 
3
- > Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ <!--
6
+ Generated API Report version: 2.0
7
+ -->
4
8
 
5
9
  [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
6
10
 
7
- ````ts
11
+ ```ts
8
12
  import { FC } from 'react';
9
13
  import { ReactNode } from 'react';
10
14
 
11
- declare type IconAppearance =
15
+ // @public (undocumented)
16
+ type IconAppearance =
12
17
  | 'connectivity'
13
18
  | 'confirmation'
14
19
  | 'info'
15
20
  | 'warning'
16
21
  | 'error';
17
22
 
18
- declare type InlineDialogPlacement =
23
+ // @public (undocumented)
24
+ type InlineDialogPlacement =
19
25
  | 'auto-start'
20
26
  | 'auto'
21
27
  | 'auto-end'
@@ -32,77 +38,22 @@ declare type InlineDialogPlacement =
32
38
  | 'left'
33
39
  | 'left-start';
34
40
 
35
- /**
36
- * __Inline message__
37
- *
38
- * An inline message lets users know when important information is available or when an action is required.
39
- *
40
- * - [Examples](https://atlassian.design/components/inline-message/examples)
41
- * - [Code](https://atlassian.design/components/inline-message/code)
42
- * - [Usage](https://atlassian.design/components/inline-message/usage)
43
- *
44
- * @example
45
- *
46
- * ```jsx
47
- * const Component = () => (
48
- * <InlineMessage
49
- * title="Inline Message Title Example"
50
- * secondaryText="Secondary Text"
51
- * >
52
- * <p>Some text that would be inside the open dialog and otherwise hidden.</p>
53
- * </InlineMessage>
54
- * );
55
- * ```
56
- */
57
- declare const InlineMessage: FC<InlineMessageProps>;
41
+ // @public
42
+ const InlineMessage: FC<InlineMessageProps>;
58
43
  export default InlineMessage;
59
44
 
60
- declare interface InlineMessageProps {
61
- /**
62
- * The elements to be displayed by the inline dialog.
63
- */
45
+ // @public (undocumented)
46
+ interface InlineMessageProps {
47
+ appearance?: IconAppearance;
64
48
  children?: ReactNode;
65
- /**
66
- * The placement to be passed to the inline dialog. Determines where around
67
- * the text the dialog is displayed.
68
- */
49
+ iconLabel?: string;
69
50
  placement?: InlineDialogPlacement;
70
- /**
71
- * Text to display second.
72
- */
73
51
  secondaryText?: ReactNode;
74
- /**
75
- * Text to display first, bolded for emphasis.
76
- */
52
+ testId?: string;
77
53
  title?: ReactNode;
78
- /**
79
- * Set the icon to be used before the title. Options are: connectivity,
80
- * confirmation, info, warning, and error.
81
- */
82
- appearance?: IconAppearance;
83
- /**
84
- * @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-5207 for more information.
85
- * Instead use the 'appearance' prop.
86
- * Set the icon to be used before the title.
87
- */
54
+ // @deprecated (undocumented)
88
55
  type?: IconAppearance;
89
- /**
90
- A unique string that appears as a data attribute, `data-testid`,
91
- in the rendered code. It is provided to serve as a hook for automated tests.
92
-
93
- The value of `testId` is attached to the different sub-components in Inline Message:
94
- - `testId`: the top-level inline message component
95
- - `testId--inline-dialog`: the content of the message
96
- - `testId--button`: the button element that opens the dialog on press
97
- - `testId--title`: the title of the message
98
- - `testId--text`: the text of the message
99
- */
100
- testId?: string;
101
- /**
102
- * Text to be used as label for the button icon. Can be used to provide useful information for users with screen readers when there is no title and/or secondaryText
103
- */
104
- iconLabel?: string;
105
56
  }
106
57
 
107
- export {};
108
- ````
58
+ // (No @packageDocumentation comment for this package)
59
+ ```
@@ -1,73 +0,0 @@
1
- /** @jsx jsx */
2
- import { FC, ReactNode } from 'react';
3
- import type { IconAppearance, InlineDialogPlacement } from '../../types';
4
- interface InlineMessageProps {
5
- /**
6
- * The elements to be displayed by the inline dialog.
7
- */
8
- children?: ReactNode;
9
- /**
10
- * The placement to be passed to the inline dialog. Determines where around
11
- * the text the dialog is displayed.
12
- */
13
- placement?: InlineDialogPlacement;
14
- /**
15
- * Text to display second.
16
- */
17
- secondaryText?: ReactNode;
18
- /**
19
- * Text to display first, bolded for emphasis.
20
- */
21
- title?: ReactNode;
22
- /**
23
- * Set the icon to be used before the title. Options are: connectivity,
24
- * confirmation, info, warning, and error.
25
- */
26
- appearance?: IconAppearance;
27
- /**
28
- * @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-5207 for more information.
29
- * Instead use the 'appearance' prop.
30
- * Set the icon to be used before the title.
31
- */
32
- type?: IconAppearance;
33
- /**
34
- A unique string that appears as a data attribute, `data-testid`,
35
- in the rendered code. It is provided to serve as a hook for automated tests.
36
-
37
- The value of `testId` is attached to the different sub-components in Inline Message:
38
- - `testId`: the top-level inline message component
39
- - `testId--inline-dialog`: the content of the message
40
- - `testId--button`: the button element that opens the dialog on press
41
- - `testId--title`: the title of the message
42
- - `testId--text`: the text of the message
43
- */
44
- testId?: string;
45
- /**
46
- * Text to be used as label for the button icon. Can be used to provide useful information for users with screen readers when there is no title and/or secondaryText
47
- */
48
- iconLabel?: string;
49
- }
50
- /**
51
- * __Inline message__
52
- *
53
- * An inline message lets users know when important information is available or when an action is required.
54
- *
55
- * - [Examples](https://atlassian.design/components/inline-message/examples)
56
- * - [Code](https://atlassian.design/components/inline-message/code)
57
- * - [Usage](https://atlassian.design/components/inline-message/usage)
58
- *
59
- * @example
60
- *
61
- * ```jsx
62
- * const Component = () => (
63
- * <InlineMessage
64
- * title="Inline Message Title Example"
65
- * secondaryText="Secondary Text"
66
- * >
67
- * <p>Some text that would be inside the open dialog and otherwise hidden.</p>
68
- * </InlineMessage>
69
- * );
70
- * ```
71
- */
72
- declare const InlineMessage: FC<InlineMessageProps>;
73
- export default InlineMessage;
@@ -1,16 +0,0 @@
1
- /** @jsx jsx */
2
- import type { FC } from 'react';
3
- import type { IconAppearance } from '../../types';
4
- interface MessageIconProps {
5
- appearance: IconAppearance;
6
- isOpen: boolean;
7
- label?: string;
8
- }
9
- /**
10
- * __Selected icon__
11
- *
12
- * The selected icon is used as the primary interactive element for the dialog.
13
- * Can be used with or without supporting text.
14
- */
15
- declare const SelectedIcon: FC<MessageIconProps>;
16
- export default SelectedIcon;
@@ -1,2 +0,0 @@
1
- import type { IconAppearanceMap } from './types';
2
- export declare const typesMapping: IconAppearanceMap;
@@ -1 +0,0 @@
1
- export { default } from './components/inline-message';
@@ -1,9 +0,0 @@
1
- import { ComponentType } from 'react';
2
- import type { GlyphProps } from '@atlaskit/icon';
3
- export interface Icon {
4
- defaultLabel: string;
5
- icon: ComponentType<GlyphProps>;
6
- }
7
- export declare type IconAppearanceMap = Record<IconAppearance, Icon>;
8
- export declare type IconAppearance = 'connectivity' | 'confirmation' | 'info' | 'warning' | 'error';
9
- export declare type InlineDialogPlacement = 'auto-start' | 'auto' | 'auto-end' | 'top-start' | 'top' | 'top-end' | 'right-start' | 'right' | 'right-end' | 'bottom-end' | 'bottom' | 'bottom-start' | 'left-end' | 'left' | 'left-start';