Styleguide

Framework CSS Cabestan 0.1.0

Lien vers le projet sur Github

Lien vers la version actuelle (0.1.0) du CSS:

<link href="https://s3.eu-central-1.amazonaws.com/cabestan-styleguide-stg/0.1.0/assets/css/main.min.css" rel="stylesheet">

Versions


Changements de version:

  • 0.0.x : Bugfix
  • 0.x.0 : Ajout de composant
  • x.0.0 : Breaking change (par ex : Changement du DOM d'un composant existant)

  • Internet Explorer 10+
  • Edge
  • Firefox 28+
  • Chrome 21+
  • Safari 6.1+

Syntaxe SCSS

  • Indentation : 2 espaces
  • 80 caractères maximum par lignes
  • 1 déclaration par ligne

Organisation des fichiers SCSS

  • base/ : Normalisation et micro-reset des éléments de style
  • components/ : Composants de l’application (menu, header, footer, boutons…)
  • tools/ : Mixins et fonctions
  • utils/ : Classes utilitaires
  • documentation/ : Documention du styleguide
  • _styleguide.scss : Import de la documentation
  • _settings.scss : Variables SCSS
  • main.scss : Feuille de style principale

Convention de nommage CSS

// Composant
.myComponent {}

// Composant enfant
.myComponent-element {}

// Modificateur de composant
.myComponent--modifier {
    .myComponent-element {}
    .myComponent-otherElement {}
}

// État du composant
.myComponent.is-state {}

// Classe réservée au javascript
.js-myComponent {}