Normes du code SCSS – Freddie Mac

Utiliser seulement minusculeet séparez les termes dans les noms de classe par tirets, pas de soulignement. Nommez les classes à usage unique en utilisant le schéma de nommage SMACSS : conteneur-élément-modificateur.

 // Good
.grid-block {}
.grid-block-title {}

// Not this
.CustomButton {}
.menu_bar {}

Évitez d’utiliser des #ids dans les sélecteurs. Tenez-vous en aux cours.

 // Good
.primary-nav {}

// Not This
#primary-nav {}

Nommez les classes polyvalentes ou modificatrices sans désignation de bloc ou d’élément.

.uppercase {}
.weight-black {}
.vertical-baseline {}

Écrire pour la lisibilité – utilisez des sauts de ligne entre les déclarations et les sélecteurs et utilisez 2 espaces pour chaque niveau d’indentation. Le compilateur condensera les espaces et supprimera les retours de ligne dans le css minifié.

 figure {
  margin: 0;
  img {
    width: 100%;
    &:hover,
    &:focus {
      opacity: 0.9;
    }
  }
}

Lorsque vous stylisez des sous-éléments d’un composant, préférez écrire une nouvelle classe plutôt qu’utiliser un sélecteur de balises lorsque c’est possible. Cela réduit la spécificité du sélecteur, ce qui permet à l’utilisateur de remplacer plus facilement les styles par défaut. Cela réduit également le risque que les styles de balises ne s’infiltrent dans d’autres éléments.

 // Okay, and occasionally necessary to override Foundation's defaults
.menu-bar > li {}

// Better
.menu-bar-item {}

Gardez les sélecteurs peu profonds

Dans la mesure du possible, évitez d’imbriquer un sélecteur dans son parent. Le but de l’imbrication est de créer une portée, mais en incluant le nom de la classe parent dans la classe enfant, vous l’avez déjà effectivement délimitée.

 // Avoid Whenever Possible
.menu-bar {
  .menu-bar-item {}
}
.menu-bar .menu-bar-item {}

// Better
.menu-bar {}
.menu-bar-item {}

 // Do Not Deeply Nest
div.header nav ul li a {
  color: #666;
}

Lorsque vous stylisez une balise, envisagez d’utiliser le sélecteur enfant pour éviter les conflits, surtout pour les composants structurels qui pourraient inclure n’importe quel code HTML à l’intérieur.

 // Problematic, because now *every* <li> inside tabs will be styled this way
.tabs li {}
// Better, because you've restricted the reach of the selector
.tabs > li {}
// Even better, because you've reduced specificity
.tabs-item {}

Pour les noms de classe vraiment génériques (tels que .large ou .small), ou des noms de classe utilisés dans plusieurs composants, enchaînez-les à la classe principale. Foundation réutilise souvent les mêmes noms de classe pour différents composants, de sorte que chaque instance doit être isolée des autres. Il est également possible que d’autres bibliothèques ou styles entrent en conflit avec un mot générique.

 // Good
.button.primary {}
.callout.large {}

// Not this
.large {}
.primary {}

Éviter la concaténation inutile

Éviter de sans signification concaténation et écriture pour la trouvabilité. Gardez à l’esprit que d’autres développeurs partageront les mêmes fichiers SCSS.

 // Good -- clear without needing concatenation
.image-portrait {}
.image-square {}

// Meaningless Concatenation
// If another developer searched all scss files for class names that started with "image-", they’d fail to find these styles.
  .image {
    &-portrait {}
    &-square {}
  }

Utilisation significative concaténation lors de la génération de noms de classe basés sur une carte de valeurs (points d’arrêt, tailles, palettes) pour

• accélérer le développement
• assurer une dénomination cohérente
• Assurez-vous que les modifications apportées à une carte (telles que l’ajout d’un nouveau point d’arrêt, d’une nouvelle taille ou d’une nouvelle couleur de palette) sont immédiatement disponibles dans les noms de classe.

 // Meaningful Concatenation
// this code uses interpolation to create a class for each color in $orbit-palette.
  @each $name, $color in   $orbit-palette {
    $current-contrast: color-contrast($color, $white);
    .background-#{$name} {
      background-color: $color;
      @if ($current-contrast > 1.6) {
        color: $white;
      }
    }
  }

Commentez fortement !

Utilisez les commentaires pour documenter les mixins, les fonctions, les variables, les espaces réservés, nombres magiqueset les modifications apportées aux valeurs par défaut de la Fondation.

 // This single-line comment won't be included in the generated CSS.

/* In fact, even this multiline comment won't be
included in the generated CSS. */

span /* Multi-line comments can be written anywhere
    * whitespace is allowed. */ .sans {
  font: Helvetica, sans-serif;  // So can single-line commments.
}

Requêtes multimédias

Utilisez des requêtes multimédias à l’intérieur du sélecteur chaque fois que possible.

 // Good
.container {
  background-color: $white;
  color: $black;
  @include breakpoint(small) {
    max-width: 100%;
  }
  @include breakpoint(large) {
    max-width: 50%;
    float: left;
  }
}

// Not this.
.container {
  background-color: $white;
  color: $black;
}
@include breakpoint(small) {
  .container {
    max-width: 100%;
  }
}
@include breakpoint(large) {
  .container {
    max-width: 50%;
    float: left;
  }
}

Classes dynamiques modifiées par JavaScript

Les classes dynamiques modifiées par JavaScript doivent être précédées du mot .is-. Cela les distingue en tant que type spécial de classe CSS et garantit également que l’UnCSS ne les supprime pas.

Certaines classes dynamiques modifient temporairement l’état d’un élément.

 // Basic tab pane
.tab-pane {
  display: none;
}

// Tab pane made visible
.tab-pane.is-active {
  display: block;
}

D’autres classes dynamiques appliquent la logique structurelle nécessaire au fonctionnement d’un plugin. Les plugins de menu en sont un bon exemple.

 // Applied to the top-level <ul> of a dropdown menu
.is-dropdown-menu {}

// Applied to nested <ul>s in a dropdown menu
.is-dropdown-submenu {}

// Applied to <li>s that house a nested <ul>
.is-dropdown-submenu-parent {}

Tailles de police et hauteurs de ligne

Utilisation rem-calc() pour les tailles de police et les rapports sans unité pour la hauteur de ligne.

Les compositions du studio de conception ont généralement des tailles et des hauteurs de ligne basées sur les pixels. En utilisant rem-calc(), vous pouvez conserver leur valeur px dans le SCSS tout en produisant des unités rem standard. Pour les rapports de hauteur de ligne, divisez la hauteur de ligne souhaitée par la taille de la police (telle que 52/43)

Certaines classes dynamiques modifient temporairement l’état d’un élément.

 // Good
h1 {
  font-size: rem-calc(43);
  line-height: 1.21;
}

// Not This
h1 {
  font-size: 43px;
  line-height: 52px;
}