Skip to content

Instantly share code, notes, and snippets.

@ananth99
Last active May 26, 2021 14:24
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ananth99/fcc38a1fd2ddd41e38a07757d2a2ac0c to your computer and use it in GitHub Desktop.
Save ananth99/fcc38a1fd2ddd41e38a07757d2a2ac0c to your computer and use it in GitHub Desktop.

WYSIWYG Specs

Anatomy of a page

Header

The Header component is common across the locator, individual store pages and the locations by state pages. Usually copied from client’s website.

Footer

The Footer component should also be common across the locator, individual pages and locations by state pages. Usually copied from client’s website

Body

The Body of a page will vary based on the type of the page. The body is a horizontal stacking of various Entities. Users can add/remove entity components and re-order them as they see fit.

Entities

NameContent EditableLayout Editable
NAPNoYes
Store HoursNoYes
Special HoursNoYes
ReviewsNoYes
FAQsYesYes
PostsNoYes
HeaderNoNo
FooterNoNo
EventsNoYes

Types of Pages

Store Locator

The locator consists of the following Entity components:

  • Hero
  • Location List
  • Location Map
  • Search Input

Store Page

The Store page consists of the following Entity components:

  • Location Map
  • Hero
  • NAP
  • Hours
  • Special Hours
  • Reviews
  • Nearby Locations
  • FAQs
  • Events
  • Offers

Locations by States Page

Entity Components:

  • Location List

Tweakable Brand Design Parameters

  • Primary Colour
  • Secondary Colour
  • Font Family

WYSIWYG Editor Mechanics - WIP

The user usually starts off with either a “blank” canvas with a built-in header/footer or can start off editing the custom layout built by PSG.

When user starts off with blank canvas

User needs to select the list of “modules”/entities that they need on the page. Each module has a content/design/custom-css configuration that can be set. Upon selecting the module, the user can place the module wherever they see fit.

When user starts with custom layout

Since PSG does the custom layout, we will be adding any custom module they require as well in WYSIWYG. For ex: XYZ bank can request for Mortgage Lending Officers(MLOs) to be visible on their page. This module will be added to their editor and will be available for editing content and layout.

Images & workflow to be added soon…

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment