@kiwicom/orbit-components
TypeScript icon, indicating that this package has built-in type declarations

12.4.0 • Public • Published

Orbit-components

Orbit-components is a React component library to help developers build travel products. Orbit aims to bring order and consistency to all of our products and processes. We elevate the user experience and increase the speed and efficiency of how we design and build products.

Installation

orbit-components is an npm package.

Run npm to add the package to your project:

npm install --save @kiwicom/orbit-components

or do so with Yarn:

yarn add @kiwicom/orbit-components

Usage

  1. Import the fonts that are used in orbit-components:

    <link
      href="https://fonts.googleapis.com/css?family=Roboto:400,400i,500,500i,700"
      rel="stylesheet"
    />

    Or via CSS:

    @import url("https://fonts.googleapis.com/css?family=Roboto:400,400i,500,500i,700");
  2. Include any of our components in your project and use it:

    import Alert from "@kiwicom/orbit-components/lib/Alert";
    
    <Alert>Hello World!</Alert>;

For a live preview, check out our Storybook or orbit.kiwi.

You can also try orbit-components live on CodeSandbox.

Typescript

Orbit comes with Typescript definition files. If you're working with Typescript, you need to add a type for styled-components.

// with npm
npm install @types/styled-components --save-dev

// with yarn
yarn add @types/styled-components -D

Contributing

We're working on making this project fully open-source. We appreciate any contributions you might make.

Bug reports and feature requests are welcome, but please use the correct template.

Please check out our contribution guide. It includes contribution guidelines and information on how to run and develop the project.

Package Sidebar

Install

npm i @kiwicom/orbit-components

Weekly Downloads

6,799

Version

12.4.0

License

MIT

Unpacked Size

7.94 MB

Total Files

3262

Last publish

Collaborators

  • mvidalgarcia
  • dsil
  • jakubzaba
  • robincsl_kiwi
  • kiwicom.platform
  • dinodsaurus