How to use our components from their npm package.
Orbit-components is a React component library to help developers build Kiwi.com 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.
orbit-components is served as an npm package.
Add them to your project by running:
// with npmnpm install @kiwicom/orbit-components// with yarnyarn add @kiwicom/orbit-components
Don’t forget to also install styled-components
Import the fonts that are used in
Or via CSS:@import url("https://fonts.googleapis.com/css?family=Roboto:400,400i,500,500i,700");
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 a custom theme or dictionary inside your project,
it’s necessary to wrap your app in
See more info about the theme provider.
You can also try
orbit-components live on CodeSandbox.
Orbit comes with both Flow and Typescript definition files, so you can choose what fits your project.
If you’re working with Typescript, you need to add a type for
// with npmnpm install @types/styled-components --save-dev// with yarnyarn add @types/styled-components -D
We’re working on making this project a fully open source. We appreciate any contributions you might make.
Please check out our contribution guide. It includes contribution guidelines and information on how to run and develop the project.
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 or write to us at #plz-orbit on Slack.