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
|
||||
39
docs/guides/introduction.md
Normal file
39
docs/guides/introduction.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# Vuer UIKit Introduction
|
||||
|
||||
## Overview
|
||||
|
||||
The Vuer UI Kit represents a comprehensive component library designed specifically for React applications. It integrates seamlessly with VUER to provide developers with the capability to manage 3D scene interactions.
|
||||
|
||||
## Quick Start Guide
|
||||
|
||||
Getting up and running with Vuer UI Kit requires just a few straightforward steps:
|
||||
|
||||
### Installation
|
||||
|
||||
Begin by installing the package using your preferred package manager:
|
||||
|
||||
```
|
||||
yarn add @vuer-ai/vuer-uikit
|
||||
```
|
||||
|
||||
### Basic Usage
|
||||
|
||||
Once installed, you can immediately start building components:
|
||||
|
||||
```javascript
|
||||
import { Button } from '@vuer-ai/vuer-uikit';
|
||||
|
||||
function App() {
|
||||
return <Button>Hello VUER!</Button>;
|
||||
}
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
The documentation provides a "Getting Started" guide for developers seeking deeper knowledge about project setup and component implementation. This foundational resource helps developers understand how to leverage the full capabilities of the library in their applications.
|
||||
|
||||
## Package Information
|
||||
|
||||
- **Version**: v0.0.117
|
||||
- **Related CLI Tool**: dial-cli v0.0.22
|
||||
- **Repository**: Available on GitHub for community contributions and issue tracking
|
||||
Reference in New Issue
Block a user