@kiwicom/orbit-components/lib/Skeleton/index.d.ts

Orbit-components is a React component library which provides developers with the easiest possible way of building Kiwi.com’s products.

// Type definitions for @kiwicom/orbit-components
// Project: http://github.com/kiwicom/orbit
import React from "react";

import * as Common from "../common/common";

type Preset = "List" | "Image" | "Card" | "Button" | "Text";

/**  DOCS:
Skeleton component display a placeholder preview before the data gets loaded.

To implement Separator component into your project you'll need to add the import:

```jsx
import Skeleton from "@kiwicom/orbit-components/lib/Skeleton";
```

After adding import into your project you can use it simply like:

```jsx
<Skeleton>
  <rect x="48" y="8" rx="3" ry="3" width="88" height="6" />
  <rect x="48" y="26" rx="3" ry="3" width="52" height="6" />
  <rect x="0" y="56" rx="3" ry="3" width="410" height="6" />
</Skeleton>
```

or if you need to render only rect, you can use the `row` property like:

```jsx
<Skeleton rows={3} rowOffset={15} rowHeight={10} />
```

or you can pick one from our predefined presets:

```jsx
<Skeleton variant="Button" />
```
*/

export interface Props extends Common.SpaceAfter, Common.Global {
  readonly animate?: boolean;
  readonly children?: React.ReactNode;
  /** Border-radius for row rect elements */
  /** default: `3` */
  readonly rowBorderRadius?: number;
  /** Set height for rect elements  */
  /** default: `21` */
  readonly rowHeight?: number;
  /** Set offset between rect elements  */
  /** default: `20` */
  readonly rowOffset?: number;
  /** Number of rect elements */
  readonly rows?: number;
  /** Add text for svg accessible name element  */
  readonly title?: string;
  /** You can pick one of predefined presets  */
  readonly preset?: Preset;
  /** Set viewBox for Svg element */
  readonly viewBox?: string;
  /** Width of Svg element */
  readonly width?: number | string;
  /** Set height for Svg element */
  readonly height?: number | string;
  /** Allow you to set color from orbit palette  */
  readonly color?: string;
  /** Set max-height for Svg element */
  readonly maxHeight?: number | string;
}

declare const Skeleton: React.FunctionComponent<Props>;

export default Skeleton;