@rocketui/vue v0.3.0-alpha.2

Installation

yarn add @rocketui/vue

Usage

Your main.js file should look like this:

import { createApp } from 'vue'
import App from './App.vue'

// Import the Styles
import '@rocketui/vue/dist/style.css'

// Optional: Import and register directives globally
import { vTooltip } from '@rocketui/vue/directives'

const app = createApp(App)
app.directive('tooltip', vTooltip)
app.mount('#app')

Then you can use the components in your App.vue file:

<script setup>
import { RButton } from '@rocketui/vue'
</script>

<template>
  <RButton>Rocket UI Button</RButton>
  
  <!-- Or use directives (if registered globally) -->
  <button v-tooltip="'Simple tooltip'">Hover me</button>
  
  <!-- With options -->
  <button v-tooltip="{
    text: 'Custom tooltip',
    placement: 'right',
    trigger: 'click'
  }">Click me</button>
</template>

Directives

Tooltip Directive

The tooltip directive provides a quick way to add tooltips to any element:

<!-- Simple usage -->
<button v-tooltip="'Tooltip text'">Hover me</button>

<!-- With options -->
<button v-tooltip="{
  text: 'Tooltip with options',
  placement: 'bottom',
  trigger: 'click',
  outsideClick: true,
  dark: false
}">Click me</button>

Available Options

• text: Tooltip content (required)
• placement: 'top' | 'bottom' | 'left' | 'right' (default: 'top')
• trigger: 'hover' | 'click' (default: 'hover')
• delay: Show delay in milliseconds (default: 0)
• offset: Distance from trigger element (default: 8)
• dark: Dark theme (default: true)
• disabled: Disable tooltip (default: false)
• outsideClick: Close on outside click for click trigger (default: false)

Development

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension 1) Run Extensions: Show Built-in Extensions from VSCode's command palette 2) Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize configuration

See Vite Configuration Reference.

Project Setup

yarn install

Compile and Hot-Reload for Development

yarn dev

Type-Check, Compile and Minify for Production

yarn build

Run Unit Tests with Vitest

yarn test:unit

Lint with ESLint

yarn lint

Contribution

We welcome contributions of any kind including documentation, bug reports, bug fixes, feature requests, feature implementations, and pull requests. If you're interested in contributing to this project, please follow these guidelines:

• Fork this repository to your own GitHub account and then clone it to your local device.
• Install the dependencies by running yarn install.
• Run yarn dev to start the dev server and see your changes in real-time as you edit the source files.
• Create a new branch for your changes, e.g. git checkout -b my-feature.
• Make your changes and commit them with a descriptive message.
• Push your changes to your forked repository, e.g. git push -u origin my-feature.
• Create a pull request from your forked repository to this repository, and describe the changes you've made and why they should be merged.
• Before submitting a pull request, please make sure that your changes pass the following checks:

The unit tests pass by running yarn test:unit. The code passes the ESLint check by running yarn lint. The code builds without errors by running yarn build.

We aim to respond to all pull requests and issues within 48 hours. Thank you for your interest in contributing to Rocket UI Vue!

License

MIT. See LICENSE for more details.