@atlaskit/onboarding 14.6.2 → 15.0.0

package/dist/types-ts4.5/components/spotlight.d.ts

@@ -1,15 +0,0 @@
-import React from 'react';
-import { type SpotlightProps } from '../types';
-/**
- * __Spotlight__
- *
- * An onboarding spotlight introduces new features to users through focused messages or multi-step tours.
- *
- * - [Examples](https://atlassian.design/components/onboarding/examples)
- * - [Code](https://atlassian.design/components/onboarding/code)
- * - [Usage](https://atlassian.design/components/onboarding/usage)
- *
- * @deprecated Use `@atlaskit/spotlight` instead.
- */
-declare const Spotlight: ({ actions, actionsBeforeElement, children, dialogPlacement, dialogWidth, footer, header, heading, headingAfterElement, image, label, pulse, scrollPositionBlock, shouldWatchTarget, target, targetBgColor, targetNode, targetOnClick, targetRadius, targetReplacement, testId, titleId, ...rest }: SpotlightProps) => React.JSX.Element;
-export default Spotlight;

package/dist/types-ts4.5/components/theme.d.ts

@@ -1,10 +0,0 @@
-/**
- * @deprecated
- * Custom button themes are deprecated and will be removed in the future.
- */
-export declare const spotlightButtonTheme: (current: any, themeProps: Record<string, any>) => any;
-/**
- * @deprecated
- * Custom button themes are deprecated and will be removed in the future.
- */
-export declare const modalButtonTheme: (current: any, themeProps: Record<string, any>) => any;

package/dist/types-ts4.5/components/use-spotlight.d.ts

@@ -1,9 +0,0 @@
-/**
- * Use spotlight hook returns information about available spotlight targets.
- *
- * @deprecated Use `@atlaskit/spotlight` instead.
- */
-export default function useSpotlight(): {
-    isTargetRendered: (target: string) => boolean;
-    checkVisibility: (target: string) => (options?: CheckVisibilityOptions) => boolean;
-};

package/dist/types-ts4.5/components/value-changed.d.ts

@@ -1,11 +0,0 @@
-import React, { type ReactNode } from 'react';
-interface ValueChangedProps {
-    value: any;
-    onChange: Function;
-    children: ReactNode;
-}
-export default class ValueChanged extends React.Component<ValueChangedProps> {
-    componentDidUpdate(prevProps: ValueChangedProps): void;
-    render(): React.ReactNode;
-}
-export {};

package/dist/types-ts4.5/entry-points/modal-transition.d.ts

@@ -1 +0,0 @@
-export { default } from '../components/modal-transition';

package/dist/types-ts4.5/entry-points/modal.d.ts

@@ -1 +0,0 @@
-export { default } from '../components/modal';

package/dist/types-ts4.5/entry-points/spotlight-card.d.ts

@@ -1 +0,0 @@
-export { default } from '../components/spotlight-card';

package/dist/types-ts4.5/entry-points/spotlight-manager.d.ts

@@ -1,3 +0,0 @@
-export { SpotlightConsumer, SpotlightContext, TargetConsumer, } from '../components/spotlight-manager';
-export type { GetTargetRef, TargetRef } from '../components/spotlight-manager';
-export { default } from '../components/spotlight-manager';

package/dist/types-ts4.5/entry-points/spotlight-target.d.ts

@@ -1 +0,0 @@
-export { default } from '../components/spotlight-target';

package/dist/types-ts4.5/entry-points/spotlight-transition.d.ts

@@ -1,2 +0,0 @@
-export { SpotlightTransitionConsumer } from '../components/spotlight-transition';
-export { default } from '../components/spotlight-transition';

package/dist/types-ts4.5/entry-points/spotlight.d.ts

@@ -1 +0,0 @@
-export { default } from '../components/spotlight';

package/dist/types-ts4.5/entry-points/target.d.ts

@@ -1 +0,0 @@
-export { Pulse, TargetInner, TargetOverlay } from '../styled/target';

package/dist/types-ts4.5/entry-points/theme.d.ts

@@ -1 +0,0 @@
-export { modalButtonTheme, spotlightButtonTheme } from '../components/theme';

package/dist/types-ts4.5/entry-points/types.d.ts

@@ -1 +0,0 @@
-export type { Actions, ScrollLogicalPosition, SpotlightCardProps, SpotlightProps } from '../types';

package/dist/types-ts4.5/entry-points/use-spotlight.d.ts

@@ -1 +0,0 @@
-export { default } from '../components/use-spotlight';

package/dist/types-ts4.5/index.d.ts

@@ -1,2 +0,0 @@
-export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, modalButtonTheme, spotlightButtonTheme, useSpotlight, ModalTransition, } from './components';
-export { Pulse as SpotlightPulse } from './styled/target';

package/dist/types-ts4.5/styled/blanket.d.ts

@@ -1,19 +0,0 @@
-type BlanketProps = {
-    isTinted?: boolean;
-    style?: React.CSSProperties;
-    onBlanketClicked?: () => void;
-    className?: string;
-};
-/**
- * __Blanket__
- *
- * A replacement for `@atlaskit/blanket`.
- *
- * We use this for spotlights instead of `@atlaskit/blanket`
- * because spotlights must sit on top of other layered elements,
- * such as modals, which have their own blankets.
- *
- * @internal
- */
-declare const Blanket: React.ForwardRefExoticComponent<React.PropsWithoutRef<BlanketProps> & React.RefAttributes<HTMLDivElement>>;
-export default Blanket;

package/dist/types-ts4.5/styled/dialog.d.ts

@@ -1,33 +0,0 @@
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-import { type ImgHTMLAttributes, type ReactNode } from 'react';
-/**
- * __Dialog image__
- *
- * An optional header image in spotlight dialogs.
- *
- * @internal
- */
-export declare const DialogImage: ({ alt, ...props }: ImgHTMLAttributes<HTMLImageElement>) => JSX.Element;
-/**
- * __Dialog action item container__
- *
- * Flex wrapper around dialog action items.
- *
- * @internal
- */
-export declare const DialogActionItemContainer: ({ children }: {
-    children: ReactNode;
-}) => JSX.Element;
-/**
- * __Dialog action item__
- *
- * Action items shown inside of the dialog.
- *
- * @internal
- */
-export declare const DialogActionItem: ({ children }: {
-    children: ReactNode;
-}) => JSX.Element;

package/dist/types-ts4.5/styled/modal.d.ts

@@ -1,51 +0,0 @@
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-import { type ReactNode } from 'react';
-type ModalImageProps = {
-    alt: string;
-    src?: string;
-};
-type ModalActionContainerProps = {
-    shouldReverseButtonOrder: boolean;
-    children: ReactNode;
-};
-/**
- * __Modal body__
- *
- * @internal
- */
-export declare const ModalBody: ({ children }: {
-    children: ReactNode;
-}) => JSX.Element;
-/**
- * __Modal heading__
- *
- * @internal
- */
-export declare const ModalHeading: ({ children, id, }: {
-    children: ReactNode;
-    id: string;
-}) => JSX.Element;
-/**
- * __Modal image__
- *
- * @internal
- */
-export declare const ModalImage: ({ alt, src }: ModalImageProps) => JSX.Element;
-/**
- * __Modal action container__
- *
- * @internal
- */
-export declare const ModalActionContainer: ({ children, shouldReverseButtonOrder, }: ModalActionContainerProps) => JSX.Element;
-/**
- * __Modal action item__
- *
- * @internal
- */
-export declare const ModalActionItem: ({ children }: {
-    children: ReactNode;
-}) => JSX.Element;
-export {};

package/dist/types-ts4.5/styled/target.d.ts

@@ -1,45 +0,0 @@
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-import { type HTMLAttributes, type ReactNode } from 'react';
-type BaseProps = React.HTMLAttributes<HTMLDivElement> & {
-    bgColor?: string;
-    children?: ReactNode;
-    className?: string;
-    radius?: number | string;
-    testId?: string;
-};
-type TargetProps = Omit<BaseProps, 'css'> & {
-    pulse?: boolean;
-};
-/**
- * __Target inner__
- *
- * Used to apply spotlight border and pulse to spotlight targets.
- *
- * @internal
- */
-export declare const TargetInner: ({ bgColor, children, className, pulse, radius, testId, ...props }: TargetProps) => JSX.Element;
-/**
- * __Target overlay__
- *
- * Overlays a spotlight target, allowing for custom click events that are intended
- * only for onboarding.
- *
- * @internal
- */
-export declare const TargetOverlay: ({ onClick, ...props }: HTMLAttributes<HTMLDivElement>) => JSX.Element;
-/**
- * __Spotlight pulse__
- *
- * A spotlight pulse draws attention to a new feature.
- *
- * - [Examples](https://atlassian.design/components/onboarding/examples)
- * - [Code](https://atlassian.design/components/onboarding/code)
- * - [Usage](https://atlassian.design/components/onboarding/usage)
- *
- * @deprecated Use `@atlaskit/spotlight` instead.
- */
-export declare const Pulse: ({ bgColor, children, className, radius, pulse, testId, ...props }: TargetProps) => JSX.Element;
-export {};

package/dist/types-ts4.5/types.d.ts

@@ -1,173 +0,0 @@
-import { type ComponentType, type MouseEvent, type ReactNode, type Ref } from 'react';
-import { type CustomThemeButtonProps } from '@atlaskit/button/types';
-interface Action extends Omit<CustomThemeButtonProps, 'children'> {
-    key?: string;
-    text?: ReactNode;
-}
-export type Actions = Action[];
-export type ScrollLogicalPosition = 'start' | 'center' | 'end' | 'nearest';
-export interface SpotlightProps {
-    /**
-     * Buttons to render in the footer.
-     */
-    actions?: Actions;
-    /**
-     * An optional node to be rendered beside the footer actions.
-     */
-    actionsBeforeElement?: ReactNode;
-    /**
-     * The elements rendered in the modal.
-     */
-    children?: ReactNode;
-    /**
-     * Where the dialog should appear, relative to the contents of the children.
-     */
-    dialogPlacement?: 'top left' | 'top center' | 'top right' | 'right top' | 'right middle' | 'right bottom' | 'bottom left' | 'bottom center' | 'bottom right' | 'left top' | 'left middle' | 'left bottom';
-    /**
-     * The width of the dialog in pixels. The minimum possible width is 160px and the maximum width is 600px.
-     */
-    dialogWidth?: number;
-    /**
-     * Optional element rendered below the body.
-     */
-    footer?: ComponentType<any>;
-    /**
-     * Optional element rendered above the body.
-     */
-    header?: ComponentType<any>;
-    /**
-     * Heading text rendered above the body.
-     */
-    heading?: string;
-    /**
-     * An optional element rendered to the right of the heading.
-     */
-    headingAfterElement?: ReactNode;
-    /**
-     * Path to the image.
-     */
-    image?: string;
-    /**
-     * Whether or not to display a pulse animation around the spotlighted element.
-     */
-    pulse?: boolean;
-    /**
-     * Whether the spotlight should check for changes to the spotlighted element or its position.
-     * This prop may negatively affect performance and should be used only if layout shifts are causing the spotlight to be positioned incorrectly.
-     */
-    shouldWatchTarget?: boolean;
-    /**
-     * The name of the SpotlightTarget.
-     */
-    target?: string;
-    /**
-     * The spotlight target node.
-     */
-    targetNode?: HTMLElement;
-    /**
-     * The background color of the element being highlighted.
-     */
-    targetBgColor?: string;
-    /**
-     * Function to fire when a person clicks on the cloned target.
-     */
-    targetOnClick?: (eventData: {
-        event: MouseEvent<HTMLElement>;
-        target?: string;
-    }) => void;
-    /**
-     * The border radius of the element being highlighted.
-     */
-    targetRadius?: number | string;
-    /**
-     * Alternative element to render than the wrapped target.
-     */
-    targetReplacement?: ComponentType<any>;
-    /**
-     * This prop is a unique string that appears as an attribute `data-testid` in the rendered HTML output serving as a hook for automated tests.
-     * Defaults to `"spotlight"`.
-     * As this component is composed of multiple components we use this `testId` as a prefix:
-     * - `"${testId}--dialog"` to identify the spotlight dialog
-     * - `"${testId}--target"` to identify the spotlight target clone
-     */
-    testId?: string;
-    /**
-     * Used set the 'block' attribute on scrollIntoView, which determines the vertical alignment of the target node to the nearest scrollable ancestor.
-     */
-    scrollPositionBlock?: ScrollLogicalPosition;
-    /**
-     * Refers to an `aria-label` attribute. Sets an accessible name for the spotlight dialog wrapper to announce it to users of assistive technology.
-     * Usage of either this, or the `titleId` prop is strongly recommended to improve accessibility.
-     */
-    label?: string;
-    /**
-     * Refers to a value of an `aria-labelledby` attribute. References an element to define accessible name for the spotlight dialog.
-     * Usage of either this, or the `label` prop is strongly recommended to improve accessibility.
-     */
-    titleId?: string;
-}
-export interface SpotlightCardProps {
-    /**
-     * Buttons to render in the footer.
-     */
-    actions?: Actions;
-    /**
-     * An optional element rendered to the left of the footer actions.
-     */
-    actionsBeforeElement?: ReactNode;
-    /**
-     * The content of the card.
-     */
-    children?: ReactNode;
-    /**
-     * The container elements rendered by the component.
-     */
-    components?: {
-        Header?: ComponentType<any>;
-        Footer?: ComponentType<any>;
-    };
-    /**
-     * The heading to be rendered above the body content.
-     */
-    heading?: ReactNode;
-    /**
-     * Specifies the heading level in the document structure.
-     * If not specified, level 4 will be applied by default.
-     */
-    headingLevel?: 1 | 2 | 3 | 4 | 5 | 6;
-    /**
-     * An optional element rendered to the right of the heading, usually used to number steps in a multi-step flow.
-     */
-    headingAfterElement?: ReactNode;
-    /**
-     * The image src to render above the heading.
-     */
-    image?: string | ReactNode;
-    /**
-     * Removes elevation styles if set.
-     */
-    isFlat?: boolean;
-    /**
-     * Specifies the width of the card component. Accepts either a number or the string '100%'.
-     * When a number is provided, the width is set in pixels. When '100%' is provided, the width
-     * is set to occupy 100% of the parent container's width. Regardless of whether `width` is set,
-     * the width is constrained to a minimum width of 160px and a maximum width of 600px.
-     */
-    width?: number | '100%';
-    /**
-     * @deprecated
-     * Use `ref` instead.
-     */
-    innerRef?: Ref<HTMLDivElement> | null;
-    /**
-     * 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;
-    /**
-     * The ID of heading.
-     */
-    headingId?: string;
-}
-export {};

package/dist/types-ts4.5/utils/use-element-box.d.ts

@@ -1,20 +0,0 @@
-export interface ElementBoundingBox {
-    height: number;
-    left: number;
-    top: number;
-    width: number;
-}
-type ResizeUpdateMethod = 'polling' | 'resizeListener';
-/**
- * __Element box__
- *
- * Allows consumption of `userElementBox` hook through render props.
- *
- * @internal
- */
-export declare const ElementBox: (props: {
-    element: HTMLElement;
-    children: (box: ElementBoundingBox) => any;
-    resizeUpdateMethod?: ResizeUpdateMethod;
-}) => any;
-export {};

package/dist/types-ts4.5/utils/use-element-observer.d.ts

@@ -1,16 +0,0 @@
-/**
- * A hook that watches for changes to a node and forces a re-render when it changes.
- *
- * @param element The node to watch for changes.
- * @param opts Options for the hook.
- * @param [opts.disableWatch=false] Whether to watch for changes or not.
- * @param [opts.onChange] A callback that is called when the node changes.
- *
- * @returns A version number that is incremented when the node changes to force a re-render.
- *
- * @internal
- */
-export declare function useElementObserver(element: Node, opts?: {
-    disableWatch?: boolean;
-    onChange?: (version: number) => void;
-}): number;