53 lines
1.4 KiB
Markdown
53 lines
1.4 KiB
Markdown
# @gkucmierz/bitcoin-logo
|
|
|
|
|
|
|
|
|
|
A premium, customizable, and interactive 3D-style Bitcoin logo component for Vue 3.
|
|
|
|
## 🚀 Features
|
|
|
|
- **Interactive 3D Rotation**: Tilt and rotate the logo with mouse or touch.
|
|
- **Inertia & Momentum**: Smooth rotation that continues after release.
|
|
- **Customizable**: Control size, colors, and animation speed via props.
|
|
- **Premium Aesthetics**: Clean SVG-based design with subtle gradients and shadows.
|
|
|
|
## 📦 Installation
|
|
|
|
```bash
|
|
npm install @gkucmierz/bitcoin-logo
|
|
```
|
|
|
|
## 🛠 Usage
|
|
|
|
```vue
|
|
<script setup>
|
|
import { BitcoinLogo } from '@gkucmierz/bitcoin-logo'
|
|
import '@gkucmierz/bitcoin-logo/style.css'
|
|
</script>
|
|
|
|
<template>
|
|
<BitcoinLogo
|
|
:size="256"
|
|
symbolColor="#f7931a"
|
|
:inertia="true"
|
|
/>
|
|
</template>
|
|
```
|
|
|
|
### Props
|
|
|
|
| Prop | Type | Default | Description |
|
|
| --- | --- | --- | --- |
|
|
| `size` | `Number` | `256` | The width and height of the logo in pixels. |
|
|
| `symbolColor` | `String` | `'#f7931a'` | The color of the Bitcoin symbol. |
|
|
| `autoRotate` | `Boolean` | `true` | Whether the logo should rotate automatically. |
|
|
| `rotationDuration` | `Number` | `10` | Duration of one full rotation in seconds. |
|
|
| `inertia` | `Boolean` | `true` | Enable inertia during manual interaction. |
|
|
|
|
---
|
|
|
|
## 📄 License
|
|
|
|
MIT
|