vx-vue 0.0.2 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,33 @@
|
|
|
1
|
-
#
|
|
1
|
+
# vxVue
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
## Introduction
|
|
4
|
+
VxVue provides a handful of reusable Vue components styled with Tailwind CSS. All components are geared towards simplicity leaving room for customizations, extensions or adaptations. At some point a more verbose documentation than this brief readme might emerge.
|
|
4
5
|
|
|
5
|
-
##
|
|
6
|
+
## Requirements
|
|
7
|
+
* Vue.js 3.*
|
|
8
|
+
* Tailwind CSS 3.*
|
|
6
9
|
|
|
7
|
-
|
|
10
|
+
The official Tailwind CSS forms plugin is used to provide basic styling of the form components using the class strategy which allows the styling of non-form elements consistently.
|
|
11
|
+
An easy to configure color theming is applied. Since Tailwind won't observe classes in imported components tailwind.config.js should contain
|
|
12
|
+
```
|
|
13
|
+
module.exports = {
|
|
14
|
+
content: [
|
|
15
|
+
'./node_modules/vx-vue/**/*.js',
|
|
16
|
+
...
|
|
17
|
+
],
|
|
18
|
+
...
|
|
19
|
+
}
|
|
20
|
+
```
|
|
21
|
+
## Provided components
|
|
22
|
+
So far the following components have been implemented:
|
|
23
|
+
|
|
24
|
+
| element | description |
|
|
25
|
+
|-------------------|----------------------------------------------------------------------------------------------------|
|
|
26
|
+
| `password-input` | a simple input with toggle button which toggles between `type='button'` and `type='text'` |
|
|
27
|
+
| `form-select` | a select element adapted for Vue.js integration |
|
|
28
|
+
| `form-switch` | a fancy checkbox |
|
|
29
|
+
| `sortable` | a sortable table; the `columns` attribute specifies the columns and their sorting options |
|
|
30
|
+
| `message-toast` | displays a notification which dismisses itself after a configurable timeout |
|
|
31
|
+
| `confirm` | promise-based component which can either take one ("confirm") or two buttons ("confirm", "cancel") |
|
|
32
|
+
| `pagination` | A pagination component for arbitrary items; opinionated in its layout |
|
|
33
|
+
| `tabs` | A tabs component which allows both badges and icons |
|