https://github.com/stevie-mayhew/moe-standard-footer

This repository contains all the source code for the standard Ministry of Education footer to avoid the need to rebuild the same markup and functionality between Silverstripe sites.
https://github.com/stevie-mayhew/moe-standard-footer

Last synced: about 2 months ago
JSON representation

This repository contains all the source code for the standard Ministry of Education footer to avoid the need to rebuild the same markup and functionality between Silverstripe sites.

• Host: GitHub
• URL: https://github.com/stevie-mayhew/moe-standard-footer
• Owner: stevie-mayhew
• Created: 2021-04-22T02:38:59.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-04-26T19:02:46.000Z (almost 4 years ago)
• Last Synced: 2024-10-26T02:33:50.179Z (3 months ago)
• Homepage:
• Size: 236 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Ministry of Education Standard Footer.

This repository contains all the source code for the standard Ministry of

Education footer to avoid the need to rebuild the same markup and functionality

between all the sites.

Authors can remove logos and update all the copy on the text.

![demo](client/img/demo.png)

## Usage

In your template use the include as follows

```

<% include Education\Standards\Footer %>

```

Your SCSS will also need to include the styles

```

@import "../../../vendor/education-nz/moe-standard-footer/client/scss/footer.scss";

```

> :warning: ** In your SCSS make sure to include the root design system before `header.scss`

In your theme SCSS:

```css

@import "../../../vendor/education-nz/moe-design-system/client/scss/moe.scss";

@import "../../../vendor/education-nz/moe-standard-footer/client/scss/footer.scss";

```

For customising any variables, define it prior to those imports.

```css

$color-footer-background: #f00;

...

@import "../../../vendor/education-nz/moe-design-system/client/scss/moe.scss";

@import "../../../vendor/education-nz/moe-standard-footer/client/scss/footer.scss";

```

Then you'll be good to go. You can customize any of the colours, logos as

needed.

## Configuration

The footer has several parts to be created and managed in the CMS as per the

image above.

 - Upper Social Links (top left)

 - Upper Links (featured buttons top right)

 - Lower Links

 - Social Media Icons

If you want, you can opt for a compressed version (i.e disabling the top links)

by using the following configuration options:

```

Education\StandardFooter\Extensions\FooterSiteConfig:

  top_links_enabled: false

  banner_enabled: true

  social_media_enabled: false

```