@transferwise/components 0.0.0-experimental-36d28a2 → 0.0.0-experimental-18e9dad

package/build/types/promoCard/PromoCard.d.ts

@@ -1,123 +0,0 @@
-import React, { FunctionComponent } from 'react';
-export type ReferenceType = React.Ref<HTMLInputElement>;
-export type LinkTarget = '_blank' | '_parent' | '_self' | '_top';
-export interface PromoCardCommonProps {
-    /** Optional prop to specify classNames onto the PromoCard */
-    className?: string;
-    /** Optional prop to specify the ID of the PromoCard */
-    id?: string;
-    /** Required prop to specify the descriptive text of the PromoCard  */
-    description: string;
-    /**
-     * Optional prop to specify the heading level of the PromoCard
-     *
-     * @default 'h2'
-     */
-    headingLevel?: 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
-    /** Optional prop to specify text for the indicator label of the PromoCard */
-    indicatorLabel?: string;
-    /** Optional prop to specify an image alt text  */
-    imageAlt?: string;
-    /** Optional prop to specify an image class  */
-    imageClass?: string;
-    /** Optional prop to specify an image source url  */
-    imageSource: string;
-    /** Specify whether the PromoCard is disabled, or not */
-    isDisabled?: boolean;
-    /** Specify an onClick event handler */
-    onClick?: () => void;
-    /** Optional prop to specify the ID used for testing */
-    testId?: string;
-    /** Required prop to specify the title text of the PromoCard  */
-    title: string;
-}
-export interface PromoCardLinkProps extends PromoCardCommonProps {
-    /**
-     * Optional prop to prompts a user to save the linked URL instead of
-     * navigating to it
-     */
-    download?: string;
-    /** Optionally specify an href for your PromoCard to contain an <a> element */
-    href?: string;
-    /** Optionally specify the language of the linked URL */
-    hrefLang?: string;
-    /**
-     * Relationship between the PromoCard href URL and the current page. See
-     * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel).
-     */
-    rel?: string[];
-    /** Optional prop to to display where the linked URL will show */
-    target?: LinkTarget;
-    /** Only applies to role="radio" or "checkbox" */
-    defaultChecked?: never;
-    isChecked?: never;
-    tabIndex?: never;
-    type?: never;
-    reference?: never;
-    value?: never;
-}
-export interface PromoCardCheckedProps extends PromoCardCommonProps {
-    /** Specify the initial checked attribute of the PromoCard */
-    defaultChecked?: boolean;
-    /** Specify whether the PromoCard is checked, or not */
-    isChecked?: boolean;
-    /** Optional prop to specify the tabIndex of the PromoCard */
-    tabIndex?: number;
-    /** Optional property to provide component Ref */
-    reference?: ReferenceType;
-    /** Optional prop to specify the input type of the PromoCard  */
-    type?: 'checkbox' | 'radio';
-    /** Specify the value attribute of the PromoCard if Checkbox or Radio */
-    value?: string;
-    /** Only applies to <a />s */
-    download?: never;
-    href?: never;
-    hrefLang?: never;
-    rel?: never;
-    target?: never;
-}
-export type PromoCardProps = PromoCardLinkProps | PromoCardCheckedProps;
-export type PolymorphicPromoCard = (props: PromoCardLinkProps | PromoCardCheckedProps) => JSX.Element;
-/**
- * PromoCard component.
- *
- * PromoCard is a marketing style component that is used to group marketing
- * product related information (such as choosing Card types). It can be used to
- * display information in a structured way, and can be customized with various
- * props to suit different use cases.
- *
- * @component
- * @param {string} className - Additional class name for the PromoCard.
- * @param {string} description - Description text for the PromoCard.
- * @param {boolean} defaultChecked - Initial checked state for checkboxes and radios.
- * @param {string} download - Download file name for links.
- * @param {string} href - URL for links.
- * @param {string} hrefLang - Language code for linked URL.
- * @param {string} id - ID of the PromoCard.
- * @param {string} imageAlt - Alt text for the image.
- * @param {string} imageSource - Source URL of the image.
- * @param {string} indicatorLabel - Label for the indicator icon.
- * @param {boolean} isChecked - Checked state for checkboxes and radios.
- * @param {boolean} isDisabled - Whether the PromoCard is disabled.
- * @param {Function} onClick - Click event handler for the PromoCard.
- * @param {string} rel - Relationship between the URL and the current page.
- * @param {number} tabIndex - Tab index for keyboard navigation.
- * @param {string} target - Target window for links.
- * @param {string} testId - ID used for testing.
- * @param {string} title - Title text of the PromoCard.
- * @param {('checkbox'|'radio')} type - Type of the PromoCard (checkbox, radio).
- * @param {string} value - Value for checkboxes and radios.
- * @returns {JSX.Element} The rendered PromoCard component.
- * @example
- * <PromoCard
- *   title="Example PromoCard"
- *   description="This is an example PromoCard with a link variation."
- *   href="https://example.com"
- *   target="_blank"
- *   imageSource="https://example.com/image.png"
- *   imageAlt="Example Image"
- *   indicatorLabel="Learn More"
- * />
- */
-declare const PromoCard: FunctionComponent<PromoCardProps>;
-export default PromoCard;

package/build/types/promoCard/PromoCard.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/build/types/promoCard/PromoCard.story.d.ts

@@ -1,10 +0,0 @@
-import { Meta, StoryObj } from '@storybook/react';
-import PromoCard from './PromoCard';
-declare const meta: Meta<typeof PromoCard>;
-export default meta;
-type Story = StoryObj<typeof PromoCard>;
-export declare const Default: Story;
-export declare const Link: Story;
-export declare const Checked: Story;
-export declare const Disabled: Story;
-export declare const CustomClass: Story;

package/build/types/promoCard/PromoCardContext.d.ts

@@ -1,45 +0,0 @@
-import React from 'react';
-/**
- * The type of the PromoCard context object.
- *
- * The context object contains the current state of the PromoCard group, whether
- * the group is disabled or not, and a function to call when the group value
- * changes. This value is used to provide context to child PromoCard components,
- * allowing them to interact with the group and update its state.
- */
-interface PromoCardContextType {
-    /**
-     * The current value of the PromoCard group.
-     *
-     * @default ''
-     */
-    state: string;
-    /**
-     * Whether the PromoCard group is disabled or not.
-     *
-     * @default false
-     */
-    isDisabled: boolean;
-    /**
-     * A function to call when the PromoCard group value changes.
-     *
-     * @param {string} value - The new value of the PromoCard group.
-     * @default () => {}
-     */
-    onChange: (value: string) => void;
-}
-/**
- * The PromoCard context object.
- */
-export declare const PromoCardContext: React.Context<PromoCardContextType>;
-/**
- * A custom hook for accessing the PromoCard context object.
- *
- * The `usePromoCardContext` hook is used to access the PromoCard context object
- * from within a child PromoCard component. It throws an error if the context
- * object is not available, which can help with debugging and development.
- *
- * @returns {PromoCardContextType} - The PromoCard context object.
- */
-export declare const usePromoCardContext: () => PromoCardContextType;
-export default PromoCardContext;

package/build/types/promoCard/PromoCardContext.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/build/types/promoCard/PromoCardGroup.d.ts

@@ -1,55 +0,0 @@
-import { FunctionComponent, ReactNode } from 'react';
-export type AriaRoleRadioGroup = 'radiogroup';
-export interface PromoCardGroupProps {
-    /**
-     * Optional class name(s) to add to the group container.
-     */
-    className?: string;
-    /**
-     * The PromoCard components to display inside the group.
-     */
-    children: ReactNode;
-    /**
-     * The default value for the group.
-     */
-    defaultValue?: string;
-    /**
-     * Optional ID to add to the group container.
-     */
-    id?: string;
-    /**
-     * Whether the group is disabled or not.
-     */
-    isDisabled?: boolean;
-    /**
-     * Optional label to display above the group.
-     */
-    label?: string;
-    /**
-     * Optional function to call when the group value changes.
-     */
-    onChange?: (value: string) => void;
-    /**
-     * Optional ID to add to the group container for testing purposes.
-     */
-    testId?: string;
-}
-/**
- * PromoCardGroup component.
- *
- * A PromoCardGroup is a container for PromoCard components that allows the user to select one or more
- * cards from a group. It can be used to display a set of related options, and can be customized with
- * various props to suit different use cases.
- *
- * @param {ReactNode} children - The PromoCard components to display inside the group.
- * @param {string} className - Optional class name(s) to add to the group container.
- * @param {string} defaultValue - The default value for the group.
- * @param {string} id - Optional ID to add to the group container.
- * @param {boolean} isDisabled=false - Whether the group is disabled or not.
- * @param {string} label - Optional label to display above the group.
- * @param {Function} onChange - Optional function to call when the group value changes.
- * @param {string} testId - Optional ID to add to the group container for testing purposes.
- * @returns {JSX.Element} - The PromoCardGroup component.
- */
-declare const PromoCardGroup: FunctionComponent<PromoCardGroupProps>;
-export default PromoCardGroup;

package/build/types/promoCard/PromoCardGroup.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/build/types/promoCard/PromoCardGroup.story.d.ts

@@ -1,8 +0,0 @@
-import { Meta, StoryObj } from '@storybook/react';
-import PromoCardGroup from './PromoCardGroup';
-declare const meta: Meta<typeof PromoCardGroup>;
-export default meta;
-type Story = StoryObj<typeof PromoCardGroup>;
-export declare const Default: Story;
-export declare const DefaultValue: Story;
-export declare const Disabled: Story;

package/build/types/promoCard/PromoCardIndicator.d.ts

@@ -1,31 +0,0 @@
-import { ReactNode } from 'react';
-export type PromoCardIndicatorProps = {
-    /** Optional class name(s) to add to the indicator container. */
-    className?: string;
-    /** Optional label to display next to the indicator. */
-    label?: string;
-    /** Optional icon to display in the indicator. */
-    icon?: 'check' | 'arrow' | 'download';
-    /** Optional ID to add to the indicator container for testing purposes. */
-    testid?: string;
-    /** Optional children to display inside the indicator. */
-    children?: ReactNode;
-};
-/**
- * PromoCardIndicator component.
- *
- * A PromoCardIndicator is a small component that can be used to display
- * additional information or actions related to a PromoCard. It can be
- * customized with various props to suit different use cases.
- *
- * @param {string} className - Optional class name(s) to add to the indicator container.
- * @param {string} label - Optional label to display next to the indicator.
- * @param {string} icon - Optional icon to display in the indicator.
- * @param {string} testid - Optional ID to add to the indicator container for testing purposes.
- * @param {ReactNode} children - Optional children to display inside the indicator.
- * @returns {JSX.Element} - The PromoCardIndicator component.
- * @example
- * <PromoCardIndicator label="Download" icon="download" />
- */
-declare const PromoCardIndicator: React.FC<PromoCardIndicatorProps>;
-export default PromoCardIndicator;

package/build/types/promoCard/index.d.ts

@@ -1,2 +0,0 @@
-export { default } from './PromoCard';
-export { default as PromoCardGroup } from './PromoCardGroup';