@atlaskit/smart-card 26.34.2 → 26.34.4

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

@@ -1,37 +0,0 @@
-import { SmartLinkSize, SmartLinkDirection } from '../../../../../constants';
-import { ActionItem } from '../types';
-import { Appearance } from '@atlaskit/button';
-export type ActionGroupProps = {
-    /**
-     * Determines the actions within the Action Group.
-     */
-    items: ActionItem[];
-    /**
-     * Determines the default size of the actions within the Action Group.
-     */
-    size?: SmartLinkSize;
-    /**
-     * 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.
-     */
-    visibleButtonsNum?: number;
-    /**
-     * Called when the action dropdown menu (if present) is open/closed.
-     */
-    onDropdownOpenChange?: (isOpen: boolean) => void;
-    /**
-     * 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.5/view/FlexibleCard/components/blocks/block/index.d.ts

@@ -1,12 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { BlockProps } from '../types';
-/**
- * A block represents a collection of elements and actions that are arranged
- * in a row. All elements and actions should be contained within a Block.
- * @internal
- * @param {ActionGroupProps} ActionGroupProps
- * @see Action
- */
-declare const Block: React.FC<BlockProps>;
-export default Block;

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

@@ -1,15 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { SerializedStyles } from '@emotion/react';
-import { ElementGroupProps } from './types';
-import { SmartLinkAlignment, SmartLinkDirection, SmartLinkPosition, SmartLinkSize, SmartLinkWidth } from '../../../../../constants';
-export declare const getElementGroupStyles: (direction: SmartLinkDirection, size: SmartLinkSize, align: SmartLinkAlignment, width: SmartLinkWidth, position: SmartLinkPosition) => SerializedStyles;
-/**
- * Creates a group of Action components. Accepts an array of Actions, in addition to some styling
- * preferences.
- * @internal
- * @param {ActionGroupProps} ActionGroupProps
- * @see Action
- */
-declare const ElementGroup: React.FC<ElementGroupProps>;
-export default ElementGroup;

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

@@ -1,11 +0,0 @@
-import { SerializedStyles } from '@emotion/react';
-import { SmartLinkAlignment, SmartLinkDirection, SmartLinkPosition, SmartLinkSize, SmartLinkWidth } from '../../../../../constants';
-export type ElementGroupProps = {
-    align?: SmartLinkAlignment;
-    direction?: SmartLinkDirection;
-    overrideCss?: SerializedStyles;
-    size?: SmartLinkSize;
-    width?: SmartLinkWidth;
-    testId?: string;
-    position?: SmartLinkPosition;
-};

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

@@ -1,11 +0,0 @@
-import React from 'react';
-import { FooterBlockProps } from './types';
-/**
- * Represents a FooterBlock, designed to contain elements and actions that should appear
- * at the bottom of a link card.
- * @public
- * @param {FooterBlockProps} FooterBlockProps
- * @see Block
- */
-declare const FooterBlock: React.FC<FooterBlockProps>;
-export default FooterBlock;

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

@@ -1,15 +0,0 @@
-import { ActionItem, BlockProps } from '../types';
-import { OnActionMenuOpenChangeOptions } from '../types';
-export type FooterBlockProps = {
-    /**
-     * An array of actions to be displayed on the right.
-     * Adding more than three actions will result in the second and following
-     * actions being hidden inside of a dropdown
-     * @see ActionItem
-     */
-    actions?: ActionItem[];
-    /**
-     * Function to be called when footer action dropdown open state is changed.
-     */
-    onActionMenuOpenChange?: (options: OnActionMenuOpenChangeOptions) => void;
-} & BlockProps;

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

@@ -1,6 +0,0 @@
-export { default as FooterBlock } from './footer-block';
-export { default as MetadataBlock } from './metadata-block';
-export { default as PreviewBlock } from './preview-block';
-export { default as SnippetBlock } from './snippet-block';
-export { default as TitleBlock } from './title-block';
-export { default as CustomBlock } from './block';

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

@@ -1,11 +0,0 @@
-import React from 'react';
-import { MetadataBlockProps } from './types';
-/**
- * Represents a MetadataBlock, designed to contain groups of metadata in the form of elements.
- * Accepts an array of elements to be shown either primary (left hand side) or secondary (right hand side).
- * @public
- * @param {MetadataBlockProps} MetadataBlockProps
- * @see Block
- */
-declare const MetadataBlock: React.FC<MetadataBlockProps>;
-export default MetadataBlock;

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

@@ -1,26 +0,0 @@
-import { BlockProps, ElementItem } from '../types';
-export type MetadataBlockProps = {
-    /**
-     * Determines the number of lines the metadata should span across.
-     * Default is 2. Maximum is 2.
-     */
-    maxLines?: number;
-    /**
-     * An array of metadata elements to display on the left.
-     * 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
-     */
-    primary?: ElementItem[];
-    /**
-     * An array of metadata elements to display on the right.
-     * 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
-     */
-    secondary?: ElementItem[];
-} & BlockProps;

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

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

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

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

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

@@ -1,27 +0,0 @@
-import { BlockProps } from '../types';
-import { MediaPlacement } from '../../../../../constants';
-export type OnPreviewRenderOptions = {
-    placement?: MediaPlacement;
-};
-export type PreviewBlockProps = {
-    /**
-     * Indicate whether preview block should ignore the padding its parent container.
-     * Default is false.
-     */
-    ignoreContainerPadding?: boolean;
-    /**
-     * Function to be called on error loading media.
-     * @internal
-     */
-    onError?: () => void;
-    /**
-     * 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-ts4.5/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.5/view/FlexibleCard/components/blocks/snippet-block/types.d.ts

@@ -1,8 +0,0 @@
-import { BlockProps } from '../types';
-export 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.5/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.5/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.5/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.5/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.5/view/FlexibleCard/components/blocks/title-block/types.d.ts

@@ -1,97 +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 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;
-    /**
-     * 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.
-     */
-    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;
-    /**
-     * The vertical position of the metadata fields. Internal prop, please DO NOT USE.
-     * @internal
-     */
-    metadataPosition?: SmartLinkPosition;
-} & BlockProps;
-export type TitleBlockViewProps = TitleBlockProps & {
-    actionGroup?: React.ReactNode;
-    title: React.ReactNode;
-};