@atlaskit/inline-message 11.5.1 → 11.5.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/inline-message
 
+## 11.5.3
+
+### Patch Changes
+
+- [`4ae083a7e66`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4ae083a7e66) - Use `@af/accessibility-testing` for default jest-axe config and jest-axe import in accessibility testing.
+
+## 11.5.2
+
+### Patch Changes
+
+- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
+
 ## 11.5.1
 
 ### Patch Changes

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/inline-message",
-	"version": "11.5.1",
+	"version": "11.5.3",
 	"sideEffects": false
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/inline-message",
-	"version": "11.5.1",
+	"version": "11.5.3",
 	"sideEffects": false
 }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/inline-message",
-	"version": "11.5.1",
+	"version": "11.5.3",
 	"sideEffects": false
 }

package/dist/types/components/inline-message/index.d.ts

@@ -31,15 +31,15 @@ interface InlineMessageProps {
      */
     type?: IconAppearance;
     /**
-      A unique string that appears as a data attribute, `data-testid`,
-      in the rendered code. It is provided to serve as a hook for automated tests.
-  
-      The value of `testId` is attached to the different sub-components in Inline Message:
-      - `testId`: the top-level inline message component
-      - `testId--inline-dialog`: the content of the message
-      - `testId--button`: the button element that opens the dialog on press
-      - `testId--title`: the title of the message
-      - `testId--text`: the text of the message
+     * A unique string that appears as a data attribute, `data-testid`,
+     * in the rendered code. It is provided to serve as a hook for automated tests.
+     *
+     * The value of `testId` is attached to the different sub-components in Inline Message:
+     *  - `testId`: the top-level inline message component
+     *  - `testId--inline-dialog`: the content of the message
+     *  - `testId--button`: the button element that opens the dialog on press
+     *  - `testId--title`: the title of the message
+     *  - `testId--text`: the text of the message
      */
     testId?: string;
     /**

package/dist/types-ts4.5/components/inline-message/index.d.ts

@@ -0,0 +1,73 @@
+/** @jsx jsx */
+import { FC, ReactNode } from 'react';
+import type { IconAppearance, InlineDialogPlacement } from '../../types';
+interface InlineMessageProps {
+    /**
+     * The elements to be displayed by the inline dialog.
+     */
+    children?: ReactNode;
+    /**
+     * The placement to be passed to the inline dialog. Determines where around
+     * the text the dialog is displayed.
+     */
+    placement?: InlineDialogPlacement;
+    /**
+     * Text to display second.
+     */
+    secondaryText?: ReactNode;
+    /**
+     * Text to display first, bolded for emphasis.
+     */
+    title?: ReactNode;
+    /**
+     * Set the icon to be used before the title. Options are: connectivity,
+     * confirmation, info, warning, and error.
+     */
+    appearance?: IconAppearance;
+    /**
+     * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-162 Internal documentation for deprecation (no external access)} Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-5207 for more information.
+     * Instead use the 'appearance' prop.
+     * Set the icon to be used before the title.
+     */
+    type?: IconAppearance;
+    /**
+     * A unique string that appears as a data attribute, `data-testid`,
+     * in the rendered code. It is provided to serve as a hook for automated tests.
+     *
+     * The value of `testId` is attached to the different sub-components in Inline Message:
+     *  - `testId`: the top-level inline message component
+     *  - `testId--inline-dialog`: the content of the message
+     *  - `testId--button`: the button element that opens the dialog on press
+     *  - `testId--title`: the title of the message
+     *  - `testId--text`: the text of the message
+     */
+    testId?: string;
+    /**
+     * 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
+     */
+    iconLabel?: string;
+}
+/**
+ * __Inline message__
+ *
+ * An inline message lets users know when important information is available or when an action is required.
+ *
+ * - [Examples](https://atlassian.design/components/inline-message/examples)
+ * - [Code](https://atlassian.design/components/inline-message/code)
+ * - [Usage](https://atlassian.design/components/inline-message/usage)
+ *
+ * @example
+ *
+ * ```jsx
+ * const Component = () => (
+ *   <InlineMessage
+ *    title="Inline Message Title Example"
+ *    secondaryText="Secondary Text"
+ *   >
+ *    <p>Some text that would be inside the open dialog and otherwise hidden.</p>
+ *   </InlineMessage>
+ * );
+ * ```
+ */
+declare const InlineMessage: FC<InlineMessageProps>;
+export default InlineMessage;

package/dist/types-ts4.5/components/message-icon/index.d.ts

@@ -0,0 +1,16 @@
+/** @jsx jsx */
+import type { FC } from 'react';
+import type { IconAppearance } from '../../types';
+interface MessageIconProps {
+    appearance: IconAppearance;
+    isOpen: boolean;
+    label?: string;
+}
+/**
+ * __Selected icon__
+ *
+ * The selected icon is used as the primary interactive element for the dialog.
+ * Can be used with or without supporting text.
+ */
+declare const SelectedIcon: FC<MessageIconProps>;
+export default SelectedIcon;

package/dist/types-ts4.5/constants.d.ts

@@ -0,0 +1,3 @@
+import type { IconAppearanceMap } from './types';
+export declare const typesMapping: IconAppearanceMap;
+export declare const VAR_SECONDARY_TEXT_COLOR = "--secondary-text-color";

package/dist/types-ts4.5/index.d.ts

@@ -0,0 +1 @@
+export { default } from './components/inline-message';

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

@@ -0,0 +1,9 @@
+import { ComponentType } from 'react';
+import type { GlyphProps } from '@atlaskit/icon';
+export interface Icon {
+    defaultLabel: string;
+    icon: ComponentType<GlyphProps>;
+}
+export type IconAppearanceMap = Record<IconAppearance, Icon>;
+export type IconAppearance = 'connectivity' | 'confirmation' | 'info' | 'warning' | 'error';
+export 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';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/inline-message",
-  "version": "11.5.1",
+  "version": "11.5.3",
   "description": "An inline message lets users know when important information is available or when an action is required.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -25,18 +25,18 @@
   "atlassian": {
     "team": "Design System Team",
     "deprecatedAutoEntryPoints": true,
-    "releaseModel": "scheduled",
+    "releaseModel": "continuous",
     "website": {
       "name": "Inline message",
       "category": "Components"
     }
   },
   "dependencies": {
-    "@atlaskit/button": "^16.7.0",
+    "@atlaskit/button": "^16.8.0",
     "@atlaskit/icon": "^21.12.0",
     "@atlaskit/inline-dialog": "^13.6.0",
     "@atlaskit/theme": "^12.5.0",
-    "@atlaskit/tokens": "^1.4.0",
+    "@atlaskit/tokens": "^1.11.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1"
   },
@@ -44,9 +44,8 @@
     "react": "^16.8.0"
   },
   "devDependencies": {
-    "@atlaskit/docs": "*",
+    "@af/accessibility-testing": "*",
     "@atlaskit/ds-lib": "^2.2.0",
-    "@atlaskit/section-message": "^6.4.0",
     "@atlaskit/ssr": "*",
     "@atlaskit/visual-regression": "*",
     "@atlaskit/webdriver-runner": "*",