npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@geins/ralph-module-cms

v2.0.0

Published

Module for Geins CMS to handle custom created widgets

Downloads

205

Readme

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