@kiwicom/orbit-components/lib/Itinerary/ItinerarySegment/types.ts

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

/*
  DOCUMENTATION: https://orbit.kiwi/components/itinerary/itinerarysegment
*/

import type * as React from "react";

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

export type Status = "warning" | "critical" | "info" | "success";

/** DOCS:
  ItinerarySegment component serves as a wrapper of atomic units `ItinerarySegmentPlace` and `ItinerarySegmentDetail,
  has status prop for showing important information about the connection between two segments of journey.
*/

export interface Props extends Common.Globals, Common.SpaceAfter {
  /** The content of ItinerarySegment */
  readonly children: React.ReactNode;
  /** onClick callback that is triggered when Segment is clicked */
  readonly onClick?: Common.Event<React.SyntheticEvent<HTMLDivElement>>;
  /** Removes the box-shadow  */
  readonly noElevation?: boolean;
  readonly actionable?: boolean;
  /** Additional information to ItinerarySegment */
  readonly banner?: React.ReactNode;
  /** onExpand callback that is triggered when Segment is expanded */
  readonly onExpand?: Common.Event<React.SyntheticEvent<HTMLDivElement>>;
  /** onCollapse callback that is triggered when Segment is collapsed */
  readonly onCollapse?: Common.Event<React.SyntheticEvent<HTMLDivElement>>;
}