react-responsive-tools 2.1.3 → 2.1.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-responsive-tools",
-  "version": "2.1.3",
+  "version": "2.1.5",
   "description": "",
   "main": "index.js",
   "module": "index.js",

package/src/scripts/generateSCSS.mjs

@@ -11,19 +11,35 @@ const __dirname = path.dirname(__filename);
 // Функция генерации SCSS содержимого для горизонтальных брейкпоинтов
 const generateHorizontalSCSS = (breakpoints) => {
   const beforeMixins = Object.keys(breakpoints).map(bp => `
-// ${bp} - ${breakpoints[bp]}
-@mixin for-${bp}(){
-  @include mob-first(${bp}){
+/**
+ * @mixin for-${bp}
+ * @description Mixin for applying styles for screens greater than or equal to ${breakpoints[bp]}px.
+ * @example
+ *  @include for-${bp} {
+ *    // your styles here
+ *  }
+ */
+@mixin for-${bp}() {
+  @include mob-first(${bp}) {
     @content;
   }
 }`).join('\n');
+
   const afterMixins = Object.keys(breakpoints).map(bp => `
-// ${bp} - ${breakpoints[bp]}
-@mixin before-${bp}(){
-  @include desk-first(${bp}){
+/**
+ * @mixin before-${bp}
+ * @description Mixin for applying styles for screens less than ${breakpoints[bp]}px.
+ * @example
+ *  @include before-${bp} {
+ *    // your styles here
+ *  }
+ */
+@mixin before-${bp}() {
+  @include desk-first(${bp}) {
     @content;
   }
 }`).join('\n');
+
   return `
 @import "horizontal";
 
@@ -36,19 +52,35 @@ ${afterMixins}
 // Функция генерации SCSS содержимого для вертикальных брейкпоинтов
 const generateVerticalSCSS = (breakpoints) => {
   const beforeMixins = Object.keys(breakpoints).map(bp => `
-// ${bp} - ${breakpoints[bp]}
-@mixin v-for-${bp}(){
-  @include v-mob-first(${bp}){
+/**
+ * @mixin v-for-${bp}
+ * @description Mixin for applying styles for screens with height greater than or equal to ${breakpoints[bp]}px.
+ * @example
+ *  @include v-for-${bp} {
+ *    // your styles here
+ *  }
+ */
+@mixin v-for-${bp}() {
+  @include v-mob-first(${bp}) {
     @content;
   }
 }`).join('\n');
+
   const afterMixins = Object.keys(breakpoints).map(bp => `
-// ${bp} - ${breakpoints[bp]}
-@mixin v-before-${bp}(){
-  @include v-desk-first(${bp}){
+/**
+ * @mixin v-before-${bp}
+ * @description Mixin for applying styles for screens with height less than ${breakpoints[bp]}px.
+ * @example
+ *  @include v-before-${bp} {
+ *    // your styles here
+ *  }
+ */
+@mixin v-before-${bp}() {
+  @include v-desk-first(${bp}) {
     @content;
   }
 }`).join('\n');
+
   return `
 @import "vertical";
 

package/src/scss/_horizontal-breakpoints.scss

@@ -2,143 +2,284 @@
 @import "horizontal";
 
 
-// xs - 320px
-@mixin for-xs(){
-  @include mob-first(xs){
+/**
+ * @mixin for-xs
+ * @description Mixin for applying styles for screens greater than or equal to 320pxpx.
+ * @example
+ *  @include for-xs {
+ *    // your styles here
+ *  }
+ */
+@mixin for-xs() {
+  @include mob-first(xs) {
     @content;
   }
 }
 
-// sm - 576px
-@mixin for-sm(){
-  @include mob-first(sm){
+
+/**
+ * @mixin for-sm
+ * @description Mixin for applying styles for screens greater than or equal to 576pxpx.
+ * @example
+ *  @include for-sm {
+ *    // your styles here
+ *  }
+ */
+@mixin for-sm() {
+  @include mob-first(sm) {
     @content;
   }
 }
 
-// md - 768px
-@mixin for-md(){
-  @include mob-first(md){
+/**
+ * @mixin for-md
+ * @description Mixin for applying styles for screens greater than or equal to 768pxpx.
+ * @example
+ *  @include for-md {
+ *    // your styles here
+ *  }
+ */
+@mixin for-md() {
+  @include mob-first(md) {
     @content;
   }
 }
 
-// lg - 992px
-@mixin for-lg(){
-  @include mob-first(lg){
+/**
+ * @mixin for-lg
+ * @description Mixin for applying styles for screens greater than or equal to 992pxpx.
+ * @example
+ *  @include for-lg {
+ *    // your styles here
+ *  }
+ */
+@mixin for-lg() {
+  @include mob-first(lg) {
     @content;
   }
 }
 
-// lt - 1024px
-@mixin for-lt(){
-  @include mob-first(lt){
+/**
+ * @mixin for-lt
+ * @description Mixin for applying styles for screens greater than or equal to 1024pxpx.
+ * @example
+ *  @include for-lt {
+ *    // your styles here
+ *  }
+ */
+@mixin for-lt() {
+  @include mob-first(lt) {
     @content;
   }
 }
 
-// ltm - 1200px
-@mixin for-ltm(){
-  @include mob-first(ltm){
+/**
+ * @mixin for-ltm
+ * @description Mixin for applying styles for screens greater than or equal to 1200pxpx.
+ * @example
+ *  @include for-ltm {
+ *    // your styles here
+ *  }
+ */
+@mixin for-ltm() {
+  @include mob-first(ltm) {
     @content;
   }
 }
 
-// ltl - 1440px
-@mixin for-ltl(){
-  @include mob-first(ltl){
+/**
+ * @mixin for-ltl
+ * @description Mixin for applying styles for screens greater than or equal to 1440pxpx.
+ * @example
+ *  @include for-ltl {
+ *    // your styles here
+ *  }
+ */
+@mixin for-ltl() {
+  @include mob-first(ltl) {
     @content;
   }
 }
 
-// xl - 1920px
-@mixin for-xl(){
-  @include mob-first(xl){
+/**
+ * @mixin for-xl
+ * @description Mixin for applying styles for screens greater than or equal to 1920pxpx.
+ * @example
+ *  @include for-xl {
+ *    // your styles here
+ *  }
+ */
+@mixin for-xl() {
+  @include mob-first(xl) {
     @content;
   }
 }
 
-// xxl - 2560px
-@mixin for-xxl(){
-  @include mob-first(xxl){
+/**
+ * @mixin for-xxl
+ * @description Mixin for applying styles for screens greater than or equal to 2560pxpx.
+ * @example
+ *  @include for-xxl {
+ *    // your styles here
+ *  }
+ */
+@mixin for-xxl() {
+  @include mob-first(xxl) {
     @content;
   }
 }
 
-// qxl - 3840px
-@mixin for-qxl(){
-  @include mob-first(qxl){
+/**
+ * @mixin for-qxl
+ * @description Mixin for applying styles for screens greater than or equal to 3840pxpx.
+ * @example
+ *  @include for-qxl {
+ *    // your styles here
+ *  }
+ */
+@mixin for-qxl() {
+  @include mob-first(qxl) {
     @content;
   }
 }
 
 
-// xs - 320px
-@mixin before-xs(){
-  @include desk-first(xs){
+/**
+ * @mixin before-xs
+ * @description Mixin for applying styles for screens less than 320pxpx.
+ * @example
+ *  @include before-xs {
+ *    // your styles here
+ *  }
+ */
+@mixin before-xs() {
+  @include desk-first(xs) {
     @content;
   }
 }
 
-// sm - 576px
-@mixin before-sm(){
-  @include desk-first(sm){
+/**
+ * @mixin before-sm
+ * @description Mixin for applying styles for screens less than 576pxpx.
+ * @example
+ *  @include before-sm {
+ *    // your styles here
+ *  }
+ */
+@mixin before-sm() {
+  @include desk-first(sm) {
     @content;
   }
 }
 
-// md - 768px
-@mixin before-md(){
-  @include desk-first(md){
+/**
+ * @mixin before-md
+ * @description Mixin for applying styles for screens less than 768pxpx.
+ * @example
+ *  @include before-md {
+ *    // your styles here
+ *  }
+ */
+@mixin before-md() {
+  @include desk-first(md) {
     @content;
   }
 }
 
-// lg - 992px
-@mixin before-lg(){
-  @include desk-first(lg){
+/**
+ * @mixin before-lg
+ * @description Mixin for applying styles for screens less than 992pxpx.
+ * @example
+ *  @include before-lg {
+ *    // your styles here
+ *  }
+ */
+@mixin before-lg() {
+  @include desk-first(lg) {
     @content;
   }
 }
 
-// lt - 1024px
-@mixin before-lt(){
-  @include desk-first(lt){
+/**
+ * @mixin before-lt
+ * @description Mixin for applying styles for screens less than 1024pxpx.
+ * @example
+ *  @include before-lt {
+ *    // your styles here
+ *  }
+ */
+@mixin before-lt() {
+  @include desk-first(lt) {
     @content;
   }
 }
 
-// ltm - 1200px
-@mixin before-ltm(){
-  @include desk-first(ltm){
+/**
+ * @mixin before-ltm
+ * @description Mixin for applying styles for screens less than 1200pxpx.
+ * @example
+ *  @include before-ltm {
+ *    // your styles here
+ *  }
+ */
+@mixin before-ltm() {
+  @include desk-first(ltm) {
     @content;
   }
 }
 
-// ltl - 1440px
-@mixin before-ltl(){
-  @include desk-first(ltl){
+/**
+ * @mixin before-ltl
+ * @description Mixin for applying styles for screens less than 1440pxpx.
+ * @example
+ *  @include before-ltl {
+ *    // your styles here
+ *  }
+ */
+@mixin before-ltl() {
+  @include desk-first(ltl) {
     @content;
   }
 }
 
-// xl - 1920px
-@mixin before-xl(){
-  @include desk-first(xl){
+/**
+ * @mixin before-xl
+ * @description Mixin for applying styles for screens less than 1920pxpx.
+ * @example
+ *  @include before-xl {
+ *    // your styles here
+ *  }
+ */
+@mixin before-xl() {
+  @include desk-first(xl) {
     @content;
   }
 }
 
-// xxl - 2560px
-@mixin before-xxl(){
-  @include desk-first(xxl){
+/**
+ * @mixin before-xxl
+ * @description Mixin for applying styles for screens less than 2560pxpx.
+ * @example
+ *  @include before-xxl {
+ *    // your styles here
+ *  }
+ */
+@mixin before-xxl() {
+  @include desk-first(xxl) {
     @content;
   }
 }
 
-// qxl - 3840px
-@mixin before-qxl(){
-  @include desk-first(qxl){
+/**
+ * @mixin before-qxl
+ * @description Mixin for applying styles for screens less than 3840pxpx.
+ * @example
+ *  @include before-qxl {
+ *    // your styles here
+ *  }
+ */
+@mixin before-qxl() {
+  @include desk-first(qxl) {
     @content;
   }
 }

package/src/scss/_vertical-breakpoints.scss

@@ -2,87 +2,171 @@
 @import "vertical";
 
 
-// xs - 600px
-@mixin v-for-xs(){
-  @include v-mob-first(xs){
+/**
+ * @mixin v-for-xs
+ * @description Mixin for applying styles for screens with height greater than or equal to 600pxpx.
+ * @example
+ *  @include v-for-xs {
+ *    // your styles here
+ *  }
+ */
+@mixin v-for-xs() {
+  @include v-mob-first(xs) {
     @content;
   }
 }
 
-// sm - 800px
-@mixin v-for-sm(){
-  @include v-mob-first(sm){
+/**
+ * @mixin v-for-sm
+ * @description Mixin for applying styles for screens with height greater than or equal to 800pxpx.
+ * @example
+ *  @include v-for-sm {
+ *    // your styles here
+ *  }
+ */
+@mixin v-for-sm() {
+  @include v-mob-first(sm) {
     @content;
   }
 }
 
-// md - 1000px
-@mixin v-for-md(){
-  @include v-mob-first(md){
+/**
+ * @mixin v-for-md
+ * @description Mixin for applying styles for screens with height greater than or equal to 1000pxpx.
+ * @example
+ *  @include v-for-md {
+ *    // your styles here
+ *  }
+ */
+@mixin v-for-md() {
+  @include v-mob-first(md) {
     @content;
   }
 }
 
-// lg - 1200px
-@mixin v-for-lg(){
-  @include v-mob-first(lg){
+/**
+ * @mixin v-for-lg
+ * @description Mixin for applying styles for screens with height greater than or equal to 1200pxpx.
+ * @example
+ *  @include v-for-lg {
+ *    // your styles here
+ *  }
+ */
+@mixin v-for-lg() {
+  @include v-mob-first(lg) {
     @content;
   }
 }
 
-// xl - 1600px
-@mixin v-for-xl(){
-  @include v-mob-first(xl){
+/**
+ * @mixin v-for-xl
+ * @description Mixin for applying styles for screens with height greater than or equal to 1600pxpx.
+ * @example
+ *  @include v-for-xl {
+ *    // your styles here
+ *  }
+ */
+@mixin v-for-xl() {
+  @include v-mob-first(xl) {
     @content;
   }
 }
 
-// xxl - 1601px
-@mixin v-for-xxl(){
-  @include v-mob-first(xxl){
+/**
+ * @mixin v-for-xxl
+ * @description Mixin for applying styles for screens with height greater than or equal to 1601pxpx.
+ * @example
+ *  @include v-for-xxl {
+ *    // your styles here
+ *  }
+ */
+@mixin v-for-xxl() {
+  @include v-mob-first(xxl) {
     @content;
   }
 }
 
 
-// xs - 600px
-@mixin v-before-xs(){
-  @include v-desk-first(xs){
+/**
+ * @mixin v-before-xs
+ * @description Mixin for applying styles for screens with height less than 600pxpx.
+ * @example
+ *  @include v-before-xs {
+ *    // your styles here
+ *  }
+ */
+@mixin v-before-xs() {
+  @include v-desk-first(xs) {
     @content;
   }
 }
 
-// sm - 800px
-@mixin v-before-sm(){
-  @include v-desk-first(sm){
+/**
+ * @mixin v-before-sm
+ * @description Mixin for applying styles for screens with height less than 800pxpx.
+ * @example
+ *  @include v-before-sm {
+ *    // your styles here
+ *  }
+ */
+@mixin v-before-sm() {
+  @include v-desk-first(sm) {
     @content;
   }
 }
 
-// md - 1000px
-@mixin v-before-md(){
-  @include v-desk-first(md){
+/**
+ * @mixin v-before-md
+ * @description Mixin for applying styles for screens with height less than 1000pxpx.
+ * @example
+ *  @include v-before-md {
+ *    // your styles here
+ *  }
+ */
+@mixin v-before-md() {
+  @include v-desk-first(md) {
     @content;
   }
 }
 
-// lg - 1200px
-@mixin v-before-lg(){
-  @include v-desk-first(lg){
+/**
+ * @mixin v-before-lg
+ * @description Mixin for applying styles for screens with height less than 1200pxpx.
+ * @example
+ *  @include v-before-lg {
+ *    // your styles here
+ *  }
+ */
+@mixin v-before-lg() {
+  @include v-desk-first(lg) {
     @content;
   }
 }
 
-// xl - 1600px
-@mixin v-before-xl(){
-  @include v-desk-first(xl){
+/**
+ * @mixin v-before-xl
+ * @description Mixin for applying styles for screens with height less than 1600pxpx.
+ * @example
+ *  @include v-before-xl {
+ *    // your styles here
+ *  }
+ */
+@mixin v-before-xl() {
+  @include v-desk-first(xl) {
     @content;
   }
 }
 
-// xxl - 1601px
-@mixin v-before-xxl(){
-  @include v-desk-first(xxl){
+/**
+ * @mixin v-before-xxl
+ * @description Mixin for applying styles for screens with height less than 1601pxpx.
+ * @example
+ *  @include v-before-xxl {
+ *    // your styles here
+ *  }
+ */
+@mixin v-before-xxl() {
+  @include v-desk-first(xxl) {
     @content;
   }
 }