@atlaskit/top-layer 6.1.0 → 6.1.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/top-layer
 
+## 6.1.1
+
+### Patch Changes
+
+- [`1849f66e0bf17`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1849f66e0bf17) -
+  Remove an unused internal focus helper and fix stale README examples and import paths.
+- Updated dependencies
+
 ## 6.1.0
 
 ### Minor Changes

package/README.md

@@ -12,14 +12,15 @@ placement or size — compose it with the `useAnchoredPopover` hook when you nee
 content.
 
 ```tsx
-import { useRef } from 'react';
+import { useRef, useState } from 'react';
 import { getAriaForTrigger } from '@atlaskit/top-layer/get-aria-for-trigger';
-import { Popover } from '@atlaskit/top-layer/popover';
+import { Popover } from '@atlaskit/top-layer/popover/popover';
 import { PopoverSurface } from '@atlaskit/top-layer/popover-surface';
 import { usePopoverId } from '@atlaskit/top-layer/use-popover-id';
 import { useAnchoredPopover } from '@atlaskit/top-layer/use-anchored-popover';
 
-function MyPopup({ isOpen, onClose }: { isOpen: boolean; onClose: () => void }) {
+function MyPopup() {
+	const [isOpen, setIsOpen] = useState(false);
 	const triggerRef = useRef<HTMLButtonElement>(null);
 	const popoverRef = useRef<HTMLDivElement>(null);
 	const popoverId = usePopoverId();
@@ -35,7 +36,7 @@ function MyPopup({ isOpen, onClose }: { isOpen: boolean; onClose: () => void })
 		<>
 			<button
 				ref={triggerRef}
-				onClick={() => popoverRef.current?.togglePopover()}
+				onClick={() => setIsOpen((value) => !value)}
 				{...getAriaForTrigger({ role: 'dialog', isOpen, popoverId })}
 			>
 				Open
@@ -47,7 +48,7 @@ function MyPopup({ isOpen, onClose }: { isOpen: boolean; onClose: () => void })
 				label="Settings"
 				isOpen={isOpen}
 				shouldAnimate
-				onClose={onClose}
+				onClose={() => setIsOpen(false)}
 			>
 				<PopoverSurface>Content here</PopoverSurface>
 			</Popover>
@@ -72,27 +73,24 @@ function MyPopup({ isOpen, onClose }: { isOpen: boolean; onClose: () => void })
 
 ## Dialog
 
-Compound component for modal dialogs using the native `<dialog>` element with `.showModal()`.
+A modal dialog on the native `<dialog>` element. `isOpen` calls `showModal()` and `close()`. It has
+no visual opinions (no width, surface or layout); consumers such as `@atlaskit/modal-dialog` add
+their own. A `label` or `labelledBy` is required.
 
 ```tsx
-{
-	isOpen && (
-		<Dialog onClose={handleClose} width="medium">
-			<Dialog.Content>
-				<Dialog.Surface>
-					<Dialog.Header>
-						<Dialog.Title>Heading</Dialog.Title>
-						<Dialog.CloseButton />
-					</Dialog.Header>
-					<Dialog.Body>Content</Dialog.Body>
-					<Dialog.Footer>Actions</Dialog.Footer>
-				</Dialog.Surface>
-			</Dialog.Content>
-		</Dialog>
-	);
-}
+import { Dialog } from '@atlaskit/top-layer/dialog-content';
+
+<Dialog isOpen={isOpen} onClose={() => setIsOpen(false)} labelledBy={titleId}>
+	<h2 id={titleId}>Heading</h2>
+	Content
+</Dialog>;
 ```
 
+- `onClose({ reason })` fires after an allowed Escape (`'escape'`) or backdrop click
+  (`'overlay-click'`). Set `isOpen={false}` in response.
+- `dismissedBy` limits user dismissal: `'escape-and-outside-click'` (default), `'escape'` or
+  `'none'`.
+
 ## Animations
 
 Both `Popover` and `Dialog` support CSS-based entry/exit animations via the `shouldAnimate` prop.
@@ -106,9 +104,9 @@ for entry and
 Pass `shouldAnimate` to enable the default popover entry and exit animation:
 
 ```tsx
-import { Popover } from '@atlaskit/top-layer/popover';
+import { Popover } from '@atlaskit/top-layer/popover/popover';
 
-<Popover shouldAnimate role="dialog" label="My popover" isOpen={isOpen}>
+<Popover shouldAnimate role="dialog" label="My popover" isOpen={isOpen} onClose={onClose}>
 	Content
 </Popover>;
 ```
@@ -124,7 +122,7 @@ the phase-specific animation styles.
 Pass `shouldAnimate` to enable the default dialog entry and exit animation:
 
 ```tsx
-import { Dialog } from '@atlaskit/top-layer/dialog';
+import { Dialog } from '@atlaskit/top-layer/dialog-content';
 
 <Dialog shouldAnimate isOpen={isOpen} onClose={onClose} label="My dialog">
 	Content

package/dist/cjs/dialog/create-close-event.js

@@ -16,7 +16,8 @@ exports.createCloseEvent = createCloseEvent;
  *
  * @example
  * ```tsx
- * import { createCloseEvent, type TDialogCloseReason } from '@atlaskit/top-layer/dialog';
+ * import { createCloseEvent } from '@atlaskit/top-layer/create-close-event';
+ * import { type TDialogCloseReason } from '@atlaskit/top-layer/dialog/types';
  *
  * function onDialogClose({ reason }: { reason: TDialogCloseReason }) {
  *   legacyOnClose(createCloseEvent({ reason }));

package/dist/cjs/internal/use-focus-wrap.js

@@ -27,7 +27,7 @@ var _isNestedLayerFocused = require("../focus/is-nested-layer-focused");
  * impossible to implement generically here. The consumer component
  * (e.g. `dropdown-menu`) owns all menu keyboard navigation.
  *
- * See: notes/outputs/menu-keyboard-decision.md
+ * See: notes/decisions/menu-keyboard.md
  */
 function roleRequiresFocusWrap(role) {
   return role === 'dialog' || role === 'alertdialog';

package/dist/cjs/internal/use-initial-focus.js

@@ -150,7 +150,7 @@ function getInitialFocusTarget(_ref2) {
     // type-ahead, Enter/Space, submenu coordination) is the responsibility
     // of the consumer component (e.g. dropdown-menu), because menu keyboard
     // behavior varies by context (orientation, nesting, item type, control
-    // pattern). See: notes/outputs/menu-keyboard-decision.md
+    // pattern). See: notes/decisions/menu-keyboard.md
     return (0, _getFirstFocusable.getFirstFocusable)({
       container: container
     });

package/dist/cjs/placement-map/index.js

@@ -43,7 +43,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
  *
  * @example
  * ```ts
- * import { fromLegacyPlacement } from '@atlaskit/top-layer/placement-map';
+ * import { fromLegacyPlacement } from '@atlaskit/top-layer/placement-map/index';
  *
  * // In a migration from @atlaskit/popup:
  * const oldPlacement: TLegacyPlacement = 'bottom-start';

package/dist/cjs/popover/create-close-event.js

@@ -18,7 +18,8 @@ exports.createPopoverCloseEvent = createPopoverCloseEvent;
  *
  * @example
  * ```tsx
- * import { createPopoverCloseEvent, type TPopoverCloseReason } from '@atlaskit/top-layer/popover';
+ * import { createPopoverCloseEvent } from '@atlaskit/top-layer/popover/create-close-event';
+ * import { type TPopoverCloseReason } from '@atlaskit/top-layer/popover/types';
  *
  * function onPopoverClose({ reason }: { reason: TPopoverCloseReason }) {
  *   legacyOnClose(createPopoverCloseEvent({ reason }));

package/dist/cjs/use-arrow-navigation/use-arrow-navigation.js

@@ -53,7 +53,8 @@ var menuScope = '[role="menu"]';
  *
  * @example With nested menu filter
  * ```tsx
- * import { useArrowNavigation, isAtCurrentMenuLevel } from '@atlaskit/top-layer/use-arrow-navigation';
+ * import { isAtCurrentMenuLevel } from '@atlaskit/top-layer/is-at-current-menu-level';
+ * import { useArrowNavigation } from '@atlaskit/top-layer/use-arrow-navigation/use-arrow-navigation';
  *
  * useArrowNavigation({
  *   containerRef: menuRef,

package/dist/es2019/dialog/create-close-event.js

@@ -10,7 +10,8 @@
  *
  * @example
  * ```tsx
- * import { createCloseEvent, type TDialogCloseReason } from '@atlaskit/top-layer/dialog';
+ * import { createCloseEvent } from '@atlaskit/top-layer/create-close-event';
+ * import { type TDialogCloseReason } from '@atlaskit/top-layer/dialog/types';
  *
  * function onDialogClose({ reason }: { reason: TDialogCloseReason }) {
  *   legacyOnClose(createCloseEvent({ reason }));

package/dist/es2019/internal/use-focus-wrap.js

@@ -21,7 +21,7 @@ import { isNestedLayerFocused } from '../focus/is-nested-layer-focused';
  * impossible to implement generically here. The consumer component
  * (e.g. `dropdown-menu`) owns all menu keyboard navigation.
  *
- * See: notes/outputs/menu-keyboard-decision.md
+ * See: notes/decisions/menu-keyboard.md
  */
 function roleRequiresFocusWrap(role) {
   return role === 'dialog' || role === 'alertdialog';

package/dist/es2019/internal/use-initial-focus.js

@@ -144,7 +144,7 @@ function getInitialFocusTarget({
     // type-ahead, Enter/Space, submenu coordination) is the responsibility
     // of the consumer component (e.g. dropdown-menu), because menu keyboard
     // behavior varies by context (orientation, nesting, item type, control
-    // pattern). See: notes/outputs/menu-keyboard-decision.md
+    // pattern). See: notes/decisions/menu-keyboard.md
     return getFirstFocusable({
       container
     });

package/dist/es2019/placement-map/index.js

@@ -33,7 +33,7 @@ import { placementMapping } from './placement-mapping';
  *
  * @example
  * ```ts
- * import { fromLegacyPlacement } from '@atlaskit/top-layer/placement-map';
+ * import { fromLegacyPlacement } from '@atlaskit/top-layer/placement-map/index';
  *
  * // In a migration from @atlaskit/popup:
  * const oldPlacement: TLegacyPlacement = 'bottom-start';

package/dist/es2019/popover/create-close-event.js

@@ -12,7 +12,8 @@
  *
  * @example
  * ```tsx
- * import { createPopoverCloseEvent, type TPopoverCloseReason } from '@atlaskit/top-layer/popover';
+ * import { createPopoverCloseEvent } from '@atlaskit/top-layer/popover/create-close-event';
+ * import { type TPopoverCloseReason } from '@atlaskit/top-layer/popover/types';
  *
  * function onPopoverClose({ reason }: { reason: TPopoverCloseReason }) {
  *   legacyOnClose(createPopoverCloseEvent({ reason }));

package/dist/es2019/use-arrow-navigation/use-arrow-navigation.js

@@ -47,7 +47,8 @@ const menuScope = '[role="menu"]';
  *
  * @example With nested menu filter
  * ```tsx
- * import { useArrowNavigation, isAtCurrentMenuLevel } from '@atlaskit/top-layer/use-arrow-navigation';
+ * import { isAtCurrentMenuLevel } from '@atlaskit/top-layer/is-at-current-menu-level';
+ * import { useArrowNavigation } from '@atlaskit/top-layer/use-arrow-navigation/use-arrow-navigation';
  *
  * useArrowNavigation({
  *   containerRef: menuRef,

package/dist/esm/dialog/create-close-event.js

@@ -10,7 +10,8 @@
  *
  * @example
  * ```tsx
- * import { createCloseEvent, type TDialogCloseReason } from '@atlaskit/top-layer/dialog';
+ * import { createCloseEvent } from '@atlaskit/top-layer/create-close-event';
+ * import { type TDialogCloseReason } from '@atlaskit/top-layer/dialog/types';
  *
  * function onDialogClose({ reason }: { reason: TDialogCloseReason }) {
  *   legacyOnClose(createCloseEvent({ reason }));

package/dist/esm/internal/use-focus-wrap.js

@@ -21,7 +21,7 @@ import { isNestedLayerFocused } from '../focus/is-nested-layer-focused';
  * impossible to implement generically here. The consumer component
  * (e.g. `dropdown-menu`) owns all menu keyboard navigation.
  *
- * See: notes/outputs/menu-keyboard-decision.md
+ * See: notes/decisions/menu-keyboard.md
  */
 function roleRequiresFocusWrap(role) {
   return role === 'dialog' || role === 'alertdialog';

package/dist/esm/internal/use-initial-focus.js

@@ -144,7 +144,7 @@ function getInitialFocusTarget(_ref2) {
     // type-ahead, Enter/Space, submenu coordination) is the responsibility
     // of the consumer component (e.g. dropdown-menu), because menu keyboard
     // behavior varies by context (orientation, nesting, item type, control
-    // pattern). See: notes/outputs/menu-keyboard-decision.md
+    // pattern). See: notes/decisions/menu-keyboard.md
     return getFirstFocusable({
       container: container
     });

package/dist/esm/placement-map/index.js

@@ -37,7 +37,7 @@ import { placementMapping } from './placement-mapping';
  *
  * @example
  * ```ts
- * import { fromLegacyPlacement } from '@atlaskit/top-layer/placement-map';
+ * import { fromLegacyPlacement } from '@atlaskit/top-layer/placement-map/index';
  *
  * // In a migration from @atlaskit/popup:
  * const oldPlacement: TLegacyPlacement = 'bottom-start';

package/dist/esm/popover/create-close-event.js

@@ -12,7 +12,8 @@
  *
  * @example
  * ```tsx
- * import { createPopoverCloseEvent, type TPopoverCloseReason } from '@atlaskit/top-layer/popover';
+ * import { createPopoverCloseEvent } from '@atlaskit/top-layer/popover/create-close-event';
+ * import { type TPopoverCloseReason } from '@atlaskit/top-layer/popover/types';
  *
  * function onPopoverClose({ reason }: { reason: TPopoverCloseReason }) {
  *   legacyOnClose(createPopoverCloseEvent({ reason }));

package/dist/esm/use-arrow-navigation/use-arrow-navigation.js

@@ -47,7 +47,8 @@ var menuScope = '[role="menu"]';
  *
  * @example With nested menu filter
  * ```tsx
- * import { useArrowNavigation, isAtCurrentMenuLevel } from '@atlaskit/top-layer/use-arrow-navigation';
+ * import { isAtCurrentMenuLevel } from '@atlaskit/top-layer/is-at-current-menu-level';
+ * import { useArrowNavigation } from '@atlaskit/top-layer/use-arrow-navigation/use-arrow-navigation';
  *
  * useArrowNavigation({
  *   containerRef: menuRef,

package/dist/types/dialog/create-close-event.d.ts

@@ -11,7 +11,8 @@ import type { TDialogCloseReason } from './types';
  *
  * @example
  * ```tsx
- * import { createCloseEvent, type TDialogCloseReason } from '@atlaskit/top-layer/dialog';
+ * import { createCloseEvent } from '@atlaskit/top-layer/create-close-event';
+ * import { type TDialogCloseReason } from '@atlaskit/top-layer/dialog/types';
  *
  * function onDialogClose({ reason }: { reason: TDialogCloseReason }) {
  *   legacyOnClose(createCloseEvent({ reason }));

package/dist/types/placement-map/index.d.ts

@@ -33,7 +33,7 @@ import type { TLegacyPlacement } from './legacy-placements';
  *
  * @example
  * ```ts
- * import { fromLegacyPlacement } from '@atlaskit/top-layer/placement-map';
+ * import { fromLegacyPlacement } from '@atlaskit/top-layer/placement-map/index';
  *
  * // In a migration from @atlaskit/popup:
  * const oldPlacement: TLegacyPlacement = 'bottom-start';

package/dist/types/popover/create-close-event.d.ts

@@ -13,7 +13,8 @@ import type { TPopoverCloseReason } from './types';
  *
  * @example
  * ```tsx
- * import { createPopoverCloseEvent, type TPopoverCloseReason } from '@atlaskit/top-layer/popover';
+ * import { createPopoverCloseEvent } from '@atlaskit/top-layer/popover/create-close-event';
+ * import { type TPopoverCloseReason } from '@atlaskit/top-layer/popover/types';
  *
  * function onPopoverClose({ reason }: { reason: TPopoverCloseReason }) {
  *   legacyOnClose(createPopoverCloseEvent({ reason }));

package/dist/types/use-arrow-navigation/use-arrow-navigation.d.ts

@@ -89,7 +89,8 @@ export type TUseArrowNavigationArgs = {
  *
  * @example With nested menu filter
  * ```tsx
- * import { useArrowNavigation, isAtCurrentMenuLevel } from '@atlaskit/top-layer/use-arrow-navigation';
+ * import { isAtCurrentMenuLevel } from '@atlaskit/top-layer/is-at-current-menu-level';
+ * import { useArrowNavigation } from '@atlaskit/top-layer/use-arrow-navigation/use-arrow-navigation';
  *
  * useArrowNavigation({
  *   containerRef: menuRef,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/top-layer",
-	"version": "6.1.0",
+	"version": "6.1.1",
 	"description": "Low-level layering primitives based on popover and dialog",
 	"homepage": "https://atlassian.design/components/top-layer",
 	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
@@ -40,7 +40,7 @@
 		"@atlaskit/ds-lib": "^8.0.0",
 		"@atlaskit/layering": "^6.0.0",
 		"@atlaskit/react-compiler-gating": "^0.2.0",
-		"@atlaskit/tokens": "^20.1.0",
+		"@atlaskit/tokens": "^20.3.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^1.0.2",
 		"bind-event-listener": "^3.0.0",
@@ -54,7 +54,7 @@
 		"@af/integration-testing": "workspace:^",
 		"@af/visual-regression": "workspace:^",
 		"@atlaskit/button": "^25.4.0",
-		"@atlaskit/checkbox": "^19.2.0",
+		"@atlaskit/checkbox": "^19.3.0",
 		"@atlaskit/heading": "^8.0.0",
 		"@atlaskit/lozenge": "^17.0.0",
 		"@atlaskit/pragmatic-drag-and-drop": "^4.0.0",

package/dist/cjs/internal/should-focus-into-popover.js

@@ -1,19 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.shouldFocusIntoPopover = shouldFocusIntoPopover;
-var rolesThatMoveFocus = new Set(['dialog', 'alertdialog', 'menu', 'listbox', 'tree', 'grid']);
-
-/**
- * Returns `true` when the given popover role moves focus into the popover
- * on open, and `false` otherwise (including when `role` is `undefined`).
- */
-function shouldFocusIntoPopover(_ref) {
-  var role = _ref.role;
-  if (!role) {
-    return false;
-  }
-  return rolesThatMoveFocus.has(role);
-}

package/dist/es2019/internal/should-focus-into-popover.js

@@ -1,14 +0,0 @@
-const rolesThatMoveFocus = new Set(['dialog', 'alertdialog', 'menu', 'listbox', 'tree', 'grid']);
-
-/**
- * Returns `true` when the given popover role moves focus into the popover
- * on open, and `false` otherwise (including when `role` is `undefined`).
- */
-export function shouldFocusIntoPopover({
-  role
-}) {
-  if (!role) {
-    return false;
-  }
-  return rolesThatMoveFocus.has(role);
-}

package/dist/esm/internal/should-focus-into-popover.js

@@ -1,13 +0,0 @@
-var rolesThatMoveFocus = new Set(['dialog', 'alertdialog', 'menu', 'listbox', 'tree', 'grid']);
-
-/**
- * Returns `true` when the given popover role moves focus into the popover
- * on open, and `false` otherwise (including when `role` is `undefined`).
- */
-export function shouldFocusIntoPopover(_ref) {
-  var role = _ref.role;
-  if (!role) {
-    return false;
-  }
-  return rolesThatMoveFocus.has(role);
-}

package/dist/types/internal/should-focus-into-popover.d.ts

@@ -1,8 +0,0 @@
-import type { TRoleRequiringAccessibleName, TRoleWithImplicitName } from './role-types';
-/**
- * Returns `true` when the given popover role moves focus into the popover
- * on open, and `false` otherwise (including when `role` is `undefined`).
- */
-export declare function shouldFocusIntoPopover({ role, }: {
-    role: TRoleRequiringAccessibleName | TRoleWithImplicitName | undefined;
-}): boolean;