elevensbe/keplerstein-component-library

Reusable components for Keplerstein

Introduction

Reusable components used in the Keplerstein website projects.

The goal is that this repository is an npm installable library. Included in the default Craft CMS install, but can be updated anytime by a simple npm install.

Table of contents

• Reusable components for Keplerstein
  • Introduction
  • Table of contents
  • Installation
  • Base styles
  • Installation
  • Components
  • Utilities
  • Snippets
  • Icons
  • Coding guidelines

Installation

To add this library to a project, install it by the private Github URL

$ yarn add git+ssh://git@github.com:keplerstein/keplerstein-component-library.git

Make sure the domain github.com is added to the list of your well known hosts. Just run following command and answer yes to save it automatically:

More info

$ ssh github.com

Make sure your SSH key is added to Github, and Yarn knows about it. Run the following command:

$ ssh-add

Base styles

Every project starts with some base styles applied:

• normalize-scss
• reset
• breakpoints
• ...

More info

Installation

@import "keplerstein-component-library/scss/base";

Components

• Button
• Container
• Lists (ul>li)
• Card grid

Utilities

Various small mixins for common tasks. View Utilities.

Snippets

Various frequently used snippets in our templates. View snippets

Icons

• Products (Used in Commerce when adding to the navbar)
• Orders (Used in Commerce when adding to the navbar)

Coding guidelines

We try to use the BEM (Block Element Modifier) naming convention