Orbit
Orbit is a Vue.js UI Component Library built on a beautiful, cohesive design system.
Orbit includes over 50 easy to use components and enables you to quickly construct clean and scalable applications.
Documentation
- Contribution Guide - Learn about Orbit component development, testing, and release steps
Quick start
#1 Add Orbit as a dependency
npm install --save @square/orbit
#2 Import the CSS
Import the following CSS file as an asset to your build. Do not @import them into the style tag of your App.vue, as doing so will unecessarily pre-process them.
- @square/orbit/styles.css: includes all the base css for orbit components
#3 Import an Orbit component
Update /src/App.vue with the following:
<template>
<div id="app">
<h1>Orbit v2</h1>
<o-button>Button</o-button>
</div>
</template>
<script>
// Components are imported individually as needed.
// Note the object {} syntax. 'import OButton' will not work.
import { OButton } from '@square/orbit/components/Button';
export default {
name: 'app',
components: { OButton }
}
</script>
Browser Support
Orbit supports all evergreen browsers.
Changelog
Every release and their changes are documented in Releases.