Skip to content

Common footer component for Just Eat websites

License

Notifications You must be signed in to change notification settings

justeat/f-footer

Repository files navigation

f-footer – Fozzie Footer Component

npm version Build Status Dependency Status

This repo is being deprecated and is only used on sites that cannot currently render Vue components. We recommend switching to using the Vue.js version of this component as soon as possible.

Allows any project to install and use a variation of the Just Eat footer on their project.

Usage

  1. The easiest way to use fozzie modules in your Sass setup is to use Eyeglass.

If you are using the fozzie gulp build tasks, then Eyeglass is automatically setup ready to use. If not, you can use it in one of the following ways:

  1. Install the f-footer module using NPM or Yarn:

    yarn add @justeat/f-footer
  2. Then within your Sass files, you will need to import this module.

    @import 'f-footer';

You can then use the f-footer fozzie footer module styling.

Shared Footer HTML

The footer HTML can be imported into your project using Handlebars.

The templates themselves are in the /footer folder in the /templates directory.

The data required to build the templates is in the /resources folder in the /templates directory, in the file footer.json. This contains all of the translations for the various tenants. The data is structured as an object, with each property in the object consisting of the data for one tenant.

When building the templates, the i18n Handlebars helper will use the data for the current tenant by iterating through the property items for the 'culture' that has been passed in via the model.

Testing

Footer links are integration tested, however must be manually run by the developer due to CORS issues with JSDOM and the Just Eat international websites.

To tests the links:

  1. Open the package.json and change testEnvironmentOptions.url to the page you want to test
  2. Open test/integration/footer-links.test.js
  3. Uncomment the tenant being tested and remove the skip method on test describe function
  4. Run jest in the terminal and fix any tests that fail

Note: At the time of writing some endpoints are unavailable within Just Eat's internal networks, i.e. they return 404s; in particular the pages run by Valtec. To test these pages you may have to tether your phone and run off your phone network connection