sit-onyx

Onyx

A design system and Vue.js component library created by Schwarz IT.

Work in progress: This library is currently in early / active development.

Getting Started

Install the npm package with your corresponding package manager:

pnpm

pnpm add sit-onyx

npm

npm install sit-onyx

yarn

yarn install sit-onyx

After that, import the global CSS file in your main.ts file:

import "sit-onyx/style.css";
// if you override some Onyx styles (e.g. CSS variables),
// make sure to import your custom CSS file after the default "sit-onyx/style.css"

Components are now ready to be used, e.g.:

<script lang="ts" setup>
import { OnyxButton } from "sit-onyx";
</script>

<template>
  <OnyxButton label="Click me" />
</template>

Contributing