@geins/ralph-module-cms

Geins CMS module for Ralph Storefront

This module is a helping tool to render your widgets, when you're using the Geins CMS to create custom widgets.

Pre-requisites

• Geins account and Geins PWA Ralph Storefront. Get a free trial here
• Geins Ralph UI 20.0.0 or higher

Module options

These extra options can be added to the module configuration in nuxt.config.js file.

Parameter	Default	Example
enabled	true	Enable/Disable the module

Components

The component this module includes is called GeinsCreatedWidgets and it's only job is to render the component specified in the JSON supplied to the widget.

Installation

1. Install the module

npm i @geins/ralph-module-cms

2. Add the module to your storefront

Add the module to your storefront by adding the following line to your nuxt.config.json file:

...
  modules: [
      ...
      '@geins/ralph-module-cms'
  ]

3. Specify to use the GeinsCreatedWidgets component instead of default

Set the widgetRenderTypesComponents config object in your nuxt.config.json file to use the GeinsCreatedWidgets component from this module to be used, instead of the default for the JSON widget type.

...
  publicRuntimeConfig: {
    ...
      widgetRenderTypesComponents: {
        JSON: 'GeinsCreatedWidgets'
      },
    ...
  }
...

4. Add the correct JSON format in your Geins Merchant Center

Use the Create widget function in your Geins Merchant Center. Add your configuration in the following JSON format for this module to work correctly:

{
  "component": "MyWidgetComponent",
  "configuration": {
    // Add your configuration here
  }
}

5. Create the widget components

Your custom widget component needs a configuration prop. This prop will hold the configuration from your JSON above. For example:

...
export default {
  name: 'MyWidgetComponent',
  props: {
    configuration: {
      type: Object,
      required: true
    }
  }
  ...
}
...