cwp/agency-extensions

Base module for the default CWP theme to add features

Installs: 22 170

Dependents: 3

Suggesters: 1

Stars: 6

Watchers: 14

Forks: 8

Open Issues: 6

Type:silverstripe-vendormodule


README

Build Status Scrutinizer Code Quality codecov SilverStripe supported module

This module provides some added configuration and underlying functionality that may be useful to allow clients/agencies to adjust website functionality theirselves, or to provide additional functionality that may not always be required for a CWP project. It provides the content management side of the functionality provided by the Watea theme (specifically the Carousel).

Summary of contents

This module provides the following (may not be a definitive list):

  • Theme colour picker. Allows CMS users to adjust the colours of different areas of their site without requiring developer intervention
  • Carousel/hero image for the home page
  • Customise search results labels from SiteConfig
  • Upload custom header and footer logos from SiteConfig
  • Upload custom favicon and Apple touch logos from SiteConfig
  • FontAwesome icon popup dialog to the TinyMCE content editor (Wātea theme only, by default)
  • Customisable theme colours in site settings

Installation

This module will automatically be installed along with either the "default" or Wātea CWP themes.

If you want to install this module on its own you can do so with Composer:

composer require cwp/agency-extensions

Requirements

  • cwp/cwp 2.0 or above

Note For use with CWP versions less than 2, please see the 1.x release line.

Documentation

Features

Versioning

This library follows Semver. According to Semver, you will be able to upgrade to any minor or patch version of this library without any breaking changes to the public API. Semver also requires that we clearly define the public API for this library.

All methods, with public visibility, are part of the public API. All other methods are not part of the public API. Where possible, we'll try to keep protected methods backwards-compatible in minor/patch versions, but if you're overriding methods then please test your work before upgrading.

Notes

This library includes a version of the TinyMCE-FontAwesome-Plugin by Josh18 which is open and permissive via the expat/MIT Licence.