Orbit-components is a React component library which provides developers with the easiest possible way of building Kiwi.com’s products.
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.
orbit-components are 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
Don’t forget to install the styled-components
- 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:
- 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 or dictionary inside your project, it’s necessary to wrap your app into
<ThemeProvider>. See this document for more information.
You can also try
orbit-components live on CodeSandbox.
Orbit comes with both Flow and Typescript definitions files, so you can choose what fits your project. However, if you work with Typescript, you need to add type for
// with npm npm install @types/styled-components --save-dev // with yarn yarn add @types/styled-components -D
We are 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 #orbit-components on Slack.