Home

Awesome

vue-uix

A vue component library based on the JUI components available in vuejs.

forthebadge forthebadge forthebadge forthebadge

Installation

NPM

npm install --save vue-uix

Browser (Legacy)

If you are using an existing JUI style, Just download dist/vue-uix.base.js and include it in your HTML file:

<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/vue/2.5.16/vue.js"></script>
<script src="dist/vue-uix.base.js"></script>
<link rel="stylesheet" href="jui-ui.classic.css" />
<!--<link rel="stylesheet" href="jui-ui.dark.css" />-->

Browser

Download the dist/vue-uix.classic.js and dist/vue-uix.css and include it in your HTML file:

<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/vue/2.5.16/vue.js"></script>
<script src="dist/vue-uix.classic.js"></script>
<!--<script src="dist/vue-uix.dark.js"></script>-->
<link rel="stylesheet" href="dist/vue-uix.css" />

ES Modules

Plug-In
import Vue from 'vue'
import VueUix from 'vue-uix'

Vue.use(VueUix, { theme: 'classic' })
Components (Legacy)

If you are using an existing JUI style, You must load a non-styled view component.

import Vue from 'vue'
import UixComboBox from 'vue-uix/src/components/combobox'

Vue.component(UixComboBox.name, UixComboBox);
Components
import Vue from 'vue'
import UixComboBox from 'vue-uix/src/components/combobox.classic'
// import UixComboBox from 'vue-uix/src/components/combobox.dark'

Vue.component(UixComboBox.name, UixComboBox);

Implemented components

API

Accordion

Props

NameTypeRequiredWatchDefaultDescription
typeStringfalsefalse``Additional styles of accordion (simple)
itemsArraytruefalseundefinedA list of accordion headers
indexNumberfalsefalsenullSets the accordion header to be activated
autoFoldBooleanfalsefalsefalseHide the content area when you click on the active accordion header again
widthNumber, Stringfalsetrue100%The width of the component

Events

NameArgumentsDescription
openindexEvents that occur when an accordion content is opened
foldindexEvents that occur when an accordion content is closed

Auto Complete

Props

NameTypeRequiredWatchDefaultDescription
iconStringfalsefalse``When you want to use the icon, you can set the name of the icon provided by JUI (However, you do not need to use the prefix 'icon-')
widthNumberfalsetrue150The width of the component
sizeStringfalsefalsesmallThe size styles of the component (mini, small, large)
templateStringfalsefalseskip...
itemsArraytruetrueundefinedAuto-complete word list
valueStringfalsefalse``Props to set the selected word

Events

NameArgumentsDescription
changetext, eventEvents that occur when you select a word in the Auto-complete list

Button

Props

NameTypeRequiredWatchDefaultDescription
typeStringfalsefalseradioIt is a button selection option. Radio is single and Check is multi-selectable. (radio, check)
indexNumberfalsetrue0Sets the button to be activated
valueString, Arrayfalsetrue``Selected value. Radio is string type, Check is array type
sizeStringfalsefalsesmallThe size styles of the component (mini, small, large)
itemsArraytruetrueundefinedButton list

Events

NameArgumentsDescription
changeitem, eventEvents that occur when you click a button

Color Picker

Props

NameTypeRequiredWatchDefaultDescription
colorString, Objecttruefalse#FFFDefault color code, which can be set to a hex string or an RGB object

Events

NameArgumentsDescription
changehex, rgbEvents that occur when you select a color

Combo Box

Props

NameTypeRequiredWatchDefaultDescription
indexNumberfalsetrue0Sets the item to be activated
valueStringfalsetrue``Selected value
widthNumberfalsefalse100The width of the component
heightNumberfalsefalse100The width of the component
sizeStringfalsefalsesmallThe size styles of the component (mini, small, large)
keydownBooleanfalsefalsefalseOption to select items with up/down arrow keys
flexBooleanfalsefalsetrueOption that match the width of the drop-down menu to the width of the combo box
positionStringfalsefalsebottomOption to set where the drop-down menu is shown (top, bottom)
titleStringfalsefalseSelected...When there are no items, the default message shown in the combo box
itemsArrayfalsefalsenullItem list of combo box
activeStringfalsetruefalseOptions showing a drop-down menu

Events

NameArgumentsDescription
changeitem, eventEvents that occur when you select a item

Date Picker

Props

NameTypeRequiredWatchDefaultDescription
titleFormatStringfalsefalseyyyy.MMSet the current year/month title format
dateFormatStringfalsefalseyyyy-MM-ddSet the format for selected date
dateStringfalsetruenullSet the
templateStringfalsefalse<td><!= date !></td>A template for markup that prints out the date

Events

NameArgumentsDescription
changedateStr, eventEvents that occur when you select a date
preveventEvents that occur when you change to the previous month
nexteventEvents that occur when you change to the next month

Calendar (extends Date Picker)

Props

NameTypeRequiredWatchDefaultDescription
widthString, Numberfalsefalse100%Set calendar width
heightString, Numberfalsefalse100%Set calendar height

Dropdown

Props

NameTypeRequiredWatchDefaultDescription
indexNumberfalsefalse0Sets the item to be activated
widthNumberfalsefalse100The width of the component
heightNumberfalsefalse100The height of the component
leftNumberfalsefalse0The left position value of the component
topNumberfalsefalse0The top position value of the component
sizeStringfalsefalsesmallThe size styles of the component (mini, small, large)
keydownBooleanfalsefalsefalseOption to select items with up/down arrow keys
itemsStringfalsetrueundefinedItem list of drop-down menu
activeBooleanfalsetruefalseOptions showing a drop-down menu
anchorBooleanfalsefalsefalseSet options to display anchor style

Events

NameArgumentsDescription
changeitem, eventEvents that occur when you select a item

Modal

Props

NameTypeRequiredWatchDefaultDescription
rootStringfalsetruenullSelector for the modal background element
targetStringfalsetruenullSelector of targeted element
activeBooleanfalsetruefalseOptions showing a modal
colorStringfalsefalseblackBackground color of modal
opacityNumberfalsefalse0.4Background opacity of modal
zIndexNumberfalsefalse0Z-index value of modal
autoHideBooleanfalsefalsefalseOption to automatically hide modal on background clicking

Notification

Props

NameTypeRequiredWatchDefaultDescription
rootStringfalsetruenullSelector for the modal background element
positionStringfalsefalsebottomOption to set where the drop-down menu is shown (top, bottom)
itemsArrayfalsetrueundefinedItem list of drop-down menu
templateStringfalsefalse<td><!= date !></td>A template for markup that prints out the date
iconStringfalsefalse``When you want to use the icon, you can set the name of the icon provided by JUI (However, you do not need to use the prefix 'icon-')
delayNumberfalsefalse3000After the notification is shown, delay time
showDurationNumberfalsefalse500Duration of effect in which notifications are shown
hideDurationNumberfalsefalse500Duration of effect in which notifications are hidden
paddingNumberfalsefalse12Padding between notification and notification
distanceNumberfalsefalse5Distance between notification and notification

Events

NameArgumentsDescription
changeitem, eventEvents that occur when you select a item
showindexEvents that occur when an notification is shown
hideindexEvents that occur when an notification is hidden

Switch

Props

NameTypeRequiredWatchDefaultDescription
insideBooleanfalsefalsetrueSets the inside style option for the switch
sizeStringfalsefalsesmallThe size styles of the component (mini, small, large)
checkedBooleanfalsefalsefalseSets the check state of the switch

Events

NameArgumentsDescription
changechecked, eventEvents that occur when you change a switch

Tab

Props

NameTypeRequiredWatchDefaultDescription
typeStringfalsefalsetabSet tab style type (tab, pill)
positionStringfalsefalsetopSets the position of the tab (top, bottom)
itemsArrayfalsetrueundefinedItem list of tab
indexNumberfalsetrue0Sets the item to be activated
disableArrayfalsetruenullSets the index of the tab to be disabled

Events

NameArgumentsDescription
changechecked, eventEvents that occur when you change a activated tab

Tree

Props

NameTypeRequiredWatchDefaultDescription
typeStringfalsefalselineSet tree style type (line, line-file, arrow, arow-file)
rootNameStringfalsefalsenullSets the name of the root node
rootHideBooleanfalsefalsefalseOption to hide root node by default
rootFoldBooleanfalsefalsefalseOption to hide fold node by default
templateStringfalsefalse<li><div><i></i> <!= text !></div><ul></ul></li>A template for markup that prints out the node
itemsArrayfalsetrueundefinedNode list of tree
itemObjectfalsetruenullSets the node to be activated

Events

NameArgumentsDescription
changeitem, eventEvents that occur when you select a node
openitem, eventEvents that occur when the child nodes of the selected node are opened
folditem, eventEvents that occur when the child nodes of the selected node are folded

Time Picker

Props

NameTypeRequiredWatchDefaultDescription
sizeStringfalsefalsesmallThe size styles of the component (mini, small, large)
useDateBooleanfalsefalsefalseUse the year/month/day button
useTimeBooleanfalsefalsefalseUse the hours/minutes button
minYearNumberfalsefalseautoMinimum year
maxYearNumberfalsefalseautoMaximum year
yearNumberfalsefalseautoCurrent year
monthNumberfalsefalseautoCurrent month
dateNumberfalsefalseautoCurrent date
hoursNumberfalsefalseautoCurrent hours
minutesNumberfalsefalseautoCurrent minutes
useCalendarBooleanfalsefalsefalseUse the calendar component
calendarTitleFormatStringfalsefalseyyyy.MMDate format of calendar title
calendarFormatStringfalsefalseyyyy-MM-ddDate format of calendar selected value

Events

NameArgumentsDescription
changedataEvents that occur when you change a value