@atlaskit/smart-card 22.2.0 → 22.2.1

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

@@ -0,0 +1,48 @@
+import { SerializedStyles } from '@emotion/core';
+import { SmartLinkSize } from '../../../../../constants';
+import { Appearance } from '@atlaskit/button/types';
+import { ReactChild } from 'react';
+export declare type ActionProps = {
+    /**
+     * Determines the size of the Action. Corresponds to an Action appearance.
+     */
+    size?: SmartLinkSize;
+    /**
+     * Determines the text content of the Action.
+     */
+    content?: React.ReactNode;
+    /**
+     * Determines the appearance of the action. Corresponds to the Atlaskit action appearance.
+     */
+    appearance?: Appearance;
+    /**
+     * Determines the onClick behaviour of the Action.
+     */
+    onClick: () => any;
+    /**
+     * Determines the icon rendered within the Action.
+     */
+    icon?: ReactChild;
+    /**
+     * Determines where the icon should be rendered if text is provided.
+     */
+    iconPosition?: 'before' | 'after';
+    /**
+     * Determines the tooltip message when hovering over the Action.
+     */
+    tooltipMessage?: React.ReactNode;
+    /**
+     * Used to determine whether the Action is in a Dropdown.
+     */
+    asDropDownItem?: boolean;
+    /**
+     * Additional CSS properties on the Action.
+     */
+    overrideCss?: SerializedStyles;
+    /**
+     * 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/actions/index.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+import { ActionProps } from './action/types';
+/**
+ * Creates a DeleteAction component. Accepts default ActionProps, but defaults
+ * the icon to a cross icon.
+ * @see Action
+ */
+export declare const DeleteAction: import("react").FC<ActionProps>;
+/**
+ * Creates a EditAction component. Accepts default ActionProps, but defaults
+ * the icon to an edit (pencil) icon.
+ * @see Action
+ */
+export declare const EditAction: import("react").FC<ActionProps>;
+/**
+ * Creates a CustomAction component. Accepts default ActionProps. Required to provide
+ * your own icon or text.
+ * @see Action
+ */
+export declare const CustomAction: import("react").FC<ActionProps>;

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

@@ -0,0 +1,4 @@
+import { ActionName } from '../../../../constants';
+import React from 'react';
+export declare const createDataAction: <P extends {}>(name: ActionName) => React.FC<P>;
+export declare const createUIAction: <P extends {}>(name: ActionName) => React.FC<P>;

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

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+import { ActionGroupProps } from './types';
+/**
+ * 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 ActionGroup: React.FC<ActionGroupProps>;
+export default ActionGroup;

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

@@ -0,0 +1,37 @@
+import { SmartLinkSize, SmartLinkDirection } from '../../../../../constants';
+import { ActionItem } from '../types';
+import { Appearance } from '@atlaskit/button';
+export declare 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;
+    /**
+     * Callback used by the dropdown. Is called when the dropdown is opened.
+     */
+    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.0/view/FlexibleCard/components/blocks/block/index.d.ts

@@ -0,0 +1,12 @@
+/** @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.0/view/FlexibleCard/components/blocks/element-group/index.d.ts

@@ -0,0 +1,15 @@
+/** @jsx jsx */
+import React from 'react';
+import { SerializedStyles } from '@emotion/core';
+import { ElementGroupProps } from './types';
+import { SmartLinkAlignment, SmartLinkDirection, SmartLinkSize, SmartLinkWidth } from '../../../../../constants';
+export declare const getElementGroupStyles: (direction: SmartLinkDirection, size: SmartLinkSize, align: SmartLinkAlignment, width: SmartLinkWidth) => 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.0/view/FlexibleCard/components/blocks/element-group/types.d.ts

@@ -0,0 +1,10 @@
+import { Interpolation } from '@emotion/core';
+import { SmartLinkAlignment, SmartLinkDirection, SmartLinkSize, SmartLinkWidth } from '../../../../../constants';
+export declare type ElementGroupProps = {
+    align?: SmartLinkAlignment;
+    direction?: SmartLinkDirection;
+    overrideCss?: Interpolation;
+    size?: SmartLinkSize;
+    width?: SmartLinkWidth;
+    testId?: string;
+};

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

@@ -0,0 +1,11 @@
+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.0/view/FlexibleCard/components/blocks/footer-block/types.d.ts

@@ -0,0 +1,10 @@
+import { ActionItem, BlockProps } from '../types';
+export declare 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[];
+} & BlockProps;

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

@@ -0,0 +1,5 @@
+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';

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

@@ -0,0 +1,11 @@
+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.0/view/FlexibleCard/components/blocks/metadata-block/types.d.ts

@@ -0,0 +1,26 @@
+import { BlockProps, ElementItem } from '../types';
+export declare 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.0/view/FlexibleCard/components/blocks/preview-block/index.d.ts

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,12 @@
+/** @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

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,11 @@
+/** @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

@@ -0,0 +1,86 @@
+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;
+};