Skip to content

Latest commit

 

History

History
101 lines (61 loc) · 4.6 KB

readme.md

File metadata and controls

101 lines (61 loc) · 4.6 KB
Raw

Kiwi.com library CI Build Orbit release lerna minified and gzipped size Maintenance Downloads

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

Orbit Mission

Orbit aims to bring order and consistency to all of our products and processes. We elevate user experience and increase the speed and efficiency of how we design and build products.

Installation

orbit-components is served as an npm package.

Add them to your project by running:

// with npm
npm install @kiwicom/orbit-components

// with yarn
yarn add @kiwicom/orbit-components

Usage

  1. Import 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");
  1. Include any of our components in your project and use it:
import Alert from "@kiwicom/orbit-components/lib/Alert";

<Alert>Hello World!</Alert>;

If you want to use custom theme inside your project, it's necessary to wrap your app into <OrbitProvider>. See this document for more information.

For live preview check out Storybook or orbit.kiwi.

You can also try orbit-components directly on our Playground.

Documentation

For full documentation, visit orbit.kiwi.

Typescript

Orbit comes with Typescript definitions files.

Tailwind CSS

Orbit uses Tailwind CSS for styling. Tailwind must be installed in your project to see Orbit components styled correctly.

The @kiwicom/orbit-tailwind-preset package provides the Tailwind CSS configuration used in Orbit.

Check the Orbit official documentation for more information on how to set up Tailwind CSS in your project.

Main Sections

Contributing

We are working on making this project a 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.

Feedback

We want to provide only components of the highest quality. We can’t do that without your feedback. If you have any suggestions about what we can do to improve components, please report it directly as an issue.