@atlaskit/smart-card 26.1.2 → 26.1.3

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 { ChildrenOptions, ContainerProps } from './types';
-export declare const getContainerStyles: (size: SmartLinkSize, hideBackground: boolean, hideElevation: boolean, hidePadding: boolean, clickableContainer: boolean, childrenOptions: ChildrenOptions) => 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,23 +0,0 @@
-import { SmartLinkStatus } from '../../../../constants';
-import { FlexibleCardProps, FlexibleUiOptions, RetryOptions } from '../../types';
-export declare type ContainerProps = Pick<FlexibleCardProps, 'onClick' | 'showHoverPreview' | 'showServerActions'> & FlexibleUiOptions & {
-    /**
-     * 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;
-};
-export declare type ChildrenOptions = {
-    previewOnLeft?: boolean;
-    previewOnRight?: boolean;
-};

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;

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

@@ -1,17 +0,0 @@
-import { ElementProps } from '../types';
-import { IconType } from '../../../../../constants';
-export declare type BadgeProps = ElementProps & {
-    /**
-     * The Atlaskit Icon to display next to the label. If this is not supplied,
-     * 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;
-};

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

@@ -1,12 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { DateTimeProps } from './types';
-/**
- * A base element that displays an ISO Timestamp in text.
- * @internal
- * @param {DateTimeProps} DateTimeProps - The props necessary for the DateTime element.
- * @see CreatedOn
- * @see ModifiedOn
- */
-declare const DateTime: React.FC<DateTimeProps>;
-export default DateTime;

package/dist/types-ts4.0/view/FlexibleCard/components/elements/date-time/types.d.ts

@@ -1,16 +0,0 @@
-import { ElementProps } from '../types';
-export declare type DateTimeType = 'created' | 'modified';
-export declare type DateTimeProps = ElementProps & {
-    /**
-     * Whether the date time element text should contain "Modified" or "Created"
-     */
-    type?: DateTimeType;
-    /**
-     * The date to display in the element.
-     */
-    date?: Date;
-    /**
-     * The override text which will show next to the date
-     */
-    text?: string;
-};

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

@@ -1,11 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { IconProps } from './types';
-/**
- * A base element that displays an Icon or favicon.
- * @internal
- * @param {IconProps} IconProps - The props necessary for the Icon element.
- * @see LinkIcon
- */
-declare const Icon: React.FC<IconProps>;
-export default Icon;

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

@@ -1,27 +0,0 @@
-/// <reference types="react" />
-import { ElementProps } from '../types';
-import { IconType, SmartLinkPosition } from '../../../../../constants';
-export declare type IconProps = ElementProps & {
-    /**
-     * If provided, Icon element will use this render function instead.
-     */
-    render?: () => React.ReactNode;
-    /**
-     * The Atlaskit Icon to display. If no icon is provided, then the URL provided
-     * will be used.
-     */
-    icon?: IconType;
-    /**
-     * The label provided to the Atlaskit Icon.
-     */
-    label?: string;
-    /**
-     * Determines the position of the link icon in relative to the vertical
-     * height.  It can either be centred or placed on “top”. Default is top.
-     */
-    position?: SmartLinkPosition;
-    /**
-     * The icon from this url will be used if no render function or Atlaskit Icon is provided.
-     */
-    url?: string;
-};

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

@@ -1,145 +0,0 @@
-/// <reference types="react" />
-import { BadgeProps } from './badge/types';
-import { IconProps } from './icon/types';
-import { LinkProps } from './link/types';
-import { LozengeProps } from './lozenge/types';
-import { AvatarGroupProps } from './avatar-group/types';
-import { TextProps } from './text/types';
-import { DateTimeProps } from './date-time/types';
-import { MediaProps } from './media/types';
-/**
- * Creates a AttachmentCount Badge element using the data from AttachmentCount in the Flexible UI Context.
- * @see Badge
- */
-export declare const AttachmentCount: import("react").FC<BadgeProps>;
-/**
- * An AvatarGroup element using the data from AuthorGroup in the Flexible UI Context.
- * @see AvatarGroup
- */
-export declare const AuthorGroup: import("react").FC<AvatarGroupProps>;
-/**
- * Creates a Checklist Badge element using the data from ChecklistProgress in the Flexible UI Context.
- * @see Badge
- */
-export declare const ChecklistProgress: import("react").FC<BadgeProps>;
-/**
- * An AvatarGroup element using the data from CollaboratorGroup in the Flexible UI Context.
- * @see AvatarGroup
- */
-export declare const CollaboratorGroup: import("react").FC<AvatarGroupProps>;
-/**
- * Creates a CommentCount Badge element using the data from CommentCount in the Flexible UI Context.
- * @see Badge
- */
-export declare const CommentCount: import("react").FC<BadgeProps>;
-/**
- * Creates a CreatedOn DateTime element using the data from CreatedOn in the Flexible UI Context.
- * @see DateTime
- */
-export declare const CreatedOn: import("react").FC<DateTimeProps>;
-/**
- * Creates a CreatedBy text element using the data from CreatedBy in the Flexible UI Context.
- * @see Text
- */
-export declare const CreatedBy: import("react").FC<TextProps>;
-/**
- * Creates a DueOn Lozenge element using the data from dueOn in the Flexible UI Context.
- * @see Lozenge
- */
-export declare const DueOn: import("react").FC<LozengeProps>;
-/**
- * Creates an element that contains Last Commit hash
- */
-export declare const LatestCommit: import("react").FC<BadgeProps>;
-/**
- * Creates a LinkIcon Icon element using the data from LinkIcon in the Flexible UI Context.
- * @see Icon
- */
-export declare const LinkIcon: import("react").FC<IconProps>;
-/**
- * Creates a Location Link element.
- * This represents the location or container of the resource.
- * @see Link
- */
-export declare const Location: import("react").FC<LinkProps>;
-/**
- * Creates a ModifiedBy Text element using the data from ModifiedBy in the Flexible UI Context.
- * @see Text
- */
-export declare const ModifiedBy: import("react").FC<TextProps>;
-/**
- * Creates a ModifiedOn DateTime element using the data from ModifiedOn in the Flexible UI Context.
- * @see DateTime
- */
-export declare const ModifiedOn: import("react").FC<DateTimeProps>;
-/**
- * Creates a OwnedBy text element using the data from OwnedBy in the Flexible UI Context.
- * @see Text
- */
-export declare const OwnedBy: import("react").FC<TextProps>;
-/**
- * Creates a Preview element using the data from Preview in the Flexible UI Context.
- * @see Preview
- */
-export declare const Preview: import("react").FC<MediaProps>;
-/**
- * Creates a Priority Badge element using the data from Priority in the Flexible UI Context.
- * @see Badge
- */
-export declare const Priority: import("react").FC<BadgeProps>;
-/**
- * Creates a ProgrammingLanguage Badge element using the data from ProgrammingLanguage in the Flexible UI Context.
- * @see Badge
- */
-export declare const ProgrammingLanguage: import("react").FC<BadgeProps>;
-/**
- * Creates a Provider Badge element using the data from Provider in the Flexible UI Context.
- * @see Badge
- */
-export declare const Provider: import("react").FC<BadgeProps>;
-/**
- * Creates a ReactCount Badge element using the data from ReactCount in the Flexible UI Context.
- * @see Badge
- */
-export declare const ReactCount: import("react").FC<BadgeProps>;
-/**
- * Creates a Snippet element using the data from Snippet in the Flexible UI Context.
- * @see Text
- */
-export declare const Snippet: import("react").FC<TextProps>;
-/**
- * Creates a SourceBranch Text element using the data from sourceBranch in the Flexible UI Context.
- * @see Text
- */
-export declare const SourceBranch: import("react").FC<TextProps>;
-/**
- * Creates a State Lozenge element using the data from State in the Flexible UI Context.
- * @see Lozenge
- */
-export declare const State: import("react").FC<LozengeProps>;
-/**
- * Creates a SubscriberCount Badge element using the data from SubscriberCount in the Flexible UI Context.
- * @see Badge
- */
-export declare const SubscriberCount: import("react").FC<BadgeProps>;
-/**
- * Creates a TargetBranch Text element using the data from targetBranch in the Flexible UI Context.
- * @see Text
- */
-export declare const TargetBranch: import("react").FC<TextProps>;
-/**
- * Creates a Title Link element using the data from Title in the Flexible UI Context.
- * This represents the main link text within the Smart Link.
- * @see Link
- */
-export declare const Title: import("react").FC<LinkProps>;
-/**
- * Creates a ViewCount Badge element using the data from ViewCount in the Flexible UI Context.
- * @see Badge
- */
-export declare const ViewCount: import("react").FC<BadgeProps>;
-/**
- * Creates a VoteCount Badge element using the data from VoteCount in the Flexible UI Context.
- * @see Badge
- */
-export declare const VoteCount: import("react").FC<BadgeProps>;

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

@@ -1,11 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { LinkProps } from './types';
-/**
- * A base element that represent an anchor.
- * @internal
- * @param {LinkProps} LinkProps - The props necessary for the Link element.
- * @see LinkIcon
- */
-declare const Link: React.FC<LinkProps>;
-export default Link;

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

@@ -1,39 +0,0 @@
-/// <reference types="react" />
-import { ElementProps } from '../types';
-import { SmartLinkTheme } from '../../../../../constants';
-import { AnchorTarget } from '../../types';
-export declare type LinkProps = ElementProps & {
-    /**
-     * Determines whether the link should display tooltip on hover.
-     */
-    hideTooltip?: boolean;
-    /**
-     * Determines the behaviour when the Link is clicked. By default is used to
-     * propagate analytics.
-     */
-    onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
-    /**
-     * Mouse event to be provided to the link
-     */
-    onMouseDown?: React.MouseEventHandler;
-    /**
-     * The number of lines that the link text should spread over. Maximum of 2 lines.
-     */
-    maxLines?: number;
-    /**
-     * The text to display. Overrides the default link text.
-     */
-    text?: string;
-    /**
-     * The theme of the link. Can be Black, or Link (default blue URL).
-     */
-    theme?: SmartLinkTheme;
-    /**
-     * The url that the Smart Link should be based upon.
-     */
-    url?: string;
-    /**
-     * The href target behaviour of the link.
-     */
-    target?: AnchorTarget;
-};

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

@@ -1,11 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import type { LozengeProps } from './types';
-/**
- * A base element that displays a Lozenge.
- * @internal
- * @param {LozengeProps} LozengeProps - The props necessary for the Lozenge element.
- * @see State
- */
-declare const Lozenge: React.FC<LozengeProps>;
-export default Lozenge;

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

@@ -1,23 +0,0 @@
-/// <reference types="react" />
-import { ElementProps } from '../types';
-import { InvokeActions } from '../../../../../state/hooks/use-invoke/types';
-export declare type LozengeAppearance = 'default' | 'inprogress' | 'moved' | 'new' | 'removed' | 'success';
-export declare type LozengeProps = ElementProps & {
-    /**
-     * Action that can be performed on the element
-     */
-    action?: InvokeActions;
-    /**
-     * Determines the appearance of the Atlaskit lozenge.
-     */
-    appearance?: LozengeAppearance;
-    /**
-     * DO NOT USE! This is an experiment code and may be removed at any given time.
-     * @internal
-     */
-    onClick?: () => void;
-    /**
-     * The text to display within the lozenge.
-     */
-    text?: string | React.ReactNode;
-};

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

@@ -1,11 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { MediaProps } from './types';
-/**
- * A base element that displays a Media.
- * @internal
- * @param {MediaProps} MediaProps - The props necessary for the Media element.
- * @see Preview
- */
-declare const Media: React.FC<MediaProps>;
-export default Media;

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

@@ -1,18 +0,0 @@
-import { ElementProps } from '../types';
-import { MediaType } from '../../../../../constants';
-export declare type MediaProps = ElementProps & {
-    /**
-     * The type of media to display. Can be image.
-     */
-    type?: MediaType;
-    /**
-     * The URL of the associated media to display.
-     */
-    url?: string;
-    /**
-     * Function to be called on error loading media.
-     * @internal
-     */
-    onError?: () => void;
-    onLoad?: () => void;
-};

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

@@ -1,11 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { TextProps } from './types';
-/**
- * A base element that displays some Text.
- * @internal
- * @param {TextProps} TextProps - The props necessary for the Text element.
- * @see Title
- */
-declare const Text: React.FC<TextProps>;
-export default Text;

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

@@ -1,17 +0,0 @@
-import { ElementProps } from '../types';
-import { MessageProps } from '../../types';
-export declare type TextProps = ElementProps & {
-    /**
-     * Determines the formatted message (i18n) to display.
-     * If this is provided, the content prop will not be displayed.
-     */
-    message?: MessageProps;
-    /**
-     * The raw text content to display.
-     */
-    content?: string;
-    /**
-     * The maximum number of lines the text should span over. Maximum is 2.
-     */
-    maxLines?: number;
-};

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

@@ -1,24 +0,0 @@
-import { SerializedStyles } from '@emotion/react';
-import { ElementName, SmartLinkSize } from '../../../../constants';
-export declare type ElementProps = {
-    /**
-     * Name of the element, can be used as a selector.
-     * E.g. [data-smart-element="Provider"]
-     * @internal
-     */
-    name?: ElementName;
-    /**
-     * 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;
-};

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

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

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

@@ -1,6 +0,0 @@
-import { MessageDescriptor } from 'react-intl-next';
-export declare type AnchorTarget = '_blank' | '_self' | '_top' | '_parent';
-export declare type MessageProps = {
-    descriptor: MessageDescriptor;
-    values?: Record<string, string>;
-};

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

@@ -1,15 +0,0 @@
-/// <reference types="react" />
-import { SerializedStyles } from '@emotion/react';
-import { Spacing } from '@atlaskit/button';
-import { SmartLinkSize } from '../../../constants';
-import { MessageProps } from './types';
-export declare const sizeToButtonSpacing: Record<SmartLinkSize, Spacing>;
-export declare const getFormattedMessage: (message?: MessageProps | undefined) => JSX.Element | undefined;
-export declare const getIconSizeStyles: (width: string) => SerializedStyles;
-export declare const getIconWidth: (size?: SmartLinkSize | undefined) => string;
-export declare const getLinkLineHeight: (size: SmartLinkSize) => string;
-export declare const getLinkSizeStyles: (size: SmartLinkSize) => SerializedStyles;
-export declare const getMaxLineHeight: (size: SmartLinkSize) => 1.5 | 1.75;
-export declare const getMaxLines: (value: number, defaultValue: number, max: number, min: number) => number;
-export declare const getTruncateStyles: (maxLines: number, lineHeight?: string, wordBreak?: 'break-word' | 'break-all') => SerializedStyles;
-export declare const hasWhiteSpace: (str: string) => boolean;

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

@@ -1,10 +0,0 @@
-import React from 'react';
-import { FlexibleCardProps } from './types';
-/**
- * This represents a Flexible Card: a link represented by a card with metadata.
- * This is the container in which all Flexible UI Blocks and Elements exist.
- * Note: TitleBlock is mandatory for a Flexible Card to render.
- * @see Container
- */
-declare const FlexibleCard: React.FC<FlexibleCardProps>;
-export default FlexibleCard;