1.0.0 • Published 4 years ago

vuelistpackage v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
4 years ago

Vue List Package

Logo

Installation

git clone https://github.com/iLegion/Vue-List-Package.git 
cd Vue-List-Package
npm run build

This will create some builds in the dist directory.

  • UMD : vuelistpackage.umd.js and vuelistpackage.umd.min.js
  • CommonJS: vuelistpackage.common.js

You can add vuelistpackage as an npm dependency:

npm i vuelistpackage

For use import a component globally or as an subcomponent.

import VueListPackage from 'vuelistpackage';

Properties

listType: 'ul' (default) | 'ol' | 'div' | null;

listType contains type for list in HTML. See ul and ol.

If listType does not match any of the types above, then the default value will be set.

header: String | null (default);

header contains header for list.

items: Array | Object | null;

If items is empty return emptyListMsg message.

If items elements is Object, it must have prop title(priority) or name for view and can contains prop active and disabled with value 0 or 1.

If listType is 'div', items property of links must contains href(priority) or link for the link.

For badges, add property badge for items elements if have this.

styles: Object | null;

PropTypeDescription
classdefault, materialize, bootstrap (default), nullReady-made styles for the list.
listTypeString, nullSee this
colorActiveFor bootstrap: primary (default), secondary, success, danger, nullColor for active element
For materialize: primary (default), red, purple, nullColor for active element

active: String | null;

The number or property name of the active element.

disabled: String | null

The number or property name of the disabled element.

config: Object | null

PropTypeDescription
modeStringMode fo list. 'horizontal' for horizontal list and 'vertical' for vertical list.
emptyListMsgObjectConfig for message if list is empty.
emptyListMsg.classString, nullID for div element.
emptyListMsg.classString, Array, nullClassname for div element.
emptyListMsg.isComponentBoolean, nullIs the message component.
emptyListMsg.componentNameString, nullContains a correct globally registered component name.
emptyListMsg.textString, nullContains a message. If config.emptyListMsg.isComponent and config.emptyListMsg.componentName are true, the message will be inserted into the slot.

animations: Object | null

PropTypeDescription
startStringClass for start animation. You can use custom css libraries
endStringClass for end animation. You can user custom css libraries.

All properties is reactive.

Methods

Default callback life cycle: beforeCreate, created, beforeMount, mounted, beforeUpdate, updated, beforeDestroy, destroyed. See this.

listUpdated:

Called after list is updated.

clickOnItem:

Called after click event.

Contributing

If you would like to start issues, one easy way to get started is send this on GitHub.

1.0.0

4 years ago

0.5.1

4 years ago

0.5.0

4 years ago

0.4.3

4 years ago

0.4.2

4 years ago

0.3.2

4 years ago

0.3.1

4 years ago

0.3.0

4 years ago

0.2.1

4 years ago

0.2.0

4 years ago

0.1.9

5 years ago

0.1.8

5 years ago

0.1.7

5 years ago

0.1.6

5 years ago

0.1.5

5 years ago

0.1.4

5 years ago

0.1.3

5 years ago

0.1.2

5 years ago

0.1.1

5 years ago

0.1.0

5 years ago