/orbit-swiftui

Kiwi.com Orbit design system library

Primary LanguageSwiftMIT LicenseMIT

orbit-components

Kiwi.com library swiftui-version swift-version swift-package-manager Build

Orbit is a SwiftUI component library which provides developers 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.

Orbit is an open-source design system created for specific needs of Kiwi.com and together with that – for needs of travel projects.

This library allows you to integrate the Orbit design system into your iOS SwiftUI project.

Requirements

  • iOS 13
  • Xcode 13
  • Swift Package Manager

Installation

Add Orbit package to your project by adding the package dependency:

.package(name: "Orbit", url: "https://github.com/kiwicom/orbit-swiftui.git", .upToNextMajor(from: "0.8.0")),

Documentation

DocC
DocC documentation

The online documentation contains instructions on how to get started with the library once you integrate it into your project, as well as examples and pages for individual components.

You can also build this documentation locally in Xcode (Product -> Build Documentation).

App Store

The app can also be downloaded from the App Store.

Download on the App Store

Contributing

Feel free to create bug reports and feature requests via the Issues tab.

If you want to directly contribute by fixing a bug or implementing a feature or enhancement, you are welcome to do so. Pull request review has following priorities to check:

  1. API consistency with other components (similar components should have similar API)
  2. Component variants matching design variants (components should have same properties as design)
  3. Visual match to designs
  4. Internal code structure consistency (button-like components should use consistent mechanism, haptics etc.)
  5. Previews / Storybook consistency (a new component needs to be added to the Storybook)

Feedback

We want to provide high quality and easy to use components. We can’t do that without your feedback. If you have any suggestions about what we can do to improve, please report it directly as an issue or write to us at #orbit-components on Slack.