2017 © Pedro Peláez
 

silverstripe-vendormodule silverstripe-simple-styleguide

Provides a kitchen sink template useful for theme development.

image

benmanu/silverstripe-simple-styleguide

Provides a kitchen sink template useful for theme development.

  • Monday, July 2, 2018
  • by benmanu
  • Repository
  • 0 Watchers
  • 9 Stars
  • 4,189 Installations
  • Scheme
  • 1 Dependents
  • 0 Suggesters
  • 6 Forks
  • 3 Open issues
  • 12 Versions
  • 30 % Grown

The README.md

Simple Styleguide Module

The Simple Styleguide enables site maintainers a single page to source the general site styles out of the box (typography, links, colours, form fields etc). Extensible through theme templates to build out a component library specific to the website., (*1)

Build Status codecov Scrutinizer Code Quality, (*2)

Overview

The module adds a new controller endpoint which can be viewed at the /_styleguide route, if logged in with admin permissions, or viewing from a dev environment. Also provides a kitchen sink template that can be used or overriden by your site theme to display frontend and typography components., (*3)

The SimpleStyleguideController class also includes a basic form (SimpleStyleguideController::TestForm()), and HTMLText output (SimpleStyleguideController::getContent()), for testing framework output., (*4)

Installation

Run on the command line:, (*5)

$ composer require benmanu/silverstripe-simple-styleguide

or include "benmanu/silverstripe-simple-styleguide": "^2.0" in your project composer.json and run:, (*6)

$ composer update

Use the 1.0 tag for SilverStripe 3 sites., (*7)

Usage

The styleguide template can be overriden by including a SimpleStyleguideController.ss file in your themes template/Layout/ directory., (*8)

The SimpleStyleguideController class can be overriden using SilverStripes extensions to either add new output functions, or modify the provided functions, by using the updateStyleguideData extension hook., (*9)

Styleguide Data

An extension hook is available to override/edit the rendered template data through updateStyleguideData., (*10)

Color Swatches

A simple color swatch template is available and can be overriden through the color_swatches config value., (*11)

BenManu\SimpleStyleguide\SimpleStyleguideController:
  color_swatches:
    - Name: "Black"
      Description: "This color is rather dark"
      CSSColor: "#000000"
      TextColor: "#ffffff"
    - Name: "Grey"
      Description: "This color is grey"
      CSSColor: "#666666"
      TextColor: "#000000"

Placeholder Images

The placeholder image url can be overriden through the placeholder_image_url config., (*12)

BenManu\SimpleStyleguide\SimpleStyleguideController:
  placeholder_image_url: "/simple-styleguide/images/placeholder.png"

The Versions

02/07 2018

dev-master

9999999-dev https://github.com/benmanu/silverstripe-simple-styleguide

Provides a kitchen sink template useful for theme development.

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by Ben Manu

silverstripe styleguide

02/07 2018

2.0.4

2.0.4.0 https://github.com/benmanu/silverstripe-simple-styleguide

Provides a kitchen sink template useful for theme development.

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by Ben Manu

silverstripe styleguide

04/03 2018

dev-features/a11y

dev-features/a11y https://github.com/benmanu/silverstripe-simple-styleguide

Provides a kitchen sink template useful for theme development.

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by Ben Manu

silverstripe styleguide

03/02 2018

2.0.3

2.0.3.0 https://github.com/benmanu/silverstripe-simple-styleguide

Provides a kitchen sink template useful for theme development.

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by Ben Manu

silverstripe styleguide

02/02 2018

2.0.2

2.0.2.0 https://github.com/benmanu/silverstripe-simple-styleguide

Provides a kitchen sink template useful for theme development.

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by Ben Manu

silverstripe styleguide

30/01 2018

2.0.1

2.0.1.0 https://github.com/benmanu/silverstripe-simple-styleguide

Provides a kitchen sink template useful for theme development.

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by Ben Manu

silverstripe styleguide

30/01 2018

2.0.0

2.0.0.0 https://github.com/benmanu/silverstripe-simple-styleguide

Provides a kitchen sink template useful for theme development.

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by Ben Manu

silverstripe styleguide

28/05 2017

1.1.2

1.1.2.0 https://github.com/benmanu/silverstripe-simple-styleguide

Provides a kitchen sink template useful for theme development.

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by Ben Manu

silverstripe styleguide

20/05 2017

1.1.1

1.1.1.0 https://github.com/benmanu/silverstripe-simple-styleguide

Provides a kitchen sink template useful for theme development.

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by Ben Manu

silverstripe styleguide

20/05 2017

dev-features/upgrade

dev-features/upgrade https://github.com/benmanu/silverstripe-simple-styleguide

Provides a kitchen sink template useful for theme development.

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by Ben Manu

silverstripe styleguide

20/05 2017

1.1.0

1.1.0.0 https://github.com/benmanu/silverstripe-simple-styleguide

Provides a kitchen sink template useful for theme development.

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by Ben Manu

silverstripe styleguide

18/05 2017

1.0.0

1.0.0.0 https://github.com/benmanu/silverstripe-simple-styleguide

Provides a kitchen sink template useful for theme development.

  Sources   Download

BSD-3-Clause

The Requires

 

by Ben Manu

silverstripe styleguide