@atlaskit/popper 7.2.0 → 8.0.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @atlaskit/popper
 
+## 8.0.0
+
+### Major Changes
+
+- [`f2dc9097319f0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f2dc9097319f0) - ###
+  Dropped support for _legacy_ Typescript 4 types. **Typescript 5 is now the new minimum**.
+
+  Removes the `typesVersions` property and `dist/types-ts4.5` directory from the dist.
+
+  Types are now exclusively via the `"types": "dist/types/index.d.ts"` property.
+
+  ```diff
+  - "typesVersions": {
+  -    ">=4.5 <4.9": {
+  -        "*": [
+  -            "dist/types-ts4.5/*",
+  -            "dist/types-ts4.5/index.d.ts"
+  -        ]
+  -    }
+  - },
+  ```
+
 ## 7.2.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/popper",
-	"version": "7.2.0",
+	"version": "8.0.0",
 	"description": "A wrapper for React Popper for situations which require a bespoke popup where other ADS components are deemed unsuitable",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -42,18 +42,19 @@
 		"@af/accessibility-testing": "workspace:^",
 		"@af/integration-testing": "workspace:^",
 		"@af/visual-regression": "workspace:^",
-		"@atlaskit/button": "^23.11.0",
-		"@atlaskit/docs": "^11.8.0",
-		"@atlaskit/ds-lib": "^7.0.0",
-		"@atlaskit/link": "^3.4.0",
-		"@atlaskit/section-message": "^8.12.0",
-		"@atlaskit/tokens": "^13.0.0",
+		"@atlaskit/button": "^24.0.0",
+		"@atlaskit/docs": "^12.0.0",
+		"@atlaskit/ds-lib": "^8.0.0",
+		"@atlaskit/link": "^4.0.0",
+		"@atlaskit/section-message": "^9.0.0",
+		"@atlaskit/tokens": "^14.0.0",
 		"@atlassian/react-compiler-gating": "workspace:^",
 		"@atlassian/ssr-tests": "workspace:^",
 		"@atlassian/structured-docs-types": "workspace:^",
 		"@compiled/react": "^0.20.0",
 		"@testing-library/react": "^16.3.0",
 		"@testing-library/user-event": "^14.4.3",
+		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-lorem-component": "^0.13.0"
 	},
@@ -81,13 +82,5 @@
 			]
 		}
 	},
-	"typesVersions": {
-		">=4.5 <4.9": {
-			"*": [
-				"dist/types-ts4.5/*",
-				"dist/types-ts4.5/index.d.ts"
-			]
-		}
-	},
 	"homepage": "https://atlassian.design/components/popper"
 }

package/popper/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "**/*.compiled.css"
   ],
-  "types": "../dist/types/entry-points/popper.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/entry-points/popper.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/entry-points/popper.d.ts"
 }

package/popper.docs.tsx

@@ -1,46 +1,48 @@
 import path from 'path';
 
-import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
+import type { StructuredContentSource } from '@atlassian/structured-docs-types/types';
 
-const documentation: ComponentStructuredContentSource[] = [
-	{
-		name: 'Popper',
-		description: 'A component for positioning elements relative to other elements.',
-		status: 'general-availability',
-		import: {
+const documentation: StructuredContentSource = {
+	components: [
+		{
 			name: 'Popper',
-			package: '@atlaskit/popper',
-			type: 'named',
-			packagePath: path.resolve(__dirname),
-			packageJson: require('./package.json'),
-		},
-		usageGuidelines: [
-			'Use for positioning overlays and tooltips',
-			'Consider positioning constraints',
-			'Handle responsive positioning',
-			'Use appropriate z-index management',
-		],
-		contentGuidelines: [
-			'Ensure positioned content is accessible',
-			'Use appropriate positioning strategies',
-			'Consider content visibility and readability',
-		],
-		accessibilityGuidelines: [
-			'Ensure proper positioning and visibility',
-			'Consider screen reader accessibility',
-			'Use appropriate ARIA attributes',
-			'Handle focus management',
-		],
-		examples: [
-			{
-				name: '00 Basic Positioning',
-				description: '00 Basic Positioning example',
-				source: path.resolve(__dirname, './examples/00-basic-positioning.tsx'),
+			description: 'A component for positioning elements relative to other elements.',
+			status: 'general-availability',
+			import: {
+				name: 'Popper',
+				package: '@atlaskit/popper',
+				type: 'named',
+				packagePath: path.resolve(__dirname),
+				packageJson: require('./package.json'),
 			},
-		],
-		keywords: ['popper', 'positioning', 'tooltip', 'popup', 'overlay'],
-		categories: ['utility'],
-	},
-];
+			usageGuidelines: [
+				'Use for positioning overlays and tooltips',
+				'Consider positioning constraints',
+				'Handle responsive positioning',
+				'Use appropriate z-index management',
+			],
+			contentGuidelines: [
+				'Ensure positioned content is accessible',
+				'Use appropriate positioning strategies',
+				'Consider content visibility and readability',
+			],
+			accessibilityGuidelines: [
+				'Ensure proper positioning and visibility',
+				'Consider screen reader accessibility',
+				'Use appropriate ARIA attributes',
+				'Handle focus management',
+			],
+			examples: [
+				{
+					name: '00 Basic Positioning',
+					description: '00 Basic Positioning example',
+					source: path.resolve(__dirname, './examples/00-basic-positioning.tsx'),
+				},
+			],
+			keywords: ['popper', 'positioning', 'tooltip', 'popup', 'overlay'],
+			categories: ['utility'],
+		},
+	],
+};
 
 export default documentation;

package/react-popper/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "**/*.compiled.css"
   ],
-  "types": "../dist/types/entry-points/react-popper.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/entry-points/react-popper.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/entry-points/react-popper.d.ts"
 }

package/dist/types-ts4.5/entry-points/popper.d.ts

@@ -1,2 +0,0 @@
-export { Popper, placements } from '../popper';
-export type { CustomPopperProps, ManagerProps, Modifier, Placement, PopperArrowProps, PopperChildrenProps, PopperProps, ReferenceProps, StrictModifier, VirtualElement, } from '../popper';

package/dist/types-ts4.5/entry-points/react-popper.d.ts

@@ -1 +0,0 @@
-export { Manager, Reference } from 'react-popper';

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

@@ -1,3 +0,0 @@
-export { Popper, placements } from './popper';
-export type { ManagerProps, ReferenceProps, PopperProps, PopperArrowProps, PopperChildrenProps, StrictModifier, Modifier, Placement, CustomPopperProps, } from './popper';
-export { Manager, Reference } from 'react-popper';

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

@@ -1,29 +0,0 @@
-import type { ModifierArguments } from '@popperjs/core';
-export declare function getMaxSizeModifiers({ viewportPadding }: {
-    viewportPadding: number;
-}): [
-    {
-        /**
-         * Performing DOM measurements in the 'read' phase,
-         * which is the convention for popper modifiers
-         */
-        readonly name: 'maxSizeData';
-        readonly enabled: true;
-        readonly phase: 'read';
-        readonly fn: ({ state, name }: ModifierArguments<any>) => void;
-    },
-    {
-        /**
-         * Applying max size CSS
-         */
-        readonly name: 'maxSize';
-        readonly enabled: true;
-        readonly phase: 'beforeWrite';
-        readonly requiresIfExists: [
-            'offset',
-            'preventOverflow',
-            'flip'
-        ];
-        readonly fn: ({ state }: ModifierArguments<any>) => void;
-    }
-];

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

@@ -1,44 +0,0 @@
-import React from 'react';
-import { type Placement, type VirtualElement } from '@popperjs/core';
-import { type PopperChildrenProps, type PopperProps } from 'react-popper';
-export { placements } from '@popperjs/core';
-export type { Placement, VirtualElement } from '@popperjs/core';
-export type { ManagerProps, ReferenceProps, PopperProps, PopperArrowProps, PopperChildrenProps, StrictModifier, Modifier, } from 'react-popper';
-type Offset = [
-    number | null | undefined,
-    number | null | undefined
-];
-export interface CustomPopperProps<Modifiers> {
-    /**
-     * Returns the element to be positioned.
-     */
-    children?: (childrenProps: PopperChildrenProps) => React.ReactNode;
-    /**
-     * Distance the popup should be offset from the reference in the format of [along, away] (units in px).
-     * Defaults to [0, 8] - which means the popup will be 8px away from the edge of the reference specified
-     * by the `placement` prop.
-     */
-    offset?: Offset;
-    /**
-     * Which side of the Reference to show on.
-     */
-    placement?: Placement;
-    /**
-     * Replacement reference element to position popper relative to.
-     */
-    referenceElement?: HTMLElement | VirtualElement;
-    /**
-     * Additional modifiers and modifier overwrites.
-     */
-    modifiers?: PopperProps<Modifiers>['modifiers'];
-    /**
-     * Placement strategy used. Can be 'fixed' or 'absolute'
-     */
-    strategy?: PopperProps<Modifiers>['strategy'];
-    /**
-     * Determines if the popper will have a `max-width` and `max-height` set to
-     * constrain it to the viewport.
-     */
-    shouldFitViewport?: boolean;
-}
-export declare function Popper<CustomModifiers>({ children, offset, placement, referenceElement, modifiers, strategy, shouldFitViewport, }: CustomPopperProps<CustomModifiers>): React.JSX.Element;

package/offerings.json

@@ -1,33 +0,0 @@
-[
-	{
-		"name": "Popper",
-		"package": "@atlaskit/popper",
-		"import": {
-			"name": "Popper",
-			"package": "@atlaskit/popper",
-			"type": "named"
-		},
-		"keywords": ["popper", "positioning", "tooltip", "popup", "overlay"],
-		"categories": ["utility"],
-		"shortDescription": "A component for positioning elements relative to other elements.",
-		"status": "general-availability",
-		"accessibilityGuidelines": [
-			"Ensure proper positioning and visibility",
-			"Consider screen reader accessibility",
-			"Use appropriate ARIA attributes",
-			"Handle focus management"
-		],
-		"usageGuidelines": [
-			"Use for positioning overlays and tooltips",
-			"Consider positioning constraints",
-			"Handle responsive positioning",
-			"Use appropriate z-index management"
-		],
-		"contentGuidelines": [
-			"Ensure positioned content is accessible",
-			"Use appropriate positioning strategies",
-			"Consider content visibility and readability"
-		],
-		"examples": ["./examples/00-basic-positioning.tsx"]
-	}
-]