2.1.1 • Published 3 years ago
@sphirye/vue-hexagonal-container v2.1.1
vue-hexagonal-container
A Hexagonal Vue Component.
Installation
NPM:
npm i --save-dev vue-hexagonal
Mount:
//main.js
import Vue from 'vue';
import VueHexagonal from '@sphirye/vue-hexagonal-container';
Vue.use(VueHexagonal);
Then in your view/component:
<template>
<VueHexagonal/>
</template>
<script>
import { VueHexagonal } from '@sphirye/vue-hexagonal';
export default {
components: { VueHexagonal }
}
</script>
Usage
There's 5 props that vue-hexagonal-container can handle:
img
outlined
width
height
text
heptagon
borderColor
backgroundColor
Images
Use img
prop to pass image sources to the component.
<VueHexagonal img="https://static.wikia.nocookie.net/cookierun/images/c/c1/Starfruit_Cookie.png"/>
Outlined
Use outlined
prop to draw a outline around the hexagon component.
<VueHexagonal outlined/>
Width and Height
Use Width
and Height
props to handle the hexagon component size.
Text
Use text
prop to display text in the hexagon component.
<VueHexagonal text="sus"/>
Heptagon
Use heptagon
prop to display a heptagon instead a hexagon.
<VueHexagonal heptagon/>
Border Color
Use borderColor
prop (while using outlined
prop) to change the outline color.
<VueHexagonal outlined borderColor="#000"/>
Background Color
Use backgroundColor
prop to change the hexagon content background color.
(Currently dont handle transparency).
<VueHexagonal backgroundColor="#000"/>