Skip to content

Commit

Permalink
docs: ✏️ Updating package version and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ajomuch92 committed Dec 29, 2022
1 parent 6e101f4 commit d877c16
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,27 @@ export default {
| lBreakpoint | 1216 |
| mBreakpoint | 1024 |
| smBreakpoint | 768 |
| sizeType | xsm, sm, m, l or xl values (depending of the window size) |
| xsmBreakpoint | 375 |
| windowWidth | undefined (indicate the window width) |
| windowHeight | undefined (indicate the window height) |
| sizeType | xsm, sm, m, l, xl or xxl values (depending of the window size) |

You can change any of these values on created or mounted method to custom the watcher.

**Computed**
| Name | Description |
| ------------ | ------------ |
| isMobile | Compares screen width with smBreakpoint (as max-width smBreakpoint) |
| isTablet | Compares screen width with mBreakpoint and lBreakpoint (as min-width mBreakpoint or lBreakpoint) |
| isDesktop | Compares screen width with lBreakpoint and xlBreakpoint (as min-width lBreakpoint or xlBreakpoint) |
| isMobile | if sizeType is xsm or sm |
| isTablet | if sizeType is m |
| isDesktop | if sizeType is l, xl or xxl |

## Author
This library is created by [Aarón Montes](https://github.com/ajomuch92 "Aarón Montes").

## License
MIT


## Development

Want to contribute? Great!. Open a [new PR here](https://github.com/ajomuch92/vue-breakpoint-mixin/pulls) or a [new issue here](https://github.com/ajomuch92/vue-breakpoint-mixin/issues)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vue-breakpoint-mixin",
"version": "1.2.2",
"version": "1.3.0",
"description": "Package to use as a watcher for breakpoints",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit d877c16

Please sign in to comment.