Initial commit
This commit is contained in:
46
docs/guides/getting-started.md
Normal file
46
docs/guides/getting-started.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# Vuer UIKit Getting Started Guide
|
||||
|
||||
## Overview
|
||||
|
||||
The VUER UI Kit is a React component library designed to integrate with VUER for controlling 3D scenes. This documentation provides guidance on setup and component usage.
|
||||
|
||||
## Installation
|
||||
|
||||
To begin using the toolkit, install the package via yarn:
|
||||
|
||||
```
|
||||
yarn add @vuer-ai/vuer-uikit
|
||||
```
|
||||
|
||||
## Quick Start Example
|
||||
|
||||
Here's a basic implementation to verify successful setup:
|
||||
|
||||
```jsx
|
||||
import { Button } from '@vuer-ai/vuer-uikit';
|
||||
|
||||
function App() {
|
||||
return <Button>Hello VUER!</Button>;
|
||||
}
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
After installation, the documentation recommends exploring the Getting Started guide to learn project setup details and component implementation patterns.
|
||||
|
||||
## Available Components
|
||||
|
||||
The library includes over 40 components organized by category:
|
||||
|
||||
- **Form Inputs**: Input fields, number inputs, specialized controls
|
||||
- **Layout Components**: Modals, drawers, cards, sidebar, navbar
|
||||
- **Interactive Elements**: Buttons, toggles, dropdowns, tabs, sliders
|
||||
- **Display Components**: Avatars, badges, progress indicators, tooltips
|
||||
- **Advanced Features**: Tree views, tables, pagination, drag-selectable elements
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- Style guide covering colors, fonts, icons, and layout principles
|
||||
- Dial system documentation for input type handling
|
||||
- Menu and toolbar layout patterns
|
||||
- Hook utilities for React integration
|
||||
Reference in New Issue
Block a user