react-magma-dom 4.15.1-next.7 → 4.16.0-next.8

package/dist/components/Skeleton/index.d.ts

@@ -0,0 +1,61 @@
+import * as React from 'react';
+import { ThemeInterface } from '../../theme/magma';
+export interface SkeletonProps extends React.HTMLAttributes<HTMLSpanElement> {
+    /**
+     * Optional content the skeleton will size itself to match. The children are
+     * kept in the layout to reserve their space but are hidden from view.
+     * @children optional
+     */
+    children?: React.ReactNode;
+    /**
+     * The style of animation played while loading.
+     * @default SkeletonAnimation.shimmer
+     */
+    animation?: SkeletonAnimation;
+    /**
+     * If true, the animation will play. The animation is always disabled
+     * for users who have the `prefers-reduced-motion` setting enabled, regardless
+     * of this value.
+     * @default true
+     */
+    hasAnimation?: boolean;
+    /**
+     * The height of the skeleton. Can be a string or number; if a number is
+     * provided the height is in px. Ignored for the `text` variant, whose height
+     * is fixed to the theme's body line height so it stays the size of one line
+     * of text.
+     */
+    height?: number | string;
+    isInverse?: boolean;
+    /**
+     * The value passed to the `data-testid` attribute of the rendered element, so
+     * it can be targeted in tests (including by consumers of the library).
+     */
+    testId?: string;
+    /**
+     * @internal
+     */
+    theme?: ThemeInterface;
+    /**
+     * The shape of the skeleton.
+     * @default SkeletonVariant.text
+     */
+    variant?: SkeletonVariant;
+    /**
+     * The width of the skeleton. Can be a string or number; if a number is
+     * provided the width is in px. Defaults to `100%` unless inferred from
+     * children.
+     */
+    width?: number | string;
+}
+export declare enum SkeletonVariant {
+    circle = "circle",
+    rectangle = "rectangle",
+    rounded = "rounded",
+    text = "text"
+}
+export declare enum SkeletonAnimation {
+    pulse = "pulse",
+    shimmer = "shimmer"
+}
+export declare const Skeleton: React.ForwardRefExoticComponent<SkeletonProps & React.RefAttributes<HTMLSpanElement>>;