@atlaskit/smart-card 23.2.0 → 23.3.1

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

@@ -1,10 +0,0 @@
-import React from 'react';
-import { PreviewBlockProps } from './types';
-/**
- * Represents a PreviewBlock, which typically contains media or other large format content.
- * @public
- * @param {PreviewBlock} PreviewBlock
- * @see Block
- */
-declare const PreviewBlock: React.FC<PreviewBlockProps>;
-export default PreviewBlock;

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

@@ -1,8 +0,0 @@
-import { BlockProps } from '../types';
-export declare type PreviewBlockProps = {
-    /**
-     * Function to be called on error loading media.
-     * @internal
-     */
-    onError?: () => void;
-} & BlockProps;

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

@@ -1,10 +0,0 @@
-import React from 'react';
-import { SnippetBlockProps } from './types';
-/**
- * Represents a SnippetBlock, which is used to display longer form text content, like descriptions.
- * @public
- * @param {SnippetBlock} SnippetBlock
- * @see Block
- */
-declare const SnippetBlock: React.FC<SnippetBlockProps>;
-export default SnippetBlock;

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

@@ -1,8 +0,0 @@
-import { BlockProps } from '../types';
-export declare type SnippetBlockProps = {
-    /**
-     * Determines the maximum lines the text within the snippet block should
-     * spread over. Default is 3. Maximum is 3.
-     */
-    maxLines?: number;
-} & BlockProps;

package/dist/types-ts4.0/view/FlexibleCard/components/blocks/title-block/errored/index.d.ts

@@ -1,12 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { TitleBlockViewProps } from '../types';
-/**
- * Represents an Errored TitleBlock view.
- * This will render when a Smart Link did not successfully resolve.
- * This may be a result of a Smart Link not having the correct credentials,
- * or the backend response was errored or malformed.
- * @see TitleBlock
- */
-declare const TitleBlockErroredView: React.FC<TitleBlockViewProps>;
-export default TitleBlockErroredView;

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

@@ -1,16 +0,0 @@
-import React from 'react';
-import { TitleBlockProps } from './types';
-/**
- * Represents a TitleBlock, which is the foundation of Flexible UI.
- * This contains an icon, the link, and any associated metadata and actions in one block.
- * The TitleBlock will also render differently given the state of the smart link.
- * This can be found in the corresponding Resolving, Resolved and Errored views.
- * @public
- * @param {TitleBlockProps} TitleBlockProps
- * @see Block
- * @see TitleBlockResolvingView
- * @see TitleBlockResolvedView
- * @see TitleBlockErroredView
- */
-declare const TitleBlock: React.FC<TitleBlockProps>;
-export default TitleBlock;

package/dist/types-ts4.0/view/FlexibleCard/components/blocks/title-block/resolved/index.d.ts

@@ -1,9 +0,0 @@
-import React from 'react';
-import { TitleBlockViewProps } from '../types';
-/**
- * This renders a fully resolved TitleBlock.
- * This should render when a Smart Link returns a valid response.
- * @see TitleBlock
- */
-declare const TitleBlockResolvedView: React.FC<TitleBlockViewProps>;
-export default TitleBlockResolvedView;

package/dist/types-ts4.0/view/FlexibleCard/components/blocks/title-block/resolving/index.d.ts

@@ -1,11 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { TitleBlockViewProps } from '../types';
-/**
- * This represents a TitleBlock for a Smart Link that is currently waiting
- * for a request to finish.
- * This should render when a Smart Link has sent a request.
- * @see TitleBlock
- */
-declare const TitleBlockResolvingView: React.FC<TitleBlockViewProps>;
-export default TitleBlockResolvingView;

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

@@ -1,86 +0,0 @@
-import React from 'react';
-import { ActionItem, BlockProps, ElementItem, OnActionMenuOpenChangeOptions } from '../types';
-import { SmartLinkPosition, SmartLinkTheme } from '../../../../../constants';
-import { RetryOptions } from '../../../types';
-import { AnchorTarget } from '../../types';
-export declare type TitleBlockProps = {
-    /**
-     * An array of action items to be displayed after the title
-     * on the right of the block.
-     * An action item provides preset icon and label, with exception of
-     * a custom action which either Icon or label must be provided.
-     * @see ActionItem
-     */
-    actions?: ActionItem[];
-    /**
-     * Determines the href target behaviour of the Link.
-     */
-    anchorTarget?: AnchorTarget;
-    /**
-     * [Experiment] Determines whether the linked title should display tooltip on hover.
-     */
-    hideTitleTooltip?: boolean;
-    /**
-     * Determines the maximum number of lines for the underlying link text to
-     * spread over. Default is 2. Maximum is 2.
-     */
-    maxLines?: number;
-    /**
-     * An array of metadata elements to display in the TitleBlock.
-     * By default elements will be shown to the right of the TitleBlock.
-     * The visibility of the element is determine by the link data.
-     * If link contain no data to display a particular element, the element
-     * will simply not show up.
-     * @see ElementItem
-     */
-    metadata?: ElementItem[];
-    /**
-     * Called when the action dropdown menu (if present) is open/closed.
-     * Receives an object with `isOpen` state.
-     */
-    onActionMenuOpenChange?: (options: OnActionMenuOpenChangeOptions) => void;
-    /**
-     * 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”.
-     * Default is top.
-     */
-    position?: SmartLinkPosition;
-    /**
-     * Determines the onClick behaviour of the Link. By default used for analytics.
-     * @internal
-     */
-    onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
-    /**
-     * The options that determine the retry behaviour when a Smart Link errors.
-     * @internal
-     */
-    retry?: RetryOptions;
-    /**
-     * Determines whether TitleBlock will hide actions until the user is hovering
-     * over the link.
-     */
-    showActionOnHover?: boolean;
-    /**
-     * An array of metadata elements to display in the TitleBlock.
-     * By default elements will be shown below the link text.
-     * The visibility of the element is determine by the link data.
-     * If link contain no data to display a particular element, the element
-     * will simply not show up.
-     * @see ElementItem
-     */
-    subtitle?: ElementItem[];
-    /**
-     * The text to display in the link. Overrides any text that is retrieved from
-     * the Smart Link.
-     */
-    text?: string;
-    /**
-     * The theme of the link text. Can be Black or Link (default URL blue)
-     * @internal
-     */
-    theme?: SmartLinkTheme;
-} & BlockProps;
-export declare type TitleBlockViewProps = TitleBlockProps & {
-    actionGroup?: React.ReactNode;
-    title: React.ReactNode;
-};

package/dist/types-ts4.0/view/FlexibleCard/components/blocks/types.d.ts

@@ -1,300 +0,0 @@
-import { ActionName, ElementName, SmartLinkDirection, SmartLinkSize, SmartLinkStatus } from '../../../../constants';
-import { SerializedStyles } from '@emotion/react';
-import { ActionProps } from '../actions/action/types';
-import { Ref } from 'react';
-export declare type BlockProps = {
-    /**
-     * The direction that the block should arrange it's elements. Can be vertical
-     * or horizontal. Default is horizontal.
-     * @internal
-     */
-    direction?: SmartLinkDirection;
-    /**
-     * Any additional CSS properties to apply to the block.
-     */
-    overrideCss?: SerializedStyles;
-    /**
-     * The size of the block and the size that the underlying elements should
-     * default to.
-     */
-    size?: SmartLinkSize;
-    /**
-     * The status of the Smart Link. Used to conditionally render different blocks
-     * when Smart Link is in different states.
-     * @internal
-     */
-    status?: SmartLinkStatus;
-    /**
-     * 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;
-    /**
-     * Ref to block wrapper div.
-     */
-    blockRef?: Ref<HTMLDivElement>;
-    /**
-     * Function to be called on render of block.
-     * @internal
-     */
-    onRender?: () => void;
-    /**
-     * Function to be called on transition end of block.
-     * @internal
-     */
-    onTransitionEnd?: () => void;
-};
-/**
- * Used to represent a metadata element to be rendered.
- */
-export declare type ElementItem = {
-    /**
-     * Any additional CSS properties to apply to the element.
-     */
-    overrideCss?: SerializedStyles;
-    /**
-     * The size of the element to display.
-     */
-    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;
-} & ElementItemProps;
-/**
- * Used to represent an Action when passing props into Flexible UI.
- */
-export declare type BaseActionItem = {
-    /**
-     * Determines whether the action should hide the text content of the button.
-     */
-    hideContent?: boolean;
-    /**
-     * Determines whether the action should hide the icon inside the button.
-     */
-    hideIcon?: boolean;
-    /**
-     * Determines the text and icon representation of the action, with exception
-     * to CustomAction.
-     */
-    name: ActionName;
-    /**
-     * Determines the onClick behaviour of the action.
-     */
-    onClick: () => any;
-    /**
-     * Additional CSS properties on the Action.
-     */
-    overrideCss?: SerializedStyles;
-    /**
-     * Determines the size of the Action. Corresponds to an Action appearance.
-     */
-    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;
-};
-/**
- * This represents an action where Icon and Content are provided implicitly.
- * @example DeleteAction - by default will contain a cross icon with the
- * 'delete' content if content and icon are not provided.
- */
-export declare type NamedActionItem = BaseActionItem & {
-    name: Exclude<ActionName, ActionName.CustomAction>;
-};
-/**
- * This represents an action where either Icon or label must be provided.
- */
-export declare type CustomActionItem = BaseActionItem & {
-    name: ActionName.CustomAction;
-} & ((Required<Pick<ActionProps, 'icon' | 'iconPosition'>> & Pick<ActionProps, 'content'>) | ((Required<Pick<ActionProps, 'content'>> & Pick<ActionProps, 'icon' | 'iconPosition'>) & Pick<ActionProps, 'tooltipMessage'>));
-export declare type ActionItem = NamedActionItem | CustomActionItem;
-export declare type OnActionMenuOpenChangeOptions = {
-    isOpen: boolean;
-};
-/**
- * A type that contains all the possible combinations of elements with their corresponding props.
- */
-export declare type ElementItemProps = AttachmentCount | AuthorGroup | CollaboratorGroup | CommentCount | CreatedBy | CreatedOn | DueOn | LatestCommit | LinkIcon | ModifiedBy | ModifiedOn | Preview | Priority | ProgrammingLanguage | Provider | ReactCount | Snippet | SourceBranch | State | SubscriberCount | TargetBranch | Title | ViewCount | VoteCount;
-/**
- * Represents the props available for an AttachmentCount element.
- * @see AttachmentCount
- */
-export declare type AttachmentCount = {
-    name: ElementName.AttachmentCount;
-};
-/**
- * Represents the props available for an AuthorGroup element.
- * @see AuthorGroup
- */
-export declare type AuthorGroup = {
-    name: ElementName.AuthorGroup;
-};
-/**
- * Represents the props available for an CollaboratorGroup element.
- * @see CollaboratorGroup
- */
-export declare type CollaboratorGroup = {
-    name: ElementName.CollaboratorGroup;
-};
-/**
- * Represents the props available for an CommentCount element.
- * @see CommentCount
- */
-export declare type CommentCount = {
-    name: ElementName.CommentCount;
-};
-/**
- * Represents the props available for an CreatedBy element.
- * @see CreatedBy
- */
-export declare type CreatedBy = {
-    name: ElementName.CreatedBy;
-};
-/**
- * Represents the props available for an CreatedOn element.
- * @see CreatedOn
- */
-export declare type CreatedOn = {
-    name: ElementName.CreatedOn;
-    /**
-     * A string which will be displayed before the specified element.
-     */
-    text?: string;
-};
-/**
- * Represents the props available for an DueOn element.
- * @see CreatedOn
- */
-export declare type DueOn = {
-    name: ElementName.DueOn;
-};
-/**
- * Represents the props available for an LastCommit element.
- * @see BadgeProps
- */
-export declare type LatestCommit = {
-    name: ElementName.LatestCommit;
-};
-/**
- * Represents the props available for an LinkIcon element.
- * @see LinkIcon
- */
-export declare type LinkIcon = {
-    name: ElementName.LinkIcon;
-};
-/**
- * Represents the props available for an ModifiedBy element.
- * @see ModifiedBy
- */
-export declare type ModifiedBy = {
-    name: ElementName.ModifiedBy;
-};
-/**
- * Represents the props available for an ModifiedOn element.
- * @see ModifiedOn
- */
-export declare type ModifiedOn = {
-    name: ElementName.ModifiedOn;
-    /**
-     * A string which will be displayed before the specified element.
-     */
-    text?: string;
-};
-/**
- * Represents the props available for an Preview element.
- * @see Preview
- */
-export declare type Preview = {
-    name: ElementName.Preview;
-};
-/**
- * Represents the props available for an Priority element.
- * @see Priority
- */
-export declare type Priority = {
-    name: ElementName.Priority;
-};
-/**
- * Represents the props available for an ProgrammingLanguage element.
- * @see ProgrammingLanguage
- */
-export declare type ProgrammingLanguage = {
-    name: ElementName.ProgrammingLanguage;
-};
-/**
- * Represents the props available for an Provider element.
- * @see Provider
- */
-export declare type Provider = {
-    name: ElementName.Provider;
-};
-/**
- * Represents the props available for an ReactCount element.
- * @see ReactCount
- */
-export declare type ReactCount = {
-    name: ElementName.ReactCount;
-};
-/**
- * Represents the props available for an Snippet element.
- * @see Snippet
- */
-export declare type Snippet = {
-    name: ElementName.Snippet;
-};
-/**
- * Represents the props available for an SourceBranch element.
- * @see SourceBranch
- */
-export declare type SourceBranch = {
-    name: ElementName.SourceBranch;
-};
-/**
- * Represents the props available for an State element.
- * @see State
- */
-export declare type State = {
-    name: ElementName.State;
-};
-/**
- * Represents the props available for an SubscriberCount element.
- * @see SubscriberCount
- */
-export declare type SubscriberCount = {
-    name: ElementName.SubscriberCount;
-};
-/**
- * Represents the props available for an TargetBranch element.
- * @see TargetBranch
- */
-export declare type TargetBranch = {
-    name: ElementName.TargetBranch;
-};
-/**
- * Represents the props available for an Title element.
- * @see Title
- */
-export declare type Title = {
-    name: ElementName.Title;
-};
-/**
- * Represents the props available for an ViewCount element.
- * @see ViewCount
- */
-export declare type ViewCount = {
-    name: ElementName.ViewCount;
-};
-/**
- * Represents the props available for an VoteCount element.
- * @see VoteCount
- */
-export declare type VoteCount = {
-    name: ElementName.VoteCount;
-};

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

@@ -1,13 +0,0 @@
-import React from 'react';
-import { SerializedStyles } from '@emotion/react';
-import { ActionItem, ElementItem } from './types';
-import { ElementName, SmartLinkDirection, SmartLinkSize } from '../../../../constants';
-import { Appearance } from '@atlaskit/button';
-export declare type ElementDisplaySchemaType = 'inline' | 'block';
-export declare const ElementDisplaySchema: Record<ElementName, ElementDisplaySchemaType[]>;
-export declare const getGapSize: (size: SmartLinkSize) => number;
-export declare const getBaseStyles: (direction: SmartLinkDirection, size: SmartLinkSize) => SerializedStyles;
-export declare const highlightRemoveStyles: SerializedStyles;
-export declare const renderChildren: (children: React.ReactNode, size: SmartLinkSize) => React.ReactNode;
-export declare const renderElementItems: (items?: ElementItem[], display?: ElementDisplaySchemaType) => React.ReactNode | undefined;
-export declare const renderActionItems: (items?: ActionItem[], size?: SmartLinkSize, appearance?: Appearance | undefined, asDropDownItems?: boolean | undefined, onActionItemClick?: (() => void) | undefined) => React.ReactNode | undefined;

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

@@ -1,4 +0,0 @@
-import React from 'react';
-import { AtlaskitIconProps } from './types';
-declare const AtlaskitIcon: React.FC<AtlaskitIconProps>;
-export default AtlaskitIcon;

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

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

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

@@ -1,5 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { ImageIconProps } from './types';
-declare const ImageIcon: React.FC<ImageIconProps>;
-export default ImageIcon;

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

@@ -1,7 +0,0 @@
-/// <reference types="react" />
-export declare type ImageIconProps = {
-    defaultIcon?: React.ReactNode;
-    testId?: string;
-    url: string;
-    onError?: () => void;
-};

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

@@ -1,5 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { LoadingSkeletonProps } from './types';
-declare const LoadingSkeleton: React.FC<LoadingSkeletonProps>;
-export default LoadingSkeleton;

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

@@ -1,16 +0,0 @@
-export declare type LoadingSkeletonProps = {
-    /**
-     * 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;
-    /**
-     * Width of the loading skeleton, defaults to width of the parent element
-     */
-    width?: number;
-    /**
-     * Height of loading skeleton, defaults to height of the parent element
-     */
-    height?: number;
-};

package/dist/types-ts4.0/view/FlexibleCard/components/container/index.d.ts

@@ -1,16 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { SerializedStyles } from '@emotion/react';
-import { SmartLinkSize } from '../../../../constants';
-import { ContainerProps } from './types';
-export declare const getContainerStyles: (size: SmartLinkSize, hideBackground: boolean, hideElevation: boolean, hidePadding: boolean, clickableContainer: boolean) => SerializedStyles;
-/**
- * A container is a hidden component that build the Flexible Smart Link.
- * All of the Flexible UI components are wrapped inside the container.
- * It inherits the ui props from Card component and applies the custom styling
- * accordingly.
- * @internal
- * @see Block
- */
-declare const Container: React.FC<ContainerProps>;
-export default Container;

package/dist/types-ts4.0/view/FlexibleCard/components/container/layered-link/index.d.ts

@@ -1,10 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { LayeredLinkProps } from './types';
-/**
- * An anchor component to cover the entire container creating a clickable area.
- * @internal
- * @see `clickableContainer`
- */
-declare const LayeredLink: React.FC<LayeredLinkProps>;
-export default LayeredLink;

package/dist/types-ts4.0/view/FlexibleCard/components/container/layered-link/types.d.ts

@@ -1,12 +0,0 @@
-/// <reference types="react" />
-export declare type LayeredLinkProps = {
-    /**
-     * Determines the onClick behaviour of the Link. By default used for analytics.
-     * @internal
-     */
-    onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
-    target?: '_blank' | '_self' | '_top' | '_parent';
-    testId?: string;
-    text?: string;
-    url: string;
-};

package/dist/types-ts4.0/view/FlexibleCard/components/container/types.d.ts

@@ -1,25 +0,0 @@
-/// <reference types="react" />
-import { SmartLinkStatus } from '../../../../constants';
-import { FlexibleUiOptions, RetryOptions } from '../../types';
-export declare type ContainerProps = FlexibleUiOptions & {
-    /**
-     * Determines the onClick behaviour of Flexible UI. This will proxy to the
-     * TitleBlock if supplied.
-     */
-    onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
-    /**
-     * The options that determine the retry behaviour when a Smart Link errors.
-     */
-    retry?: RetryOptions;
-    /**
-     * The status of the Smart Link. Used to conditionally render different blocks
-     * when Smart Link is in different states.
-     */
-    status?: SmartLinkStatus;
-    /**
-     * 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;
-};

package/dist/types-ts4.0/view/FlexibleCard/components/elements/avatar-group/index.d.ts

@@ -1,12 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { AvatarGroupProps } from './types';
-/**
- * A base element that displays a group of avatars.
- * @internal
- * @param {AvatarGroupProps} AvatarGroupProps - The props necessary for the AvatarGroup.
- * @see AuthorGroup
- * @see CollaboratorGroup
- */
-declare const AvatarGroup: React.FC<AvatarGroupProps>;
-export default AvatarGroup;

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

@@ -1,21 +0,0 @@
-import { ElementProps } from '../types';
-export declare type AvatarItemProps = {
-    /**
-     * 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;
-};
-export declare type AvatarGroupProps = ElementProps & {
-    /**
-     * An array of Avatars to show
-     */
-    items?: AvatarItemProps[];
-    /**
-     * The maximum number of Avatars to show in the AvatarGroup
-     */
-    maxCount?: number;
-};

package/dist/types-ts4.0/view/FlexibleCard/components/elements/badge/index.d.ts

@@ -1,18 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { BadgeProps } from './types';
-/**
- * A base element that displays some text with an associated icon.
- * @internal
- * @param {BadgeProps} BadgeProps - The props necessary for the Badge.
- * @see CommentCount
- * @see ViewCount
- * @see ReactCount
- * @see VoteCount
- * @see SubscriberCount
- * @see Priority
- * @see ProgrammingLanguage
- * @see Provider
- */
-declare const Badge: React.FC<BadgeProps>;
-export default Badge;