Code Monkey home page Code Monkey logo

ralph-module-cms-json-container's Introduction

NPM Package NPM Downloads Geins

Start Geins Free Trial Geins Docs

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

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
    }
  }
  ...
}
...

ralph-module-cms-json-container's People

Contributors

olivia-geins avatar arvidsson-geins avatar

Watchers

Kristian Arvidsson avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.