@kiwicom/orbit-components/lib/HorizontalScroll/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 * as React from "react";

import { Spacing } from "../Stack";
import * as Common from "../common/common";

/** DOCS:
  To implement HorizontalScroll component into your project you'll need to add the import:

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

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

  ```jsx
  <HorizontalScroll>
    <FirstComponent />
    <SecondComponent />
    <ThirdComponent />
    ...etc
  </HorizontalScroll>
  ```
*/

type ScrollSnap = "mandatory" | "proximity" | "inline" | "none";

export interface Props extends Common.Global {
  /** set minimal height */
  readonly minHeight?: number;
  /** prop for testing purposes */
  readonly dataTest?: string;
  /** The spacing between children elements */
  /** default: "small" */
  readonly spacing?: Spacing;
  /** content of HorizontalScroll */
  readonly children: React.ReactNode;
  readonly scrollSnap?: ScrollSnap;
  readonly scrollPadding?: number;
  readonly overflowElevation?: boolean;
  readonly elevationColor?: string;
  readonly onOverflow?: () => void;
}

declare const HorizontalScroll: React.ForwardRefRenderFunction<HTMLDivElement, Props>;
export { HorizontalScroll, HorizontalScroll as default };