VueVentus DocsVvFa Component
The VvFa Component is essentially a pass-through for the font-awesome-icon component from FontAwesome's vue-fontawesome, but setup for VueVentus config defaults and components.
Import
To import a VvFa Component installed by the vueventus CLI or vv-update CLI:
// ./src/components/SomeComponent.vue
import VvFa from './vv/elements/VvFa.vue'TIP
CLI installed components pass through VueVentus defaults via component props. Each prop default value can be customized globally by overriding VvConfig defaults in your app ./src/app.vv.ts file or singularly in a component instance.
Prop: debug
Type: Boolean
Default: false
The VvFa Component debug prop toggles the debugging state of a component instance. When in debugging mode, each component instance prop value can be viewed through data-vv-fa- prefixed HTML attributes.
Syntax
<VvFa :debug="true"/>Prop: family
Type: String
Valid Values: ValidFontAwesomeFamilies Module
Default: "fas"
The VvFa Component family prop sets the font awesome family of icons you are using via your FontAwesome library() icon families.
Syntax
<VvFa family="fas"/>Typing for Downstream Component Instances
Coming Soon!
Prop: icon
Type: String
Default: "house"
The VvFa Component icon prop sets the font awesome icon from the icons you are using via your FontAwesome library() declared icons.
Syntax
<VvFa icon="house"/>Prop: size
Type: String
Valid Values: ValidFontAwesomeSizes Module
Default: "1x"
The VvFa Component size prop sets the font awesome size for any icons you are using via your FontAwesome library() declared icons.
Syntax
<VvFa size="1x"/>Typing for Downstream Component Instances
Coming Soon!
Slot: None
NO SLOT AVAILABLE
The VvFa Component does not have a Vue slot option.