vuesax3
Version:
Framework Components for Vue 3
147 lines (115 loc) • 5.33 kB
Markdown
<p align="center">
<a href="https://l777.github.io/vuesax/">
<img width="40%" src="https://raw.githubusercontent.com/lk77/vuesax/next/public/vuesax-logo-beta.png" alt="vuesax" />
<img src="https://raw.githubusercontent.com/lk77/vuesax/next/public/vuesax-components.gif" alt="vuesax" />
</a>
</p>
</br>
<p align="center">
<a href="https://www.npmjs.com/package/vuesax3">
<img src="https://img.shields.io/npm/dm/vuesax3.svg" alt="Downloads">
</a>
<a href="https://www.npmjs.com/package/vuesax3">
<img src="https://img.shields.io/npm/v/vuesax3.svg" alt="Version">
</a>
<a href="https://www.npmjs.com/package/vuesax"><img src="https://img.shields.io/npm/l/vuesax3.svg" /></a>
</p>
## Introduction
[Vuesax](https://lk77.github.io/vuesax/) is a framework of components based on [vue.js](https://vuejs.org/), it is a framework that is designed from scratch to be incrementally adoptable.
The framework is focused on facilitating the development of applications, improving the design of the same without removing the necessary functionality. we want all the components to be independent in
colors, shapes and design for a freedom that we like all front-end but without losing the speed of creation and production.
## Vuesax 3 for Vue 3
This package is bringing support for Vue 3 to original package [Vuesax](https://www.npmjs.com/package/vuesax)
All components and functions works with Vue 3.
## Links
- 📘 [Documentation](https://lk77.github.io/vuesax/)
## Components
- [Alert](https://lk77.github.io/vuesax/components/alert.html)
- [Avatar](https://lk77.github.io/vuesax/components/avatar.html)
- [Breadcrumb](https://lk77.github.io/vuesax/components/breadcrumb.html)
- [Buttons](https://lk77.github.io/vuesax/components/buttons.html)
- [Card](https://lk77.github.io/vuesax/components/card.html)
- [Checkbox](https://lk77.github.io/vuesax/components/checkbox.html)
- [Chip](https://lk77.github.io/vuesax/components/chip.html)
- [Collapse](https://lk77.github.io/vuesax/components/collapse.html)
- [Dialog](https://lk77.github.io/vuesax/components/dialog.html)
- [Divider](https://lk77.github.io/vuesax/components/divider.html)
- [DropDown](https://lk77.github.io/vuesax/components/dropDown.html)
- [Images](https://lk77.github.io/vuesax/components/images.html)
- [Input](https://lk77.github.io/vuesax/components/input.html)
- [List](https://lk77.github.io/vuesax/components/list.html)
- [Loading](https://lk77.github.io/vuesax/components/loading.html)
- [Navbar](https://lk77.github.io/vuesax/components/navbar.html)
- [Notifications](https://lk77.github.io/vuesax/components/notifications.html)
- [Number](https://lk77.github.io/vuesax/components/number.html)
- [Pagination](https://lk77.github.io/vuesax/components/pagination.html)
- [Popup](https://lk77.github.io/vuesax/components/popup.html)
- [Progress](https://lk77.github.io/vuesax/components/progress.html)
- [Radio](https://lk77.github.io/vuesax/components/radio.html)
- [Selects](https://lk77.github.io/vuesax/components/selects.html)
- [SideBar](https://lk77.github.io/vuesax/components/sideBar.html)
- [Slider](https://lk77.github.io/vuesax/components/slider.html)
- [Switch](https://lk77.github.io/vuesax/components/switch.html)
- [Table](https://lk77.github.io/vuesax/components/table.html)
- [Tabs](https://lk77.github.io/vuesax/components/tabs.html)
- [Textarea](https://lk77.github.io/vuesax/components/textarea.html)
- [Tooltip](https://lk77.github.io/vuesax/components/tooltip.html)
- [Upload](https://lk77.github.io/vuesax/components/upload.html)
## Browser Support
Recent versions of **Firefox**, **Chrome**, **Edge**, **Opera** and **Safari**. **IE11+**
## Quick-start CDN
```html
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/vuesax3/dist/vuesax.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/material-icons@1.10.7/iconfont/material-icons.min.css">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no, minimal-ui">
</head>
<body>
<div id="app">
<vs-button vs-type="filled">Hello World</vs-button>
</div>
<script src="https://cdn.jsdelivr.net/npm/vue@next/dist/vue.global.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/vuesax3/dist/vuesax.umd.js"></script>
<script>
const app = window.Vue.createApp({});
app.use(window.Vuesax);
app.mount('#app');
</script>
</body>
</html>
```
# Install inside a NPM project
``` bash
# npm
npm install vuesax3
```
``` bash
# yarn
yarn add vuesax3
```
## Use
### All components
```javascript
import { createApp } from 'vue'
import Vuesax from 'vuesax3'
import 'vuesax3/dist/vuesax.css'
const app = createApp({})
app.use(Vuesax)
```
### Or use individual components:
```javascript
import { createApp } from 'vue'
import { vsButton, vsPrompt } from 'vuesax3'
import 'vuesax3/dist/vuesax.css'
const app = createApp({})
app.use(vsButton)
app.use(vsPrompt)
```
## Contribution
Please make sure to read the [Contributing Guide](https://raw.githubusercontent.com/lk77/vuesax/next/CONTRIBUTING.md) before making a pull request.
## Lusaxweb
The upstream library was created and was supported by [Lusaxweb](http://lusaxweb.net/)
## License
[MIT](https://raw.githubusercontent.com/lk77/vuesax/next/LICENSE)