getting-started.md

title	Getting started
description	A quick tutorial to begin your journey with Typlog UI.

Installation

1. Install the library

Install the package from your command line.

2. Import the CSS file

Import the global CSS file at the root of your application.

@import "@typlog/ui";

The addon and chart entry points publish their styles separately. Import them only when your application uses those entry points:

@import "@typlog/ui/addons";
@import "@typlog/ui/charts";

3. Add the ThemeProvider

Add ThemeProvider to your App.vue.

<script setup lang="ts">
  import { ThemeProvider } from '@typlog/ui'
</script>

<template>
  <ThemeProvider>
    <!-- your application -->
  </ThemeProvider>
</template>

Customizing your theme

<template>
  <ThemeProvider accent-color="crimson" gray-color="sand" radius="large" scaling="95%">
    <!-- your application -->
  </ThemeProvider>
</template>