https://github.com/nexmo/volta-vue
https://github.com/nexmo/volta-vue
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nexmo/volta-vue
- Owner: Nexmo
- Created: 2018-07-02T11:28:02.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2025-08-04T05:36:42.000Z (11 months ago)
- Last Synced: 2025-08-08T23:56:45.719Z (11 months ago)
- Language: Vue
- Size: 4.71 MB
- Stars: 5
- Watchers: 25
- Forks: 1
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# volta-vue
> Vue.js single file components for Vonage [Volta](https://github.com/Nexmo/volta) authored with [vue-loader](https://github.com/vuejs/vue-loader)
## Contributing
### Steps
1. Create a branch from the **develop** branch
2. Make your changes and commit to your branch
3. Create a pull request to merge your branch to **develop**
### Guidelines
- Create one branch per feature/fix
- Branches should be deleted after being merged in to **develop**
## Getting Started with NPM
```bash
npm install @vonagevolta/vue
```
### Fonts
Set the font variable value before loading the volta style sheet
```bash
$Vlt-font-url: '~@vonagevolta/core/fonts/';
@import '~@vonagevolta/core/scss/volta';
```
### Icons
Icons have a dependency on [svg-sprite-loader](https://github.com/kisenka/svg-sprite-loader)
```bash
npm install svg-sprite-loader --save-dev
```
_Webpack config_
```bash
{
test: /\.svg$/,
loader: 'svg-sprite-loader',
options: {
symbolId: 'V'
}
}
```
_App.vue_
```bash
import VoltaIcons from '@vonagevolta/core/dist/symbol/volta-icons.svg';
...
data () {
return {
VoltaIcons
}
}
```
_In your vue component_
```bash
import { VltIcon } from '@vonagevolta/vue';
export default {
components: {
VltIcon
}
...
}
```
## Running tests
We use [Vue Test Utils](https://vue-test-utils.vuejs.org/) with [Jest](https://jestjs.io/en/) for unit testing.
You can run all the tests:
```bash
npm test
```
Or a single test:
```bash
npm test test/radio/VltRadio.spec.js
```
## Viewing the docs
Clone repo
```bash
npm run dev
```