@atlaskit/avatar-group 9.1.1 → 9.1.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/avatar-group
 
+## 9.1.3
+
+### Patch Changes
+
+- Updated dependencies
+
+## 9.1.2
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 9.1.1
 
 ### Patch Changes

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/avatar-group",
-	"version": "9.1.1",
+	"version": "9.1.3",
 	"sideEffects": false
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/avatar-group",
-	"version": "9.1.1",
+	"version": "9.1.3",
 	"sideEffects": false
 }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/avatar-group",
-	"version": "9.1.1",
+	"version": "9.1.3",
 	"sideEffects": false
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/avatar-group",
-  "version": "9.1.1",
+  "version": "9.1.3",
   "description": "An avatar group displays a number of avatars grouped together in a stack or grid.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,14 +12,6 @@
   "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.tsx",
   "atlassian": {
@@ -36,10 +28,10 @@
   },
   "dependencies": {
     "@atlaskit/avatar": "^21.1.0",
-    "@atlaskit/menu": "^1.3.0",
+    "@atlaskit/menu": "^1.4.0",
     "@atlaskit/popup": "^1.5.0",
     "@atlaskit/theme": "^12.2.0",
-    "@atlaskit/tokens": "^0.10.0",
+    "@atlaskit/tokens": "^0.12.0",
     "@atlaskit/tooltip": "^17.6.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1"
@@ -49,11 +41,11 @@
   },
   "devDependencies": {
     "@atlaskit/analytics-next": "^8.2.0",
-    "@atlaskit/button": "^16.3.0",
+    "@atlaskit/button": "^16.5.0",
     "@atlaskit/code": "^14.4.0",
     "@atlaskit/docs": "*",
     "@atlaskit/ds-lib": "^2.1.1",
-    "@atlaskit/form": "^8.6.0",
+    "@atlaskit/form": "^8.8.0",
     "@atlaskit/icon": "^21.11.0",
     "@atlaskit/modal-dialog": "^12.4.0",
     "@atlaskit/section-message": "^6.3.0",

package/report.api.md

@@ -1,8 +1,17 @@
-## API Report File for "@atlaskit/avatar-group".
+<!-- API Report Version: 2.2 -->
 
-> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
+## API Report File for "@atlaskit/avatar-group"
 
-[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
+
+- [Main Entry Types](#main-entry-types)
+
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
 
 ```ts
 import type { AnalyticsEvent } from '@atlaskit/analytics-next';
@@ -13,16 +22,8 @@ import { MouseEventHandler } from 'react';
 import type { ReactNode } from 'react';
 import { SizeType } from '@atlaskit/avatar';
 
-/**
- * __Avatar group__
- *
- * An avatar group displays a number of avatars grouped together in a stack or grid.
- *
- * - [Examples](https://atlassian.design/components/avatar-group/examples)
- * - [Code](https://atlassian.design/components/avatar-group/code)
- * - [Usage](https://atlassian.design/components/avatar-group/usage)
- */
-declare const AvatarGroup: ({
+// @public
+const AvatarGroup: ({
   appearance,
   avatar,
   borderColor,
@@ -40,131 +41,75 @@ declare const AvatarGroup: ({
 }: AvatarGroupProps) => jsx.JSX.Element;
 export default AvatarGroup;
 
-declare interface AvatarGroupItemProps {
+// @public (undocumented)
+interface AvatarGroupItemProps {
+  // (undocumented)
   avatar: AvatarProps;
+  // (undocumented)
+  index: number;
+  // (undocumented)
   isActive?: boolean;
+  // (undocumented)
   isHover?: boolean;
-  index: number;
+  // (undocumented)
   onAvatarClick?: onAvatarClickHandler;
+  // (undocumented)
   testId?: string;
 }
 
-declare interface AvatarGroupOverrides {
-  AvatarGroupItem?: {
+// @public (undocumented)
+interface AvatarGroupOverrides {
+  // (undocumented)
+  Avatar?: {
     render?: (
-      Component: ElementType<AvatarGroupItemProps>,
-      props: AvatarGroupItemProps,
+      Component: ElementType<AvatarProps>,
+      props: AvatarProps,
       index: number,
     ) => ReactNode;
   };
-  Avatar?: {
+  // (undocumented)
+  AvatarGroupItem?: {
     render?: (
-      Component: ElementType<AvatarProps>,
-      props: AvatarProps,
+      Component: ElementType<AvatarGroupItemProps>,
+      props: AvatarGroupItemProps,
       index: number,
     ) => ReactNode;
   };
 }
 
-export declare interface AvatarGroupProps {
-  /**
-   * Indicates the layout of the avatar-group.
-   * Avatars will either be overlapped in a stack, or
-   * laid out in an even grid formation
-   * Defaults to "stack".
-   */
+// @public (undocumented)
+export interface AvatarGroupProps {
   appearance?: 'grid' | 'stack';
-  /**
-   * Component used to render each avatar
-   */
   avatar?: ElementType<AvatarProps>;
-  /**
-   * The maximum number of avatars allowed in the list.
-   * Defaults to 5 when displayed as a stack,
-   * and 11 when displayed as a grid.
-   */
-  maxCount?: number;
-  /**
-   * Defines the size of the avatar.
-   * Defaults to "medium".
-   */
-  size?: SizeType;
-  /**
-   * Typically the background color that the avatar is presented on.
-   * Accepts any color argument that the CSS border-color property accepts.
-   */
   borderColor?: string;
-  /**
-   * Array of avatar data passed to each `avatar` component.
-   * These props will be spread on to the component passed into avatar.
-   */
+  boundariesElement?: 'scrollParent' | 'viewport' | 'window';
   data: Array<AvatarProps>;
-  /**
-   * Handle the click event on the avatar item.
-   * Note that if an onClick prop is provided as part of avatar data, it will take precedence over onAvatarClick.
-   */
+  isTooltipDisabled?: boolean;
+  label?: string;
+  maxCount?: number;
   onAvatarClick?: onAvatarClickHandler;
-  /**
-   * Take control of the click event on the more indicator.
-   * This will cancel the default dropdown behavior.
-   */
   onMoreClick?: MouseEventHandler;
-  /**
-   * Provide additional props to the MoreButton.
-   * Example use cases: altering tab order by providing tabIndex;
-   * adding onClick behaviour without losing the default dropdown
-   */
+  overrides?: AvatarGroupOverrides;
   showMoreButtonProps?: Partial<React.HTMLAttributes<HTMLElement>>;
-  /**
-   * Element the overflow popup should be attached to.
-   * Defaults to "viewport".
-   */
-  boundariesElement?: 'viewport' | 'window' | 'scrollParent';
-  /**
-   * A `testId` prop is provided for specified elements,
-   * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
-   * serving as a hook for automated tests.
-   */
-  /**
-   * Will set these elements when defined:
-   * - Container element - `{testId}--avatar-group`
-   * - Avatar items - `{testId}--avatar-{index}`
-   * - Overflow menu button - `{testId}--overflow-menu--trigger`
-   * - Overflow menu content - `{testId}--overflow-menu--content`
-   */
+  size?: SizeType;
   testId?: string;
-  /**
-   * Custom overrides for the composed components.
-   */
-  overrides?: AvatarGroupOverrides;
-  /**
-   * Disables tooltips
-   */
-  isTooltipDisabled?: boolean;
-  /**
-     Text to be used as aria-label for the list of avatars.
-     Screen reader announcement with default label, which is `avatar group`, is `list, avatar group, X items`.
-
-     The label should describe the `AvatarGroup`'s entities, for instance:
-     - `label="team members"`, screen reader announcement would be `list team members, X items`
-     - `label="reviewers"` screen reader announcement would be `list reviewers, X items`
-
-     When there are several AvatarGroups on the page you should use a unique label to let users distinguish different lists.
-     */
-  label?: string;
 }
 
-export declare type AvatarProps = AvatarPropTypes & {
+// @public (undocumented)
+export type AvatarProps = AvatarPropTypes & {
   name: string;
   enableTooltip?: boolean;
-  key?: string | number;
+  key?: number | string;
 };
 
-declare type onAvatarClickHandler = (
+// @public (undocumented)
+type onAvatarClickHandler = (
   event: React.MouseEvent,
   analyticsEvent: AnalyticsEvent | undefined,
   index: number,
 ) => void;
 
-export {};
+// (No @packageDocumentation comment for this package)
 ```
+
+<!--SECTION END: Main Entry Types-->

package/dist/types-ts4.0/components/avatar-group-item.d.ts

@@ -1,12 +0,0 @@
-import { FC } from 'react';
-import { AvatarProps, onAvatarClickHandler } from './types';
-export interface AvatarGroupItemProps {
-    avatar: AvatarProps;
-    isActive?: boolean;
-    isHover?: boolean;
-    index: number;
-    onAvatarClick?: onAvatarClickHandler;
-    testId?: string;
-}
-declare const AvatarGroupItem: FC<AvatarGroupItemProps>;
-export default AvatarGroupItem;

package/dist/types-ts4.0/components/avatar-group.d.ts

@@ -1,103 +0,0 @@
-/** @jsx jsx */
-import { ElementType, MouseEventHandler } from 'react';
-import { jsx } from '@emotion/react';
-import { SizeType } from '@atlaskit/avatar';
-import { AvatarGroupOverrides, AvatarProps, onAvatarClickHandler } from './types';
-export interface AvatarGroupProps {
-    /**
-     * Indicates the layout of the avatar-group.
-     * Avatars will either be overlapped in a stack, or
-     * laid out in an even grid formation
-     * Defaults to "stack".
-     */
-    appearance?: 'grid' | 'stack';
-    /**
-     * Component used to render each avatar
-     */
-    avatar?: ElementType<AvatarProps>;
-    /**
-     * The maximum number of avatars allowed in the list.
-     * Defaults to 5 when displayed as a stack,
-     * and 11 when displayed as a grid.
-     */
-    maxCount?: number;
-    /**
-     * Defines the size of the avatar.
-     * Defaults to "medium".
-     */
-    size?: SizeType;
-    /**
-     * Typically the background color that the avatar is presented on.
-     * Accepts any color argument that the CSS border-color property accepts.
-     */
-    borderColor?: string;
-    /**
-     * Array of avatar data passed to each `avatar` component.
-     * These props will be spread on to the component passed into avatar.
-     */
-    data: Array<AvatarProps>;
-    /**
-     * Handle the click event on the avatar item.
-     * Note that if an onClick prop is provided as part of avatar data, it will take precedence over onAvatarClick.
-     */
-    onAvatarClick?: onAvatarClickHandler;
-    /**
-     * Take control of the click event on the more indicator.
-     * This will cancel the default dropdown behavior.
-     */
-    onMoreClick?: MouseEventHandler;
-    /**
-     * Provide additional props to the MoreButton.
-     * Example use cases: altering tab order by providing tabIndex;
-     * adding onClick behaviour without losing the default dropdown
-     */
-    showMoreButtonProps?: Partial<React.HTMLAttributes<HTMLElement>>;
-    /**
-     * Element the overflow popup should be attached to.
-     * Defaults to "viewport".
-     */
-    boundariesElement?: 'viewport' | 'window' | 'scrollParent';
-    /**
-     * A `testId` prop is provided for specified elements,
-     * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
-     * serving as a hook for automated tests.
-     */
-    /**
-     * Will set these elements when defined:
-     * - Container element - `{testId}--avatar-group`
-     * - Avatar items - `{testId}--avatar-{index}`
-     * - Overflow menu button - `{testId}--overflow-menu--trigger`
-     * - Overflow menu content - `{testId}--overflow-menu--content`
-     */
-    testId?: string;
-    /**
-     * Custom overrides for the composed components.
-     */
-    overrides?: AvatarGroupOverrides;
-    /**
-     * Disables tooltips
-     */
-    isTooltipDisabled?: boolean;
-    /**
-      Text to be used as aria-label for the list of avatars.
-      Screen reader announcement with default label, which is `avatar group`, is `list, avatar group, X items`.
-  
-      The label should describe the `AvatarGroup`'s entities, for instance:
-      - `label="team members"`, screen reader announcement would be `list team members, X items`
-      - `label="reviewers"` screen reader announcement would be `list reviewers, X items`
-  
-      When there are several AvatarGroups on the page you should use a unique label to let users distinguish different lists.
-     */
-    label?: string;
-}
-/**
- * __Avatar group__
- *
- * An avatar group displays a number of avatars grouped together in a stack or grid.
- *
- * - [Examples](https://atlassian.design/components/avatar-group/examples)
- * - [Code](https://atlassian.design/components/avatar-group/code)
- * - [Usage](https://atlassian.design/components/avatar-group/usage)
- */
-declare const AvatarGroup: ({ appearance, avatar, borderColor, boundariesElement, data, isTooltipDisabled, maxCount, onAvatarClick, onMoreClick, overrides, showMoreButtonProps, size, testId, label, }: AvatarGroupProps) => jsx.JSX.Element;
-export default AvatarGroup;

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

@@ -1,8 +0,0 @@
-/** @jsx jsx */
-import { FC, ReactNode } from 'react';
-declare const Grid: FC<{
-    children: ReactNode;
-    testId?: string;
-    'aria-label': string;
-}>;
-export default Grid;

package/dist/types-ts4.0/components/more-indicator.d.ts

@@ -1,13 +0,0 @@
-/// <reference types="react" />
-import { AvatarClickEventHandler, AvatarPropTypes } from '@atlaskit/avatar';
-export interface MoreIndicatorProps extends AvatarPropTypes {
-    count: number;
-    'aria-controls'?: string;
-    'aria-expanded'?: boolean;
-    'aria-haspopup'?: boolean;
-    buttonProps: Partial<React.HTMLAttributes<HTMLElement>>;
-    onClick: AvatarClickEventHandler;
-    isActive: boolean;
-}
-declare const MoreIndicator: import("react").ForwardRefExoticComponent<MoreIndicatorProps & import("react").RefAttributes<HTMLButtonElement>>;
-export default MoreIndicator;

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

@@ -1,8 +0,0 @@
-/** @jsx jsx */
-import { FC, ReactNode } from 'react';
-declare const Stack: FC<{
-    children: ReactNode;
-    testId?: string;
-    'aria-label': string;
-}>;
-export default Stack;

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

@@ -1,21 +0,0 @@
-import type { ElementType, ReactNode } from 'react';
-import type { AnalyticsEvent } from '@atlaskit/analytics-next';
-import type { AvatarPropTypes } from '@atlaskit/avatar';
-import type { AvatarGroupItemProps } from './avatar-group-item';
-export declare type DeepRequired<T> = {
-    [P in keyof T]-?: Required<T[P]>;
-};
-export declare type AvatarProps = AvatarPropTypes & {
-    name: string;
-    enableTooltip?: boolean;
-    key?: string | number;
-};
-export interface AvatarGroupOverrides {
-    AvatarGroupItem?: {
-        render?: (Component: ElementType<AvatarGroupItemProps>, props: AvatarGroupItemProps, index: number) => ReactNode;
-    };
-    Avatar?: {
-        render?: (Component: ElementType<AvatarProps>, props: AvatarProps, index: number) => ReactNode;
-    };
-}
-export declare type onAvatarClickHandler = (event: React.MouseEvent, analyticsEvent: AnalyticsEvent | undefined, index: number) => void;

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

@@ -1,2 +0,0 @@
-import { AvatarProps } from './types';
-export declare const composeUniqueKey: (props: AvatarProps, index: number) => string | number;

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

@@ -1,3 +0,0 @@
-export { default } from './components/avatar-group';
-export type { AvatarGroupProps } from './components/avatar-group';
-export type { AvatarProps } from './components/types';