@atoms-studio/components

Atoms UI Kit / 🎨 Components

Unstyled components that cover most common UI patterns.
Uses Vite in lib mode to build for production.
Uses Vitest to run unit tests.

Installation

yarn add @atoms-studio/components

Then in your Vue app main entry point:

import { createApp } from 'vue'
import Components from '@atoms-studio/components'

const app = createApp(App)
app.use(Components, {
    baseUrl: 'http://localhost:3000'
})
app.mount('#app')

Development

• Components must be written in Typescript
• You can use templates or render functions as you please.
• You can use composables from the 📦 Composables package.
• You can use Options API, Composition API, <script setup> as you see fit.
• Every component must have a unit test suite in the tests folder named after it, ie: test/<componentName>.test.ts.
  
• Every component must have an example app in the ℹ️ Examples package.
• Every component must have an E2E test that consumes the example app.

To execute unit tests, run yarn test in the packages/components folder.