ScandiPWA
Create Magento AppCreate ScandiPWA AppUser ManualGitHub
  • Why Scandi
  • πŸš€Quick-start Guide
  • πŸ—ΊοΈRoadmap
  • Introduction to the Stack
    • CMA, CSA, and ScandiPWA
    • Challenges
  • Setting up Scandi
    • Storefront Mode Setup
      • Proxying requests to server
    • Magento Mode Setup
    • Existing Magento 2 setup
    • Magento Commerce Cloud setup
    • Updating to new releases
      • Storefront mode upgrade
      • Magento mode upgrade
      • CMA upgrade
      • CSA upgrade
      • Custom ScandiPWA composer dependency update
      • Local ScandiPWA Composer Package Setup
    • Docker Setup [deprecated]
      • Legacy Docker setup
      • Migrating to CMA & CSA
  • Developing with Scandi
    • Override Mechanism
      • Overriding JavaScript
        • Overriding classes
        • Overriding non-classes
      • Overriding Styles
      • Overriding the HTML / PHP
      • Parent Themes
    • Extensions
      • Creating an extension
      • Installing an extension
      • Migrating from 3.x to 4.x
      • Publishing an extension
      • Extension Terminology
    • Working With Magento
      • Magento troubleshooting
      • Working with Magento modules
      • Working with GraphQL
      • GraphQL Security
      • Working with "granular cache"
    • Developer Tools
      • Debugging in VSCode
      • ScandiPWA CLI
      • Configuring ESLint
      • CSA Commands
    • Deploying Your App
      • Build & Deploy Android app
      • Build & Deploy iOS app
  • Structure
    • Directory Structure
    • Building Blocks
      • Components
        • Styling Components
      • Routes
      • Redux Stores
      • GraphQL Queries
      • Global Styles
      • The Util Directory
      • Type Checking
    • Application assets
    • Code Style
      • JavaScript Code Style
      • SCSS Code Style
  • Tutorials
    • Customizing Your Theme
      • Styling
        • Customizing the Global Styles
        • Adding a New Font
        • Overriding a Components Styles
        • Extending a Component's Styles
      • Customizing JavaScript
        • Customizing the Footer Copyright
        • Adding a New Page
        • Adding a Section in My Account
        • Adding a Tab on the Product Page
        • Creating a New Redux Store
    • Payment Method Integration
      • Setting Up for Development
      • Redirecting to the Payment Provider
      • Handling the Customer's Return
    • Creating a Custom Widget
      • Scandi CMS System Overview
      • Creating a Magento Widget
      • Implementing the Rendering
    • Video Tutorials
      • #1 Setting up and talking theory
      • #2 Templating in React
      • #3 Overriding a file
      • #4 Styling the application
      • #5 Patterns of ScandiPWA
    • Dark Mode Extension
    • Deploying Native Apps
    • Product 3D Model Extension
      • Part 1: Magento 3D Model Uploads
      • Part 2: GraphQL API
      • Part 3: Scandi Frontend
    • Social Share, Full Extension Development
      • STEP-1 and 2 Creating Magento 2 Module
      • STEP-3 Backend Configurations Settings
      • STEP-4 Simple GraphQl and Resolver
      • STEP-5 Creating Extension, Base Redux Store
      • STEP-6 Extension plugins
      • STEP-7 GraphQL types, Helpers
      • STEP-8 Query Field and FieldList
      • STEP-9 render Plugins and MSTP Plugin, Component creation
      • STEP-10 SocialShare Component Development
      • STEP-11 SocialShare for CategoryPage
      • TASK-1 Changing LinkedIn to Twitter
      • STEP-12 Comments for Admin Users
      • STEP-13 Final, bugfixes
    • Accessing Magento 2 Controllers
      • STEP-1 Creating Magento 2 Module
      • STEP-2 - Create Magento 2 Frontend Route and Basic Controller
      • STEP-3 Accessing Magento 2 Controller, Bypassing ScandiPWA frontend
      • STEP-4 Creating ScandiPWA Extension with additional dependencies
      • STEP-5 Creating Plugin and Axios request
  • About
    • Support
    • Release notes
    • Technical Information
    • Data Analytics
    • Contributing
      • Installation from Fork
      • Repository structure
      • Code contribution process
      • Submitting an Issue
      • Publishing ScandiPWA
Powered by GitBook
On this page
  • Modules
  • Plugins

Was this helpful?

  1. Developing with Scandi
  2. Extensions

Extension Terminology

A document defining and standardizing plugin-related terminology for consistency and clarity across documentation, tutorials and inter-developer communication.

PreviousMigrating from 3.x to 4.xNextWorking With Magento

Last updated 3 years ago

Was this helpful?

Modules

– a logical group – that is, a directory containing blocks, controllers, helpers, models – that are related to a specific business feature

GraphQL Module – a Magento Module that provides a interface, or improves an existing one. By convention, its name ends with the GraphQl suffix (examples: GtmGraphQl, PayPalGraphQl)

– a separate, reusable JavaScript package implementing some frontend features in Scandi. The module’s name should be in lower_snake_case, and may optionally be prefixed with a vendor such as @scandipwa/ (example: @scandipwa/paypal_payments). Often located under scandipwa/packages folder or in node_modules.

Plugins

Namespace – a string identifier associated with each item in the theme allowing it to be plugged into. These identifiers are formatted as paths, and may consist of (1) the name of the module, (2) the component name and file and (3) the name of the item. For example, a valid namespace might be Component/Image/Component. To assign a namespace to an item, prefix it with a comment: /** @namespace Component/Image/Component **/.

Extension Plugin File – a file plugging into a theme's functionality by wrapping around some of its functions, classes or their members. An extension can consist of multiple plugins, located in src/plugin. Plugin filenames must end with .plugin.js (example: ConfigQuery.plugin.js). Plugin Function – a function in an Extension Plugin that modifies the behavior of an item in the original theme by wrapping around it. The function, property or class that it plugs into is referred to as the target function, target property or target class, respectively.

Target Namespace – the namespace a plugin plugs into.

Plugin Configuration Object – the default export of a plugin file; an object specifying the namespaces the plugin targets, and configuring plugin functions for them.

Plugin Target Type – in the plugin configuration object, a string specifying the plugin type. For example, class methods can be plugged into with type member-function plugins. Class properties can be plugged into with type member-property plugins

Magento Module
GraphQL
Scandi Extension