Merge pull request #71 from Yoonit-Labs/feature/improving-descriptions

Improving descriptions and header files
Yoonit-Labs · Oct 5, 2021 · 5c9b42b · 5c9b42b
2 parents 11363db + e166f5d
commit 5c9b42b
Show file tree

Hide file tree

Showing 53 changed files with 859 additions and 54 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Yoonit
+Copyright (c) 2020 Yoonit Team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,21 +1,39 @@
-[<img src="https://raw.githubusercontent.com/Yoonit-Labs/nativescript-yoonit-camera/development/logo_cyberlabs.png" width="300">](https://cyberlabs.ai/)
+<h1 align="center">Sass Yoonit Style</h1>
 
-# Sass Yoonit Style
+<p align="center">
+	<img src="https://img.shields.io/npm/v/@yoonit/style?color=lightgrey&style=for-the-badge&logo=npm"/>
+	<img src="https://img.shields.io/npm/dm/@yoonit/style?color=lightgrey&logo=npm&style=for-the-badge"/>
+	<img src="https://img.shields.io/badge/SASS%20-hotpink.svg?color=lightgrey&logo=SASS&style=for-the-badge"/>
+	<img src="https://img.shields.io/npm/l/@yoonit/style?color=lightgrey&style=for-the-badge"/>
+</p>
 
-![Version](https://img.shields.io/npm/v/@yoonit/style?color=lightgrey&style=for-the-badge&logo=npm)
-![Downloads](https://img.shields.io/npm/dm/@yoonit/style?color=lightgrey&logo=npm&style=for-the-badge)
-![SASS](https://img.shields.io/badge/SASS%20-hotpink.svg?color=lightgrey&logo=SASS&style=for-the-badge)
-![MIT license](https://img.shields.io/npm/l/@yoonit/style?color=lightgrey&style=for-the-badge)
-
-A SASS lib to provide:
+A SASS lib to help you with:
 - Atomic Design System
 - Created using BEM methodology
-- Diverse variables and mixins to help you build your awesome layout
+- Diverse variables and mixins to improve your awesome layout
 - Responsive grid and flex system
 - Diverse theme range
 - Components styles
 - Possibility of creating themes
 
+<div align="center">
+	<h3>Sponsors</h3>
+	<table>
+		<tbody>
+			<tr>
+				<td>
+					<b>Platinum</b>
+				</td>
+			</tr>
+			<tr>
+				<td align="center" valign="middle">
+					<a href="https://cyberlabs.ai"><img src="https://raw.githubusercontent.com/Yoonit-Labs/sass-yoonit-style/development/sponsor_cyberlabs.png" width="300" /></a>
+				</td>
+			</tr>
+		</tbody>
+	</table>
+	<h5><a href="mailto:about@yoonit.dev">Become a sponsor!</a></h5>
+</div>
 
 ## Installation
 
@@ -195,13 +213,17 @@ Example:
 .p__r--xl //meaning: padding__right--extra-large
 ```
 
-
 ## To contribute and make it better
 
 Clone the repo, change what you want and send PR.
+For commit messages we use <a href="https://www.conventionalcommits.org/">Conventional Commits</a>.
 
 Contributions are always welcome!
 
----
+<a href="https://github.com/Yoonit-Labs/sass-yoonit-style/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=Yoonit-Labs/sass-yoonit-style" />
+</a>
+
+---  
 
-Code with ❤ by the [**Cyberlabs AI**](https://cyberlabs.ai/) Front-End Team
+Code with ❤ by the [**Yoonit**](https://yoonit.dev/) Team
diff --git a/gulpfile.js b/gulpfile.js
@@ -1,3 +1,19 @@
+/**
+ * ██╗   ██╗ ██████╗  ██████╗ ███╗   ██╗██╗████████╗
+ * ╚██╗ ██╔╝██╔═══██╗██╔═══██╗████╗  ██║██║╚══██╔══╝
+ *  ╚████╔╝ ██║   ██║██║   ██║██╔██╗ ██║██║   ██║
+ *   ╚██╔╝  ██║   ██║██║   ██║██║╚██╗██║██║   ██║
+ *    ██║   ╚██████╔╝╚██████╔╝██║ ╚████║██║   ██║
+ *    ╚═╝    ╚═════╝  ╚═════╝ ╚═╝  ╚═══╝╚═╝   ╚═╝
+ *
+ * https://yoonit.dev - about@yoonit.dev
+ *
+ * Sass Yoonit Style
+ * The SASS Atomic Design System that powers Web & Native Yoonit Components
+ *
+ * Luigui Delyer, Vitória Costa, Sabrina Sampaio, Gabriel Moraes, Tiago Brito, Fernando Junior, Ronalson Filho, Gabriel Moraes, Gabriel Mule & Gabriel Rizzo @ 2020-2021
+ */
+
 const {
   src,
   dest,

diff --git a/package.json b/package.json
@@ -26,8 +26,8 @@
     "Atomic Design"
   ],
   "author": {
-    "name": "Luigui Delyer, Vitória Costa, Sabrina Sampaio, Gabriel Moraes, Tiago Brito, Fernando Junior, Ronalson Filho, Gabriel Mule & Gabriel Rizzo @ Cyberlabs AI - 2021",
-    "email": "contato@cyberlabs.ai"
+    "name": "Luigui Delyer, Vitória Costa, Sabrina Sampaio, Gabriel Moraes, Tiago Brito, Fernando Junior, Ronalson Filho, Gabriel Moraes, Gabriel Mule & Gabriel Rizzo @ 2020-2021",
+    "email": "about@yoonit.dev"
   },
   "license": "MIT",
   "devDependencies": {

diff --git a/sponsor_cyberlabs.png b/sponsor_cyberlabs.png
diff --git a/src/atoms/YooAnimation.sass b/src/atoms/YooAnimation.sass
@@ -1,3 +1,19 @@
+/**
+ * ██╗   ██╗ ██████╗  ██████╗ ███╗   ██╗██╗████████╗
+ * ╚██╗ ██╔╝██╔═══██╗██╔═══██╗████╗  ██║██║╚══██╔══╝
+ *  ╚████╔╝ ██║   ██║██║   ██║██╔██╗ ██║██║   ██║
+ *   ╚██╔╝  ██║   ██║██║   ██║██║╚██╗██║██║   ██║
+ *    ██║   ╚██████╔╝╚██████╔╝██║ ╚████║██║   ██║
+ *    ╚═╝    ╚═════╝  ╚═════╝ ╚═╝  ╚═══╝╚═╝   ╚═╝
+ *
+ * https://yoonit.dev - about@yoonit.dev
+ *
+ * Sass Yoonit Style
+ * The SASS Atomic Design System that powers Web & Native Yoonit Components
+ *
+ * Luigui Delyer, Vitória Costa, Sabrina Sampaio, Gabriel Moraes, Tiago Brito, Fernando Junior, Ronalson Filho, Gabriel Moraes, Gabriel Mule & Gabriel Rizzo @ 2020-2021
+ */
+
 /*===== Animation Size ====*/
 $animation-width: 100% !default
 $animation-height: 100vh !default
@@ -9,4 +25,4 @@ $animation-z-index: 999 !default
   width: $animation-width
   height: $animation-height
   +flex(row, wrap, center, center)
-  z-index: $animation-z-index
+  z-index: $animation-z-index
diff --git a/src/atoms/YooAvatar.sass b/src/atoms/YooAvatar.sass
@@ -1,3 +1,19 @@
+/**
+ * ██╗   ██╗ ██████╗  ██████╗ ███╗   ██╗██╗████████╗
+ * ╚██╗ ██╔╝██╔═══██╗██╔═══██╗████╗  ██║██║╚══██╔══╝
+ *  ╚████╔╝ ██║   ██║██║   ██║██╔██╗ ██║██║   ██║
+ *   ╚██╔╝  ██║   ██║██║   ██║██║╚██╗██║██║   ██║
+ *    ██║   ╚██████╔╝╚██████╔╝██║ ╚████║██║   ██║
+ *    ╚═╝    ╚═════╝  ╚═════╝ ╚═╝  ╚═══╝╚═╝   ╚═╝
+ *
+ * https://yoonit.dev - about@yoonit.dev
+ *
+ * Sass Yoonit Style
+ * The SASS Atomic Design System that powers Web & Native Yoonit Components
+ *
+ * Luigui Delyer, Vitória Costa, Sabrina Sampaio, Gabriel Moraes, Tiago Brito, Fernando Junior, Ronalson Filho, Gabriel Moraes, Gabriel Mule & Gabriel Rizzo @ 2020-2021
+ */
+
 /*===== Avatar Sizing ====*/
 $avatar-size-sm: 2.5rem !default
 $avatar-size-md: 3.5rem !default
@@ -69,4 +85,4 @@ $avatar-border-radius: $border-radius-circular !default
     &--light
       color: var(--color-white)
     &--dark
-      color: var(--greyDark)
+      color: var(--greyDark)
diff --git a/src/atoms/YooButton.sass b/src/atoms/YooButton.sass
@@ -1,3 +1,19 @@
+/**
+ * ██╗   ██╗ ██████╗  ██████╗ ███╗   ██╗██╗████████╗
+ * ╚██╗ ██╔╝██╔═══██╗██╔═══██╗████╗  ██║██║╚══██╔══╝
+ *  ╚████╔╝ ██║   ██║██║   ██║██╔██╗ ██║██║   ██║
+ *   ╚██╔╝  ██║   ██║██║   ██║██║╚██╗██║██║   ██║
+ *    ██║   ╚██████╔╝╚██████╔╝██║ ╚████║██║   ██║
+ *    ╚═╝    ╚═════╝  ╚═════╝ ╚═╝  ╚═══╝╚═╝   ╚═╝
+ *
+ * https://yoonit.dev - about@yoonit.dev
+ *
+ * Sass Yoonit Style
+ * The SASS Atomic Design System that powers Web & Native Yoonit Components
+ *
+ * Luigui Delyer, Vitória Costa, Sabrina Sampaio, Gabriel Moraes, Tiago Brito, Fernando Junior, Ronalson Filho, Gabriel Moraes, Gabriel Mule & Gabriel Rizzo @ 2020-2021
+ */
+
 /*===== Button Spacing ====*/
 $btn-spacing-tn: $spacing-tn !default
 $btn-spacing-xs: $spacing-xs !default
@@ -44,7 +60,7 @@ $btn-container-button: 3.5rem !default
   +flex(row, '', center, center)
 
 .yoo-btn
-  $self: &  
+  $self: &
   font-family: var(--fontFamily-primary)
   font-weight: $weight-regular
   font-size: $btn-font-size-md
@@ -79,13 +95,13 @@ $btn-container-button: 3.5rem !default
 
     &--sm
       font-size: $btn-font-size-sm
-    
+
     &--md
       font-size: $btn-font-size-md
-    
+
     &--lg
       font-size: $btn-font-size-lg
-    
+
     &--xl
       font-size: $btn-font-size-xl
 
@@ -150,7 +166,7 @@ $btn-container-button: 3.5rem !default
     #{ $self }
       &__text, &__icon
         color: $buttonColor
-    &#{ $self}--hover:hover
+    &#{ $self }--hover:hover
       border: $btn-border-size $btn-border-style $buttonColor
       border-radius: $btn-border-radius
       background-color: $buttonColor
@@ -185,7 +201,7 @@ $btn-container-button: 3.5rem !default
       &__text, &__icon
         color: $buttonColor
 
-    &#{ $self}--hover:hover
+    &#{ $self }--hover:hover
       border-width: 0
       background-color: transparent
 

diff --git a/src/atoms/YooCheckButton.sass b/src/atoms/YooCheckButton.sass
@@ -1,3 +1,19 @@
+/**
+ * ██╗   ██╗ ██████╗  ██████╗ ███╗   ██╗██╗████████╗
+ * ╚██╗ ██╔╝██╔═══██╗██╔═══██╗████╗  ██║██║╚══██╔══╝
+ *  ╚████╔╝ ██║   ██║██║   ██║██╔██╗ ██║██║   ██║
+ *   ╚██╔╝  ██║   ██║██║   ██║██║╚██╗██║██║   ██║
+ *    ██║   ╚██████╔╝╚██████╔╝██║ ╚████║██║   ██║
+ *    ╚═╝    ╚═════╝  ╚═════╝ ╚═╝  ╚═══╝╚═╝   ╚═╝
+ *
+ * https://yoonit.dev - about@yoonit.dev
+ *
+ * Sass Yoonit Style
+ * The SASS Atomic Design System that powers Web & Native Yoonit Components
+ *
+ * Luigui Delyer, Vitória Costa, Sabrina Sampaio, Gabriel Moraes, Tiago Brito, Fernando Junior, Ronalson Filho, Gabriel Moraes, Gabriel Mule & Gabriel Rizzo @ 2020-2021
+ */
+
 /*===== CheckButton Size ====*/
 $checkButton-size-sm: 1rem !default
 $checkButton-size-md: 1.5rem !default

diff --git a/src/atoms/YooDropDown.sass b/src/atoms/YooDropDown.sass
@@ -1,3 +1,19 @@
+/**
+ * ██╗   ██╗ ██████╗  ██████╗ ███╗   ██╗██╗████████╗
+ * ╚██╗ ██╔╝██╔═══██╗██╔═══██╗████╗  ██║██║╚══██╔══╝
+ *  ╚████╔╝ ██║   ██║██║   ██║██╔██╗ ██║██║   ██║
+ *   ╚██╔╝  ██║   ██║██║   ██║██║╚██╗██║██║   ██║
+ *    ██║   ╚██████╔╝╚██████╔╝██║ ╚████║██║   ██║
+ *    ╚═╝    ╚═════╝  ╚═════╝ ╚═╝  ╚═══╝╚═╝   ╚═╝
+ *
+ * https://yoonit.dev - about@yoonit.dev
+ *
+ * Sass Yoonit Style
+ * The SASS Atomic Design System that powers Web & Native Yoonit Components
+ *
+ * Luigui Delyer, Vitória Costa, Sabrina Sampaio, Gabriel Moraes, Tiago Brito, Fernando Junior, Ronalson Filho, Gabriel Moraes, Gabriel Mule & Gabriel Rizzo @ 2020-2021
+ */
+
 /*===== Dropdown Font Sizing ====*/
 $dropdown-font-size-sm: $font-size-sm !default
 $dropdown-font-size-md: $font-size-md !default
@@ -31,7 +47,6 @@ $dropdown-text-transform: uppercase !default
   text-transform: $dropdown-text-transform
   +box-shadow('soft', #00000029)
   border-radius: $dropdown-border-radius
-  font-family: var(--fontFamily-primary)
   color: var(--greyBase)
   width: $dropdown-width
 

diff --git a/src/atoms/YooIcon.sass b/src/atoms/YooIcon.sass
@@ -1,3 +1,19 @@
+/**
+ * ██╗   ██╗ ██████╗  ██████╗ ███╗   ██╗██╗████████╗
+ * ╚██╗ ██╔╝██╔═══██╗██╔═══██╗████╗  ██║██║╚══██╔══╝
+ *  ╚████╔╝ ██║   ██║██║   ██║██╔██╗ ██║██║   ██║
+ *   ╚██╔╝  ██║   ██║██║   ██║██║╚██╗██║██║   ██║
+ *    ██║   ╚██████╔╝╚██████╔╝██║ ╚████║██║   ██║
+ *    ╚═╝    ╚═════╝  ╚═════╝ ╚═╝  ╚═══╝╚═╝   ╚═╝
+ *
+ * https://yoonit.dev - about@yoonit.dev
+ *
+ * Sass Yoonit Style
+ * The SASS Atomic Design System that powers Web & Native Yoonit Components
+ *
+ * Luigui Delyer, Vitória Costa, Sabrina Sampaio, Gabriel Moraes, Tiago Brito, Fernando Junior, Ronalson Filho, Gabriel Moraes, Gabriel Mule & Gabriel Rizzo @ 2020-2021
+ */
+
 /*===== Icon Font Sizing ====*/
 $icon-font-size-tn: $font-size-tn !default
 $icon-font-size-xs: $font-size-xs !default

diff --git a/src/atoms/YooSelectDate.sass b/src/atoms/YooSelectDate.sass
@@ -1,3 +1,19 @@
+/**
+ * ██╗   ██╗ ██████╗  ██████╗ ███╗   ██╗██╗████████╗
+ * ╚██╗ ██╔╝██╔═══██╗██╔═══██╗████╗  ██║██║╚══██╔══╝
+ *  ╚████╔╝ ██║   ██║██║   ██║██╔██╗ ██║██║   ██║
+ *   ╚██╔╝  ██║   ██║██║   ██║██║╚██╗██║██║   ██║
+ *    ██║   ╚██████╔╝╚██████╔╝██║ ╚████║██║   ██║
+ *    ╚═╝    ╚═════╝  ╚═════╝ ╚═╝  ╚═══╝╚═╝   ╚═╝
+ *
+ * https://yoonit.dev - about@yoonit.dev
+ *
+ * Sass Yoonit Style
+ * The SASS Atomic Design System that powers Web & Native Yoonit Components
+ *
+ * Luigui Delyer, Vitória Costa, Sabrina Sampaio, Gabriel Moraes, Tiago Brito, Fernando Junior, Ronalson Filho, Gabriel Moraes, Gabriel Mule & Gabriel Rizzo @ 2020-2021
+ */
+
 .yoo-selectdate
   &__separator
     +font(var(--greyDarkest), 'xl', '$font-primary', 'medium')
@@ -6,7 +22,7 @@
     position: relative
     overflow: hidden
     height: 9rem
-  
+
   &__item
     +font(var(--greyLight), 'xl', '$font-primary', 'medium')
     padding: $spacing-base 0
@@ -18,4 +34,4 @@
       color: var(--greyDarkest)
       border-top: $spacing-tn solid var(--greyBase)
       border-bottom: $spacing-tn solid var(--greyBase)
-      cursor: default
+      cursor: default
diff --git a/src/atoms/YooStepper.sass b/src/atoms/YooStepper.sass
@@ -1,3 +1,19 @@
+/**
+ * ██╗   ██╗ ██████╗  ██████╗ ███╗   ██╗██╗████████╗
+ * ╚██╗ ██╔╝██╔═══██╗██╔═══██╗████╗  ██║██║╚══██╔══╝
+ *  ╚████╔╝ ██║   ██║██║   ██║██╔██╗ ██║██║   ██║
+ *   ╚██╔╝  ██║   ██║██║   ██║██║╚██╗██║██║   ██║
+ *    ██║   ╚██████╔╝╚██████╔╝██║ ╚████║██║   ██║
+ *    ╚═╝    ╚═════╝  ╚═════╝ ╚═╝  ╚═══╝╚═╝   ╚═╝
+ *
+ * https://yoonit.dev - about@yoonit.dev
+ *
+ * Sass Yoonit Style
+ * The SASS Atomic Design System that powers Web & Native Yoonit Components
+ *
+ * Luigui Delyer, Vitória Costa, Sabrina Sampaio, Gabriel Moraes, Tiago Brito, Fernando Junior, Ronalson Filho, Gabriel Moraes, Gabriel Mule & Gabriel Rizzo @ 2020-2021
+ */
+
 /*==== Stepper Font Size ====*/
 $stepper-font-weight: $weight-regular !default
 $stepper-font-size: $font-size-md !default
@@ -31,4 +47,4 @@ $stepper-dot-active-height: .625rem !default
       width: $stepper-dot-active-width
       height: $stepper-dot-active-height
     &--last
-      margin-right: 0
+      margin-right: 0