@atlaskit/inline-edit 12.2.1 → 12.2.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/inline-edit
 
+## 12.2.3
+
+### Patch Changes
+
+- [`9de88fa1e1e`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9de88fa1e1e) - Internal changes to include spacing tokens in component implementations.
+
+## 12.2.2
+
+### Patch Changes
+
+- [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
+
 ## 12.2.1
 
 ### Patch Changes

package/dist/cjs/inline-edit.js

@@ -51,7 +51,7 @@ var buttonStyles = (0, _react2.css)({
 var analyticsAttributes = {
   componentName: 'inlineEdit',
   packageName: "@atlaskit/inline-edit",
-  packageVersion: "12.2.1"
+  packageVersion: "12.2.3"
 };
 
 var noop = function noop() {};

package/dist/cjs/internal/read-view.js

@@ -25,8 +25,10 @@ var readViewContainerStyles = (0, _react2.css)({
 });
 var editButtonStyles = (0, _react2.css)({
   display: 'block',
-  margin: '0',
-  padding: '0',
+  // TODO Delete this comment after verifying spacing token -> previous value `'0'`
+  margin: "var(--ds-scale-0, 0px)",
+  // TODO Delete this comment after verifying spacing token -> previous value `'0'`
+  padding: "var(--ds-scale-0, 0px)",
   appearance: 'none',
   background: 'transparent',
   border: 0,

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/inline-edit",
-	"version": "12.2.1",
+	"version": "12.2.3",
 	"sideEffects": false
 }

package/dist/es2019/inline-edit.js

@@ -20,7 +20,7 @@ const buttonStyles = css({
 const analyticsAttributes = {
   componentName: 'inlineEdit',
   packageName: "@atlaskit/inline-edit",
-  packageVersion: "12.2.1"
+  packageVersion: "12.2.3"
 };
 
 const noop = () => {};

package/dist/es2019/internal/read-view.js

@@ -8,8 +8,10 @@ const readViewContainerStyles = css({
 });
 const editButtonStyles = css({
   display: 'block',
-  margin: '0',
-  padding: '0',
+  // TODO Delete this comment after verifying spacing token -> previous value `'0'`
+  margin: "var(--ds-scale-0, 0px)",
+  // TODO Delete this comment after verifying spacing token -> previous value `'0'`
+  padding: "var(--ds-scale-0, 0px)",
   appearance: 'none',
   background: 'transparent',
   border: 0,

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/inline-edit",
-	"version": "12.2.1",
+	"version": "12.2.3",
 	"sideEffects": false
 }

package/dist/esm/inline-edit.js

@@ -26,7 +26,7 @@ var buttonStyles = css({
 var analyticsAttributes = {
   componentName: 'inlineEdit',
   packageName: "@atlaskit/inline-edit",
-  packageVersion: "12.2.1"
+  packageVersion: "12.2.3"
 };
 
 var noop = function noop() {};

package/dist/esm/internal/read-view.js

@@ -8,8 +8,10 @@ var readViewContainerStyles = css({
 });
 var editButtonStyles = css({
   display: 'block',
-  margin: '0',
-  padding: '0',
+  // TODO Delete this comment after verifying spacing token -> previous value `'0'`
+  margin: "var(--ds-scale-0, 0px)",
+  // TODO Delete this comment after verifying spacing token -> previous value `'0'`
+  padding: "var(--ds-scale-0, 0px)",
   appearance: 'none',
   background: 'transparent',
   border: 0,

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/inline-edit",
-	"version": "12.2.1",
+	"version": "12.2.3",
 	"sideEffects": false
 }

package/dist/types/internal/hooks/use-button-focus-hook.d.ts

@@ -2,7 +2,7 @@
 declare const useButtonFocusHook: (isEditing: boolean | undefined, isEditingState: boolean) => {
     editButtonRef: import("react").RefObject<HTMLButtonElement>;
     editViewRef: import("react").MutableRefObject<HTMLElement | undefined>;
-    shouldBeEditing: boolean | undefined;
+    shouldBeEditing: boolean;
     doNotFocusOnEditButton: () => boolean;
 };
 export default useButtonFocusHook;

package/dist/types-ts4.0/entry-points/inline-edit.d.ts

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

package/dist/types-ts4.0/entry-points/inline-editable-textfield.d.ts

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

package/dist/types-ts4.0/entry-points/types.d.ts

@@ -0,0 +1 @@
+export type { InlineEditableTextfieldProps, InlineEditProps } from '../types';

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

@@ -0,0 +1,3 @@
+export { default } from './inline-edit';
+export { default as InlineEditableTextfield } from './inline-editable-textfield';
+export type { InlineEditProps, InlineEditableTextfieldProps } from './types';

package/dist/types-ts4.0/inline-edit.d.ts

@@ -0,0 +1,4 @@
+import { jsx } from '@emotion/react';
+import { InlineEditProps } from './types';
+declare const InlineEdit: <FieldValue extends unknown = string>(props: InlineEditProps<FieldValue>) => jsx.JSX.Element;
+export default InlineEdit;

package/dist/types-ts4.0/inline-editable-textfield.d.ts

@@ -0,0 +1,5 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+import { InlineEditableTextfieldProps } from './types';
+declare const InlineEditableTextfield: (props: InlineEditableTextfieldProps) => jsx.JSX.Element;
+export default InlineEditableTextfield;

package/dist/types-ts4.0/internal/buttons.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="react" />
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+import { ThemeModes } from '@atlaskit/theme/types';
+interface ButtonsProp {
+    mode: ThemeModes;
+    confirmButtonLabel: string;
+    cancelButtonLabel: string;
+    onMouseDown: () => void;
+    onCancelClick: (event: React.MouseEvent<HTMLElement>) => void;
+}
+declare const Buttons: ({ mode, confirmButtonLabel, cancelButtonLabel, onMouseDown, onCancelClick, }: ButtonsProp) => jsx.JSX.Element;
+export default Buttons;

package/dist/types-ts4.0/internal/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const gridSize: number;
+export declare const fontSize: number;
+export declare const borderRadius: number;

package/dist/types-ts4.0/internal/hooks/use-button-focus-hook.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+declare const useButtonFocusHook: (isEditing: boolean | undefined, isEditingState: boolean) => {
+    editButtonRef: import("react").RefObject<HTMLButtonElement>;
+    editViewRef: import("react").MutableRefObject<HTMLElement | undefined>;
+    shouldBeEditing: boolean;
+    doNotFocusOnEditButton: () => boolean;
+};
+export default useButtonFocusHook;

package/dist/types-ts4.0/internal/read-view.d.ts

@@ -0,0 +1,13 @@
+/** @jsx jsx */
+import React from 'react';
+import { jsx } from '@emotion/react';
+interface ReadViewProps {
+    editButtonLabel: string;
+    onEditRequested: () => void;
+    postReadViewClick: () => void;
+    editButtonRef: React.RefObject<HTMLButtonElement>;
+    readViewFitContainerWidth?: boolean;
+    readView: () => React.ReactNode;
+}
+declare const ReadView: ({ editButtonLabel, onEditRequested, postReadViewClick, editButtonRef, readViewFitContainerWidth, readView, }: ReadViewProps) => jsx.JSX.Element;
+export default ReadView;

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

@@ -0,0 +1,68 @@
+import React from 'react';
+import { UIAnalyticsEvent, WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
+import { FieldProps } from '@atlaskit/form';
+interface CommonProps extends WithAnalyticsEventsProps {
+    /** Additional information to be included in the `context` of analytics events that come from button. */
+    analyticsContext?: Record<string, any>;
+    /** Accessibility label for the cancel action button. */
+    cancelButtonLabel?: string;
+    /** Accessibility label for the confirm action button, which saves the field value into `editValue`. */
+    confirmButtonLabel?: string;
+    /** The user input entered into the field during `editView`. This value is updated and saved by `onConfirm`. */
+    defaultValue: any;
+    /** Label above the input field that communicates what value should be entered. */
+    label?: string;
+    /** Displays an inline dialog with a message when the field input is invalid. This is handled by `react-final-form`. */
+    validate?: (value: any, formState: {}, fieldState: {}) => string | void | Promise<string | void>;
+    /**
+     * Sets the view when the element blurs and loses focus (this can happen when a user clicks away).
+     * When set to true, inline edit stays in `editView` when blurred. */
+    keepEditViewOpenOnBlur?: boolean;
+    /** Sets whether the confirm and cancel action buttons are displayed in the bottom right of the field. */
+    hideActionButtons?: boolean;
+    /** Determines whether the input value can be confirmed as empty. */
+    isRequired?: boolean;
+    /** Determines whether the `readView` has 100% width within its container, or whether it fits the content. */
+    readViewFitContainerWidth?: boolean;
+    /** Accessibility label for button, which is used to enter `editView` from keyboard. */
+    editButtonLabel?: string;
+    /** Exits `editView` and switches back to `readView`. This is called when the cancel action button (x) is clicked. */
+    onCancel?: () => void;
+    /**
+     * Determines whether it begins in `editView` or `readView`. When set to true, `isEditing` begins as true and the inline edit
+     * starts in `editView`.
+     */
+    startWithEditViewOpen?: boolean;
+}
+export interface ExtendedFieldProps<FieldValue> extends FieldProps<FieldValue> {
+    errorMessage?: string | undefined;
+}
+export interface InlineEditProps<FieldValue> extends CommonProps {
+    /** The component shown when user is editing (when the inline edit is not in `readView`). */
+    editView: (fieldProps: ExtendedFieldProps<FieldValue>, ref: React.RefObject<any>) => React.ReactNode;
+    /** Sets whether the component shows the `readView` or the `editView`. This is used to manage the state of the input in stateless inline edit. */
+    isEditing?: boolean;
+    /**
+    Saves and confirms the value entered into the field. It exits `editView` and returns to `readView`.
+     */
+    onConfirm: (value: any, analyticsEvent: UIAnalyticsEvent) => void;
+    /** Handler called when readView is clicked. */
+    onEdit?: () => void;
+    /** The component shown when not in `editView`. This is when the inline edit is read-only and not being edited.*/
+    readView: () => React.ReactNode;
+}
+export interface InlineEditableTextfieldProps extends CommonProps {
+    /** Sets height of the text field to compact. The top and bottom padding is decreased. */
+    isCompact?: boolean;
+    /**
+     * Calls the `editView` handler. It confirms the changes.
+     * The field value is passed as an argument to this function.
+     */
+    onConfirm: (value: string, analyticsEvent: UIAnalyticsEvent) => void;
+    /** Text shown in `readView` when the field value is an empty string. */
+    placeholder: string;
+    /** A `testId` prop is provided for specific elements. This is a unique string that appears as a data attribute `data-testid` in the rendered code and serves as a hook for automated tests.
+     */
+    testId?: string;
+}
+export {};

package/inline-edit/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/entry-points/inline-edit.js",
   "module:es2019": "../dist/es2019/entry-points/inline-edit.js",
   "sideEffects": false,
-  "types": "../dist/types/entry-points/inline-edit.d.ts"
+  "types": "../dist/types/entry-points/inline-edit.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/entry-points/inline-edit.d.ts"
+      ]
+    }
+  }
 }

package/inline-editable-textfield/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/entry-points/inline-editable-textfield.js",
   "module:es2019": "../dist/es2019/entry-points/inline-editable-textfield.js",
   "sideEffects": false,
-  "types": "../dist/types/entry-points/inline-editable-textfield.d.ts"
+  "types": "../dist/types/entry-points/inline-editable-textfield.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/entry-points/inline-editable-textfield.d.ts"
+      ]
+    }
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/inline-edit",
-  "version": "12.2.1",
+  "version": "12.2.3",
   "description": "An inline edit displays a custom input component that switches between reading and editing on the same page.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,10 +12,19 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "dist/types-ts4.0/*",
+        "dist/types-ts4.0/index.d.ts"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.ts",
   "homepage": "https://atlassian.design/components/inline-edit/",
   "atlassian": {
+    "disableProductCI": true,
     "team": "Design System Team",
     "releaseModel": "scheduled",
     "website": {
@@ -27,10 +36,10 @@
     "@atlaskit/analytics-next": "^8.2.0",
     "@atlaskit/button": "^16.3.0",
     "@atlaskit/codemod-utils": "^4.1.0",
-    "@atlaskit/form": "^8.5.0",
-    "@atlaskit/icon": "^21.10.0",
+    "@atlaskit/form": "^8.6.0",
+    "@atlaskit/icon": "^21.11.0",
     "@atlaskit/inline-dialog": "^13.4.0",
-    "@atlaskit/textfield": "^5.2.0",
+    "@atlaskit/textfield": "^5.3.0",
     "@atlaskit/theme": "^12.2.0",
     "@atlaskit/tokens": "^0.10.0",
     "@babel/runtime": "^7.0.0",
@@ -40,14 +49,14 @@
     "react": "^16.8.0"
   },
   "devDependencies": {
-    "@atlaskit/datetime-picker": "^12.2.0",
+    "@atlaskit/datetime-picker": "^12.3.0",
     "@atlaskit/docs": "*",
-    "@atlaskit/section-message": "^6.2.0",
+    "@atlaskit/section-message": "^6.3.0",
     "@atlaskit/select": "^15.7.0",
     "@atlaskit/ssr": "*",
     "@atlaskit/tag": "^11.4.0",
     "@atlaskit/tag-group": "^10.1.0",
-    "@atlaskit/textarea": "^4.3.0",
+    "@atlaskit/textarea": "^4.5.0",
     "@atlaskit/visual-regression": "*",
     "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
@@ -58,7 +67,7 @@
     "jscodeshift": "^0.13.0",
     "react-dom": "^16.8.0",
     "storybook-addon-performance": "^0.16.0",
-    "typescript": "4.3.5",
+    "typescript": "4.5.5",
     "wait-for-expect": "^1.2.0"
   },
   "keywords": [
@@ -74,6 +83,7 @@
       "dom-events": "use-bind-event-listener",
       "ui-components": "lite-mode",
       "analytics": "analytics-next",
+      "design-tokens": "spacing",
       "theming": "tokens",
       "deprecation": "no-deprecated-imports",
       "styling": [

package/report.api.md

@@ -1,11 +1,12 @@
-## API Report File for "@atlaskit/inline-edit"
+## API Report File for "@atlaskit/inline-edit".
 
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
 
-```ts
-/// <reference types="react" />
+[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
+```ts
 import { FieldProps } from '@atlaskit/form';
+import { jsx } from '@emotion/react';
 import { default as React_2 } from 'react';
 import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
@@ -55,12 +56,12 @@ declare interface ExtendedFieldProps<FieldValue>
 
 declare const InlineEdit: <FieldValue extends unknown = string>(
   props: InlineEditProps<FieldValue>,
-) => JSX.Element;
+) => jsx.JSX.Element;
 export default InlineEdit;
 
 export declare const InlineEditableTextfield: (
   props: InlineEditableTextfieldProps,
-) => JSX.Element;
+) => jsx.JSX.Element;
 
 export declare interface InlineEditableTextfieldProps extends CommonProps {
   /** Sets height of the text field to compact. The top and bottom padding is decreased. */

package/types/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/entry-points/types.js",
   "module:es2019": "../dist/es2019/entry-points/types.js",
   "sideEffects": false,
-  "types": "../dist/types/entry-points/types.d.ts"
+  "types": "../dist/types/entry-points/types.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/entry-points/types.d.ts"
+      ]
+    }
+  }
 }