@atlaskit/smart-card 40.13.0 → 40.13.2

package/dist/types/view/FlexibleCard/components/blocks/action-group/types.d.ts

@@ -3,35 +3,35 @@ import { type SmartLinkDirection, type SmartLinkSize } from '../../../../../cons
 import { type ActionItem } from '../types';
 export type ActionGroupProps = {
     /**
-     * Determines the actions within the Action Group.
-     */
-    items: ActionItem[];
-    /**
-     * Determines the default size of the actions within the Action Group.
+     * Determines the default appearance of the Action Group.
      */
-    size?: SmartLinkSize;
+    appearance?: Appearance;
     /**
      * Determines the direction that the actions are rendered. Can be vertical
      * or horizontal.
      */
     direction?: SmartLinkDirection;
     /**
-     * Determines the default appearance of the Action Group.
-     */
-    appearance?: Appearance;
-    /**
-     * Determines the maximum number of singular actions that should be rendered
-     * before collapsing all actions into a Dropdown.
+     * Determines the actions within the Action Group.
      */
-    visibleButtonsNum?: number;
+    items: ActionItem[];
     /**
      * Called when the action dropdown menu (if present) is open/closed.
      */
     onDropdownOpenChange?: (isOpen: boolean) => void;
+    /**
+     * Determines the default size of the actions within the Action Group.
+     */
+    size?: SmartLinkSize;
     /**
      * 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
      */
     testId?: string;
+    /**
+     * Determines the maximum number of singular actions that should be rendered
+     * before collapsing all actions into a Dropdown.
+     */
+    visibleButtonsNum?: number;
 };

package/dist/types/view/FlexibleCard/components/blocks/element-group/types.d.ts

@@ -5,30 +5,30 @@ export type ElementGroupProps = PropsWithChildren<{
      * Determines the alignment of the Elements within. Can be left or right aligned.
      */
     align?: SmartLinkAlignment;
+    /**
+     * For compiled css
+     */
+    className?: string;
     /**
      * Determines the direction that the Elements are rendered. Can be Vertical or Horizontal.
      */
     direction?: SmartLinkDirection;
     /**
-     * Determines the default size of the Elements in the group.
+     * Determines the position of the elements within. Can be top or center position.
      */
-    size?: SmartLinkSize;
+    position?: SmartLinkPosition;
     /**
-     * Determines whether the container size will fit to the content or expand to the available width or the parent component.
-     * Similar to flex's flex-grow concept.
+     * Determines the default size of the Elements in the group.
      */
-    width?: SmartLinkWidth;
+    size?: SmartLinkSize;
     /**
      * 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
      */
     testId?: string;
     /**
-     * Determines the position of the elements within. Can be top or center position.
-     */
-    position?: SmartLinkPosition;
-    /**
-     * For compiled css
+     * Determines whether the container size will fit to the content or expand to the available width or the parent component.
+     * Similar to flex's flex-grow concept.
      */
-    className?: string;
+    width?: SmartLinkWidth;
 }>;

package/dist/types/view/FlexibleCard/components/blocks/footer-block/types.d.ts

@@ -8,15 +8,15 @@ export type FooterBlockProps = {
      */
     actions?: ActionItem[];
     /**
-     * Function to be called when footer action dropdown open state is changed.
+     * Allows rendering of the footer regardless of whether the block has resolved
      */
-    onActionMenuOpenChange?: (options: OnActionMenuOpenChangeOptions) => void;
+    alwaysShow?: boolean;
     /**
      * Allows hiding of the resources provider
      */
     hideProvider?: boolean;
     /**
-     * Allows rendering of the footer regardless of whether the block has resolved
+     * Function to be called when footer action dropdown open state is changed.
      */
-    alwaysShow?: boolean;
+    onActionMenuOpenChange?: (options: OnActionMenuOpenChangeOptions) => void;
 } & BlockProps;

package/dist/types/view/FlexibleCard/components/blocks/metadata-block/types.d.ts

@@ -1,5 +1,6 @@
 import { type BlockProps, type ElementItem } from '../types';
 export type MetadataBlockProps = {
+    className?: string;
     /**
      * Determines the number of lines the metadata should span across.
      * Default is 2. Maximum is 2.
@@ -23,5 +24,4 @@ export type MetadataBlockProps = {
      * @see ElementItem
      */
     secondary?: ElementItem[];
-    className?: string;
 } & BlockProps;

package/dist/types/view/FlexibleCard/components/blocks/preview-block/types.d.ts

@@ -11,14 +11,14 @@ export type PreviewBlockProps = {
      * @internal
      */
     onError?: () => void;
+    /**
+     * An image URL to render. This will replace the default image from smart link data.
+     */
+    overrideUrl?: string;
     /**
      * The placement of the preview block in relation of its container.
      * This makes the preview block leave flex layout to absolute positioning
      * to the left/right of the container.
      */
     placement?: MediaPlacement;
-    /**
-     * An image URL to render. This will replace the default image from smart link data.
-     */
-    overrideUrl?: string;
 } & BlockProps;

package/dist/types/view/FlexibleCard/components/blocks/snippet-block/types.d.ts

@@ -1,20 +1,20 @@
 import { type BlockProps } from '../types';
 export type SnippetBlockProps = {
+    /**
+     * The snippet block is rendered hidden at times, this just informs the component and the snippet renderer
+     */
+    isHidden?: boolean;
     /**
      * Determines the maximum lines the text within the snippet block should
      * spread over. Default is 3. Maximum is 3.
      */
     maxLines?: number;
-    /**
-     * The text to display. Overrides the default link description.
-     */
-    text?: string;
-    /**
-     * The snippet block is rendered hidden at times, this just informs the component and the snippet renderer
-     */
-    isHidden?: boolean;
     /**
      * Whether to show the footer of the snippet block.
      */
     showFooter?: boolean;
+    /**
+     * The text to display. Overrides the default link description.
+     */
+    text?: string;
 } & BlockProps;

package/dist/types/view/FlexibleCard/components/blocks/title-block/types.d.ts

@@ -12,14 +12,40 @@ export type TitleBlockProps = {
      * @see ActionItem
      */
     actions?: ActionItem[];
+    /**
+     * Ref passed into the link <a> element
+     */
+    anchorRef?: React.Ref<HTMLAnchorElement>;
     /**
      * Determines the href target behaviour of the Link.
      */
     anchorTarget?: AnchorTarget;
+    /**
+     * Competitor Prompt Component for Competitor link experiment
+     */
+    CompetitorPrompt?: React.ComponentType<{
+        linkType?: string;
+        sourceUrl: string;
+    }>;
+    /**
+     * Determines whether TitleBlock will hide the Link Icon.
+     */
+    hideIcon?: boolean;
+    /**
+     * This option determines whenever we show any of the links and messages on the right side of the block,
+     * like "connect to preview" or "Can't find link" or "Restricted link, try another account" etc.
+     * Default is false.
+     */
+    hideRetry?: boolean;
     /**
      * [Experiment] Determines whether the linked title should display tooltip on hover.
      */
     hideTitleTooltip?: boolean;
+    /**
+     * The icon to display in the title block. Overrides any icon that is retrieved from
+     * the Smart Link.
+     */
+    icon?: React.ReactNode;
     /**
      * Determines the maximum number of lines for the underlying link text to
      * spread over. Default is 2. Maximum is 2.
@@ -34,11 +60,20 @@ export type TitleBlockProps = {
      * @see ElementItem
      */
     metadata?: ElementItem[];
+    /**
+     * The vertical position of the metadata fields. Internal prop, please DO NOT USE.
+     * @internal
+     */
+    metadataPosition?: SmartLinkPosition;
     /**
      * Called when the action dropdown menu (if present) is open/closed.
      * Receives an object with `isOpen` state.
      */
     onActionMenuOpenChange?: (options: OnActionMenuOpenChangeOptions) => void;
+    /**
+     * A unique identifier for the placeholder loading state, which is constant across all loading states of the same item.
+     */
+    placeholderId?: string;
     /**
      * Determines the position of the link icon in relative to the vertical
      * height of the TitleBlock.  It can either be centred or placed on “top”.
@@ -50,12 +85,6 @@ export type TitleBlockProps = {
      * @internal
      */
     retry?: RetryOptions;
-    /**
-     * This option determines whenever we show any of the links and messages on the right side of the block,
-     * like "connect to preview" or "Can't find link" or "Restricted link, try another account" etc.
-     * Default is false.
-     */
-    hideRetry?: boolean;
     /**
      * Determines whether TitleBlock will hide actions until the user is hovering
      * over the link.
@@ -75,35 +104,6 @@ export type TitleBlockProps = {
      * the Smart Link.
      */
     text?: string;
-    /**
-     * The icon to display in the title block. Overrides any icon that is retrieved from
-     * the Smart Link.
-     */
-    icon?: React.ReactNode;
-    /**
-     * The vertical position of the metadata fields. Internal prop, please DO NOT USE.
-     * @internal
-     */
-    metadataPosition?: SmartLinkPosition;
-    /**
-     * Determines whether TitleBlock will hide the Link Icon.
-     */
-    hideIcon?: boolean;
-    /**
-     * Ref passed into the link <a> element
-     */
-    anchorRef?: React.Ref<HTMLAnchorElement>;
-    /**
-     * A unique identifier for the placeholder loading state, which is constant across all loading states of the same item.
-     */
-    placeholderId?: string;
-    /**
-     * Competitor Prompt Component for Competitor link experiment
-     */
-    CompetitorPrompt?: React.ComponentType<{
-        sourceUrl: string;
-        linkType?: string;
-    }>;
     /**
      * The URL of the link for Competitor Prompt experiment
      */

package/dist/types/view/FlexibleCard/components/blocks/types.d.ts

@@ -3,38 +3,27 @@ import { type ActionName, type ElementName, type SmartLinkDirection, type SmartL
 import { type ActionProps } from '../actions/action/types';
 export type BlockProps = {
     /**
-     * React children
+     * Ref to block wrapper div.
      */
-    children?: ReactNode | undefined;
+    blockRef?: Ref<HTMLDivElement>;
     /**
-     * The direction that the block should arrange its elements. Can be vertical
-     * or horizontal. Default is horizontal.
-     * @internal
+     * React children
      */
-    direction?: SmartLinkDirection;
+    children?: ReactNode | undefined;
     /**
      * For compiled css
      */
     className?: string;
     /**
-     * For dynamic styles
-     */
-    style?: React.CSSProperties;
-    /**
-     * The size of the block and the size that the underlying elements should
-     * default to.
-     */
-    size?: SmartLinkSize;
-    /**
-     * 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
+     * The direction that the block should arrange its elements. Can be vertical
+     * or horizontal. Default is horizontal.
+     * @internal
      */
-    testId?: string;
+    direction?: SmartLinkDirection;
     /**
-     * Ref to block wrapper div.
+     * For image icons in the title, whether to hide the loading skeleton while the image is loading.
      */
-    blockRef?: Ref<HTMLDivElement>;
+    hideIconLoadingSkeleton?: boolean;
     /**
      * Function to be called on render of block.
      * @internal
@@ -50,9 +39,20 @@ export type BlockProps = {
      */
     placeholderId?: string;
     /**
-     * For image icons in the title, whether to hide the loading skeleton while the image is loading.
+     * The size of the block and the size that the underlying elements should
+     * default to.
      */
-    hideIconLoadingSkeleton?: boolean;
+    size?: SmartLinkSize;
+    /**
+     * For dynamic styles
+     */
+    style?: React.CSSProperties;
+    /**
+     * 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
+     */
+    testId?: string;
 };
 /**
  * Used to represent a metadata element to be rendered.
@@ -73,6 +73,10 @@ export type ElementItem = {
  * Used to represent an Action when passing props into Flexible UI.
  */
 export type BaseActionItem = {
+    /**
+     * Determines the text content of the Action.
+     */
+    content?: React.ReactNode;
     /**
      * Determines whether the action should hide the text content of the button.
      */
@@ -85,6 +89,10 @@ export type BaseActionItem = {
      * Determines where the icon should be rendered if text is provided.
      */
     iconPosition?: 'before' | 'after';
+    /**
+     * Determines whether the button displays as disabled.
+     */
+    isDisabled?: boolean;
     /**
      * Determines the text and icon representation of the action, with exception
      * to CustomAction.
@@ -94,10 +102,6 @@ export type BaseActionItem = {
      * Determines the onClick behaviour of the action.
      */
     onClick: () => any;
-    /**
-     * Determines the text content of the Action.
-     */
-    content?: React.ReactNode;
     /**
      * Determines the size of the Action. Corresponds to an Action appearance.
      */
@@ -108,10 +112,6 @@ export type BaseActionItem = {
      * serving as a hook for automated tests
      */
     testId?: string;
-    /**
-     * Determines whether the button displays as disabled.
-     */
-    isDisabled?: boolean;
 };
 /**
  * Used to represent an Action which self-hydrates with data when passing props into Flexible UI.
@@ -125,6 +125,10 @@ export type BaseDataActionItem = {
      * Determines whether the action should hide the icon inside the button.
      */
     hideIcon?: boolean;
+    /**
+     * Determines whether the button displays as disabled.
+     */
+    isDisabled?: boolean;
     /**
      * Determines the text and icon representation of the action, with exception
      * to CustomAction.
@@ -145,10 +149,6 @@ export type BaseDataActionItem = {
      * serving as a hook for automated tests
      */
     testId?: string;
-    /**
-     * Determines whether the button displays as disabled.
-     */
-    isDisabled?: boolean;
 };
 /**
  * This represents an action that will render based on the data provided from the Smart Link.
@@ -172,9 +172,9 @@ export type NamedActionItem = BaseActionItem & {
  * This represents an action where either Icon or label must be provided.
  */
 export type CustomActionItem = BaseActionItem & {
-    name: ActionName.CustomAction;
-    href?: string;
     ariaLabel?: string;
+    href?: string;
+    name: ActionName.CustomAction;
 } & ((Required<Pick<ActionProps, 'icon' | 'iconPosition'>> & Pick<ActionProps, 'content'>) | ((Required<Pick<ActionProps, 'content'>> & Pick<ActionProps, 'icon' | 'iconPosition'>) & Pick<ActionProps, 'tooltipMessage'>));
 export type ActionItem = (NamedActionItem | NamedDataActionItem | CustomActionItem) & {
     entryPointWrapper?: React.FC<{
@@ -230,14 +230,14 @@ export type OwnedByGroup = {
  */
 export type AssignedToGroup = {
     name: ElementName.AssignedToGroup;
-    /**
-     * Shows a name prefix Assigned To in the Avatar tooltip.
-     */
-    showNamePrefix?: boolean;
     /**
      * Shows a default unassigned fallback avatar when no person is assigned.
      */
     showFallbackAvatar?: boolean;
+    /**
+     * Shows a name prefix Assigned To in the Avatar tooltip.
+     */
+    showNamePrefix?: boolean;
 };
 /**
  * Represents the props available for an ChecklistProgress element.
@@ -279,10 +279,10 @@ export type CreatedBy = {
  * @see OwnedBy
  */
 export type OwnedBy = {
+    fontSize?: 'font.body' | 'font.body.large' | 'font.body.small' | 'font.body.UNSAFE_small';
+    hideFormat?: boolean;
     name: ElementName.OwnedBy;
     textPrefix?: 'owned_by' | 'owned_by_override';
-    hideFormat?: boolean;
-    fontSize?: 'font.body' | 'font.body.large' | 'font.body.small' | 'font.body.UNSAFE_small';
 };
 /**
  * Represents the props available for an CreatedOn element.
@@ -334,12 +334,12 @@ export type ModifiedBy = {
  * @see ModifiedOn
  */
 export type ModifiedOn = {
+    fontSize?: 'font.body' | 'font.body.large' | 'font.body.small' | 'font.body.UNSAFE_small';
     name: ElementName.ModifiedOn;
     /**
      * A string which will be displayed before the specified element.
      */
     text?: string;
-    fontSize?: 'font.body' | 'font.body.large' | 'font.body.small' | 'font.body.UNSAFE_small';
 };
 /**
  * Represents the props available for an Preview element.
@@ -367,8 +367,8 @@ export type ProgrammingLanguage = {
  * @see Provider
  */
 export type Provider = {
-    name: ElementName.Provider;
     hideIcon?: boolean;
+    name: ElementName.Provider;
 };
 /**
  * Represents the props available for an ReactCount element.

package/dist/types/view/FlexibleCard/components/common/atlaskit-icon/types.d.ts

@@ -2,6 +2,6 @@ import { type IconType, type SmartLinkSize } from '../../../../../constants';
 export type AtlaskitIconProps = {
     icon: IconType;
     label?: string;
-    testId?: string;
     size?: SmartLinkSize;
+    testId?: string;
 };

package/dist/types/view/FlexibleCard/components/common/image-icon/types.d.ts

@@ -1,11 +1,11 @@
 export type ImageIconProps = {
+    appearance?: 'square' | 'round';
     defaultIcon?: React.ReactNode;
-    testId?: string;
-    url: string;
-    width?: string;
     height?: string;
+    hideLoadingSkeleton?: boolean;
     onError?: () => void;
     onLoad?: () => void;
-    appearance?: 'square' | 'round';
-    hideLoadingSkeleton?: boolean;
+    testId?: string;
+    url: string;
+    width?: string;
 };

package/dist/types/view/FlexibleCard/components/common/loading-skeleton/types.d.ts

@@ -1,4 +1,8 @@
 export type LoadingSkeletonProps = {
+    /**
+     * Height of loading skeleton, defaults to height of the parent element
+     */
+    height?: string;
     /**
      * A `testId` prop is provided for specified elements, which is a unique
      * string that appears as a data attribute `data-testid` in the rendered
@@ -9,8 +13,4 @@ export type LoadingSkeletonProps = {
      * Width of the loading skeleton, defaults to width of the parent element
      */
     width?: string;
-    /**
-     * Height of loading skeleton, defaults to height of the parent element
-     */
-    height?: string;
 };

package/dist/types/view/FlexibleCard/components/container/hover-card-control/types.d.ts

@@ -1,9 +1,9 @@
 import { type PropsWithChildren } from 'react';
 import { type ContainerProps } from '../types';
 export type HoverCardDelayProps = PropsWithChildren<Pick<ContainerProps, 'actionOptions' | 'hoverPreviewOptions'> & {
-    isHoverPreview?: boolean;
+    delay?: number;
     isAuthTooltip?: boolean;
+    isHoverPreview?: boolean;
     testId?: string;
     url: string;
-    delay?: number;
 }>;

package/dist/types/view/FlexibleCard/components/elements/common/base-avatar-group-element/index.d.ts

@@ -1,13 +1,13 @@
 import { type ElementProps } from '../../index';
 export type BaseAvatarItemProps = {
-    /**
-     * The image to be used in an `@atlaskit/avatar - this should be a url to the image src
-     */
-    src?: string;
     /**
      * The name of the person in the avatar.
      */
     name: string;
+    /**
+     * The image to be used in an `@atlaskit/avatar - this should be a url to the image src
+     */
+    src?: string;
 };
 export type BaseAvatarGroupElementProps = ElementProps & {
     /**
@@ -18,14 +18,14 @@ export type BaseAvatarGroupElementProps = ElementProps & {
      * The maximum number of Avatars to show in the AvatarGroup
      */
     maxCount?: number;
-    /**
-     * Shows a name prefix in the Avatar tooltip (Created by, Assigned To, Owned by)
-     */
-    showNamePrefix?: boolean;
     /**
      * Shows a default fallback avatar if no persons in the AvatarGroup.
      */
     showFallbackAvatar?: boolean;
+    /**
+     * Shows a name prefix in the Avatar tooltip (Created by, Assigned To, Owned by)
+     */
+    showNamePrefix?: boolean;
 };
 /**
  * A base element that displays a group of avatars.

package/dist/types/view/FlexibleCard/components/elements/common/base-badge-element/index.d.ts

@@ -10,6 +10,10 @@ export type BaseBadgeElementProps = ElementProps & {
      * Badge appearances
      */
     appearance?: 'default' | 'subtle';
+    /**
+     * Color of the text and badge
+     */
+    color?: string;
     /**
      * Determines whether the badge icon should be hidden. When set to true,
      * the badge will be displayed without the icon, showing only the label text.
@@ -20,24 +24,24 @@ export type BaseBadgeElementProps = ElementProps & {
      * then the badge icon will fallback to the URL provided.
      */
     icon?: IconType;
-    /**
-     * The icon from this URL will be used for the badge if no Atlaskit Icon is provided.
-     */
-    url?: string;
     /**
      * The text to display for the badge.
      */
     label?: string;
     /**
-     * Color of the text and badge
+     * The icon from this URL will be used for the badge if no Atlaskit Icon is provided.
      */
-    color?: string;
+    url?: string;
 };
 declare const _default: (props: ElementProps & {
     /**
      * Badge appearances
      */
     appearance?: "default" | "subtle";
+    /**
+     * Color of the text and badge
+     */
+    color?: string;
     /**
      * Determines whether the badge icon should be hidden. When set to true,
      * the badge will be displayed without the icon, showing only the label text.
@@ -48,18 +52,14 @@ declare const _default: (props: ElementProps & {
      * then the badge icon will fallback to the URL provided.
      */
     icon?: IconType;
-    /**
-     * The icon from this URL will be used for the badge if no Atlaskit Icon is provided.
-     */
-    url?: string;
     /**
      * The text to display for the badge.
      */
     label?: string;
     /**
-     * Color of the text and badge
+     * The icon from this URL will be used for the badge if no Atlaskit Icon is provided.
      */
-    color?: string;
+    url?: string;
 } & React.RefAttributes<HTMLElement> & {
     className?: string;
 }) => React.JSX.Element;