Skip to content

Commit 3f2d566

Browse files
authored
Merge pull request #1 from prolazydev/web
This update presents 2 new components and bug fixes
2 parents 5382320 + 600c34d commit 3f2d566

29 files changed

+2151
-241
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,4 @@ dist-ssr
3636
*.sw?
3737
.DS_Store
3838
vue-m-ui/package-lock.json
39+
vue-m-ui/npmCommands.md

CHANGELOG.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
<!-- TODO: Create comparison links on vue-m versions -->
2+
## 0.3.0 (06-06-2023)
3+
4+
### Feature
5+
6+
#### `<m-btn></m-btn>`
7+
8+
- Added the ability to add custom colors on input with shades on `hover` and `click`
9+
- Added a set of custom sizes with the `size` string prop
10+
- Added a set of custom shapes with the `shape` string prop
11+
- Handle transparency with the `transparent` boolean prop
12+
- Ability to add `custom elements` inside the button or optionally through the `text` string prop
13+
- Added: `disabled` and `loading` with custom `loading-icon` with the `loading-circle` default icon
14+
15+
#### Added the `<m-input></m-input>` component 🎉
16+
17+
- Added the `id` prop at the input element or the `container-id` to select the whole element
18+
- Optionally add the component on top of the input with the `label` string prop that contains the text, with the optional `label-id` string prop
19+
- Placeholder...
20+
- Added an icon with the `icon` string property *limited to a small set of open source icons*
21+
- `type` string prop **Currently supports `text` and `email` inputs**
22+
- Added a set of custom colors for the input element with the `color` string prop with the optional support for custom `hex` and `rgb/a` colors
23+
- Added a set of custom colors for the text inside of the input element with the `text-color` string prop with the optional support for custom `hex` and `rgb/a` colors
24+
- Added a set of custom sizes with the `size` string prop
25+
- Added a set of custom shapes with the `shape` string prop
26+
- Handle **bold text** with the `bold` boolean prop
27+
- Added: `disabled` and `loading` with custom `loading-icon` with the `loading-circle` default icon
28+
- Added automatic email validation of input of `type="email"`
29+
- Added persistent validation bar on email inputs **This will change to fit other types as well**
30+
- Autofocus... :>
31+
32+
#### Added the `<m-switch></m-switch>` component 🎉
33+
34+
- Added a set of custom colors for the `switch` element with the `color` string prop with the optional support for custom `hex` and `rgb/a` colors
35+
- Added a set of custom sizes with the `size` string prop
36+
- Added the custom width with the `custom-width` string prop that accepts normal css size units
37+
- Added: `disabled` and `loading`
38+
39+
#### Other
40+
41+
- Added css minification with postcss cssnano plugin
42+
43+
### Changed
44+
45+
- Minor reorganizing of css with vars to better support color and style customization.
46+
47+
### Fixed
48+
49+
- Fixed some minor bugs on `<m-btn></m-btn>` that wasn't detecting the tab on custom colors
50+
51+
## 0.2.0 (01-06-2023)
52+
53+
### Feature
54+
55+
- Added the `<m-input></m-input>` and `<m-switch></m-switch>` Components with minor styling functionality that are still in development.
56+
57+
### Changed
58+
59+
- Minor reorganizing of the project structure for better scalability and maintainability.
60+
61+
## 0.1.1 (26-05-2023)
62+
63+
##### First of many! 🎉
64+
65+
### Feature
66+
0.1.1 brings us the `<m-btn></m-btn>` button element.
67+
68+
The docs for usage will be out in a jiffy (prolly next week - May 30ish or later...)

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
`0.1.1 is out! 🎉🥳`
44

5-
![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/prolazydev/vue-m?color=blue&include_prereleases&style=for-the-badge) ![npm](https://img.shields.io/npm/dt/@prolazydev/vue-m?color=orange&label=downs&style=for-the-badge) [![license](https://img.shields.io/github/license/prolazydev/vue-m.svg?style=for-the-badge)](https://github.com/prolazydev/vue-m/blob/main/LICENSE) [![code with hearth by NHN Cloud](https://img.shields.io/badge/%3C%2F%3E%20with%20%20cooless%20%F0%9F%98%8E%20by-prolazydev-00bf76.svg?style=for-the-badge)](https://github.com/nhn)
5+
![npm](https://img.shields.io/npm/v/@prolazydev/vue-m?color=blue&label=release&style=for-the-badge) ![npm](https://img.shields.io/npm/dt/@prolazydev/vue-m?color=orange&label=downs&style=for-the-badge) [![license](https://img.shields.io/github/license/prolazydev/vue-m.svg?style=for-the-badge)](https://github.com/prolazydev/vue-m/blob/main/LICENSE) [![npm](https://img.shields.io/badge/-changelog-orange?style=for-the-badge)](https://github.com/prolazydev/vue-m/blob/main/CHANGELOG.md) [![code with hearth by NHN Cloud](https://img.shields.io/badge/%3C%2F%3E%20with%20%20cooless%20%F0%9F%98%8E%20by-prolazydev-00bf76.svg?style=for-the-badge)](https://github.com/nhn)
66

77
## Introduction
88

vue-m-ui/README.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# vue-m ⚒ WORK IN PROGRESS
2+
3+
[![npm](https://img.shields.io/npm/v/@prolazydev/vue-m?color=blue&label=release&style=for-the-badge)](https://github.com/prolazydev/vue-m) ![npm](https://img.shields.io/npm/dt/@prolazydev/vue-m?color=orange&label=downs&style=for-the-badge) [![license](https://img.shields.io/github/license/prolazydev/vue-m.svg?style=for-the-badge)](https://github.com/prolazydev/vue-m/blob/main/LICENSE) [![code with hearth by NHN Cloud](https://img.shields.io/badge/%3C%2F%3E%20with%20%20cooless%20%F0%9F%98%8E%20by-prolazydev-00bf76.svg?style=for-the-badge)](https://github.com/prolazydev)
4+
5+
## Introduction
6+
7+
`vue-m` is a Vue 3 UI component library designed to enhance the user interface of your Vue applications. It provides a collection of modern and responsive UI components that are easy to install and use.
8+
9+
## Features
10+
11+
- Modern and responsive UI components
12+
- Easy installation and usage
13+
- Built with Vue 3 and TypeScript
14+
- Highly customizable and flexible
15+
16+
## Installation
17+
18+
You can install the `vue-m` package using npm or Yarn:
19+
20+
```bash
21+
npm install vue-m
22+
```
23+
24+
or
25+
26+
```bash
27+
yarn add vue-m
28+
```
29+
30+
## Usage
31+
32+
To use the components from vue-m, register them in `main.ts`:
33+
34+
```ts
35+
import { createApp } from 'vue';
36+
import vueM from 'vue-m'; // Import the components
37+
import 'vue-m/dist/vue-m.css'; // Import the styling (Optional)
38+
import App from './App.vue';
39+
40+
createApp(App)
41+
.use(vueM)
42+
.mount('#app');
43+
```
44+
45+
Then use the components like this:
46+
47+
```vue
48+
<template>
49+
<div>
50+
<m-btn text="Write here" color='success' /> <!-- color is 'primary by default' -->
51+
<!-- or -->
52+
<m-btn>
53+
<div>
54+
Custom element inside the button
55+
</div>
56+
</m-btn>
57+
</div>
58+
</template>
59+
```
60+
61+
## TODO
62+
63+
- Create the todos :> `Doing`
64+
65+
<!--- Alert
66+
- Avatar
67+
- Breadcrumb
68+
- Button
69+
- Card
70+
- Checkbox
71+
- Chip
72+
- Collapse
73+
- Dialogs
74+
- Divider
75+
- Dropdown
76+
- Images
77+
- Input
78+
- List
79+
- Loading
80+
- Navbar
81+
- Notification
82+
- Number Input
83+
- Pagination
84+
- Popup
85+
- Progress
86+
- Radio
87+
- Select
88+
- Sidebar
89+
- Slider
90+
- Switch
91+
- Table
92+
- Tabs
93+
- Textarea
94+
- Tooltip
95+
- Upload -->

0 commit comments

Comments
 (0)