UNPKG

tgb-component-library

Version:

Tagboard reusable component library for Vue 3 services.

50 lines (37 loc) • 1.35 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# tgb-component-library Tagboard reusable component library for Vue 3 services. ## NavBar ### Props: (All props are optional) #### icon: String accepts filepath to icon image to display. This is the logo that will appear in the left corner of the NavBar. #### appName: String accepts name of service to display after the icon. #### navLinks: Array (of objects) currently accepts array of objects, each including a title property with a string value. These strings are what will be rendered as the titles of the navigation tabs. Leaving these as objects for now in case we need to pass additional information with each tab. If we need to only pass the tab titles, then this will be refactored to be an array of strings. #### activeTab: String accepts a string value matching a title value in the navLinks array. This is used to delineate which tab is the active tab. #### user: Object accepts a user object with the displayName and avatar properties, both of which are strings. ## Project setup ``` npm install ``` ### Compiles and hot-reloads for development ``` npm run serve ``` ### Compiles and minifies for production ``` npm run build ``` ### Run your unit tests ``` npm run test:unit ``` ### Lints and fixes files ``` npm run lint ``` ### Customize configuration See [Configuration Reference](https://cli.vuejs.org/config/).