ScandiPWA

https://docs.scandipwa.com
Admin
A next-generation Magento 2 front-end written in React with improved performance, Progressive Web...
Tokens:109,365
Snippets:1,386
Trust Score:8.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Querying Documentation

Source: https://docs.scandipwa.com/about/contributing/installation-from-fork

Example of how to perform an HTTP GET request to ask a question about the documentation.

```http
GET https://docs.scandipwa.com/about/contributing/installation-from-fork.md?ask=<question>
```

--------------------------------

### HTTP GET Request Example

Source: https://docs.scandipwa.com/developing-with-scandi/extensions/installing-an-extension

Example of performing an HTTP GET request to query the documentation dynamically.

```http
GET https://docs.scandipwa.com/developing-with-scandi/extensions/installing-an-extension.md?ask=<question>
```

--------------------------------

### Running Storefront Mode

Source: https://docs.scandipwa.com/about/contributing/installation-from-fork

Navigates into the ScandiPWA package directory and starts the application in storefront mode.

```bash
cd packages/scandipwa # move into the scandipwa package directory
yarn start
```

--------------------------------

### Querying Documentation

Source: https://docs.scandipwa.com/quick-start-guide

Perform an HTTP GET request on the current page URL with the `ask` query parameter to get additional information not directly available on the page.

```http
GET https://docs.scandipwa.com/quick-start-guide.md?ask=<question>
```

--------------------------------

### Example GET request for dynamic documentation querying

Source: https://docs.scandipwa.com/developing-with-scandi/deploying-your-app/build-and-deploy-android-app

Example of how to perform an HTTP GET request to query the documentation dynamically using the 'ask' query parameter.

```http
GET https://docs.scandipwa.com/developing-with-scandi/deploying-your-app/build-and-deploy-android-app.md?ask=<question>
```

--------------------------------

### Create a new ScandiPWA app

Source: https://docs.scandipwa.com/quick-start-guide

Initializes a new ScandiPWA application named 'my-first-app' and installs dependencies.

```bash
npm init scandipwa-app my-first-app
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/tutorials/payment-method-integration/redirecting-to-the-payment-provider

This example shows how to perform an HTTP GET request to a documentation page with an 'ask' query parameter to get dynamic information.

```http
GET https://docs.scandipwa.com/tutorials/payment-method-integration/redirecting-to-the-payment-provider.md?ask=<question>
```

--------------------------------

### Querying Documentation

Source: https://docs.scandipwa.com/developing-with-scandi/deploying-your-app

This example shows how to query the documentation dynamically by performing an HTTP GET request with the 'ask' query parameter.

```http
GET https://docs.scandipwa.com/developing-with-scandi/deploying-your-app.md?ask=<question>
```

--------------------------------

### Run the ScandiPWA app

Source: https://docs.scandipwa.com/quick-start-guide

Starts the ScandiPWA application in development mode and opens it in the browser.

```bash
cd my-first-app/
npm start
```

--------------------------------

### Querying Documentation Example

Source: https://docs.scandipwa.com/structure/building-blocks-summary/routes

This example shows how to query the documentation dynamically by performing an HTTP GET request with an 'ask' query parameter.

```http
GET https://docs.scandipwa.com/structure/building-blocks-summary/routes.md?ask=<question>
```

--------------------------------

### Querying documentation dynamically

Source: https://docs.scandipwa.com/developing-with-scandi/extensions/migrating-from-3.x-to-4.x

Example of how to make an HTTP GET request to query the documentation with an 'ask' parameter.

```http
GET https://docs.scandipwa.com/developing-with-scandi/extensions/migrating-from-3.x-to-4.x.md?ask=<question>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.scandipwa.com/developing-with-scandi/working-with-magento/working-with-magento-modules

Example of an HTTP GET request to query the documentation dynamically.

```http
GET https://docs.scandipwa.com/developing-with-scandi/working-with-magento/working-with-magento-modules.md?ask=<question>
```

--------------------------------

### Agent Instructions: Querying This Documentation

Source: https://docs.scandipwa.com/structure/folder-structure

Example of how to query the documentation dynamically using an HTTP GET request with the 'ask' query parameter.

```http
GET https://docs.scandipwa.com/structure/folder-structure.md?ask=<question>
```

--------------------------------

### Example: Cloning and running the tool

Source: https://docs.scandipwa.com/developing-with-scandi/extensions/migrating-from-3.x-to-4.x

An example demonstrating how to clone the tool and use it to migrate an extension.

```bash
git clone git@github.com:scandipwa/split-legacy-extension.git ~/split-legacy-extension
node ~/split-legacy-extension/index.js ~/Downloads/my-extension ~/Downloads/my-extension-v4
```

--------------------------------

### Querying Documentation

Source: https://docs.scandipwa.com/structure/adding-assets

Example of how to query the documentation dynamically using an HTTP GET request with the 'ask' query parameter.

```http
GET https://docs.scandipwa.com/structure/adding-assets.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/introduction/challenges

An example of how to query the documentation dynamically using an HTTP GET request with the 'ask' query parameter.

```HTTP
GET https://docs.scandipwa.com/introduction/challenges.md?ask=<question>
```

--------------------------------

### Dynamic Documentation Query

Source: https://docs.scandipwa.com/tutorials/scandipwa-social-share/step-3-backend-configurations-settings

Example of how to perform an HTTP GET request to query the documentation dynamically with the `ask` query parameter.

```HTTP
GET https://docs.scandipwa.com/tutorials/scandipwa-social-share/step-3-backend-configurations-settings.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/tutorials/customizing-your-theme

An example of how to perform an HTTP GET request to query the documentation dynamically using the `ask` query parameter.

```http
GET https://docs.scandipwa.com/tutorials/customizing-your-theme.md?ask=<question>
```

--------------------------------

### Prerequisites Check

Source: https://docs.scandipwa.com/about/contributing/installation-from-fork

Commands to check for Git, Node.js, and Yarn installation and versions.

```bash
git --version
node -v # expected: v12.x or v14.x
yarn -v
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.scandipwa.com/tutorials/creating-a-custom-widget/implementing-the-rendering

Demonstrates how to perform an HTTP GET request to a documentation page with the 'ask' query parameter to get specific information.

```http
GET https://docs.scandipwa.com/tutorials/creating-a-custom-widget/implementing-the-rendering.md?ask=<question>
```

--------------------------------

### Agent Instructions: Querying This Documentation

Source: https://docs.scandipwa.com/tutorials/video-tutorials/templating-in-react

Example of how to query documentation dynamically using an HTTP GET request with the 'ask' query parameter.

```http
GET https://docs.scandipwa.com/tutorials/video-tutorials/templating-in-react.md?ask=<question>
```

--------------------------------

### Example GET Request for Documentation Query

Source: https://docs.scandipwa.com/tutorials/scandipwa-social-share/task-1-changing-linkedin-to-twitter

Demonstrates how to query the documentation dynamically by appending an 'ask' parameter to the URL with a natural language question.

```http
GET https://docs.scandipwa.com/tutorials/scandipwa-social-share/task-1-changing-linkedin-to-twitter.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/developing-with-scandi/working-with-magento

Example of how to perform an HTTP GET request to query the documentation dynamically with the 'ask' query parameter.

```HTTP
GET https://docs.scandipwa.com/developing-with-magento.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/tutorials/creating-a-custom-widget

An example of how to query the documentation dynamically using an HTTP GET request with the `ask` query parameter.

```http
GET https://docs.scandipwa.com/tutorials/creating-a-custom-widget.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/structure

Example of how to query the documentation dynamically using an HTTP GET request with the 'ask' query parameter.

```HTTP
GET https://docs.scandipwa.com/structure.md?ask=<question>
```

--------------------------------

### Querying Documentation

Source: https://docs.scandipwa.com/tutorials/customizing-your-theme/styling/customizing-the-global-styles

Example of how to query the documentation dynamically using an HTTP GET request with an 'ask' query parameter.

```http
GET https://docs.scandipwa.com/tutorials/customizing-your-theme/styling/customizing-the-global-styles.md?ask=<question>
```

--------------------------------

### Installing Dependencies

Source: https://docs.scandipwa.com/about/contributing/installation-from-fork

Installs project dependencies using Yarn.

```bash
yarn
```

--------------------------------

### Deploy Example

Source: https://docs.scandipwa.com/developing-with-scandi/developer-tools/scandipwa-cli

Example of deploying the ScandiPWA app to the cloud.

```bash
 scandipwa deploy
yarn run v1.22.5
$ scandipwa-scripts build
Creating an optimized production build...
Build completed in 186.317s

Compiled successfully.
[...]
Done in 189.38s.
Build files compressed successfully.
Code upload result: OK. Code: 200
Build archive successfully removed.
Congrats, your code will be deployed in a few minutes! You can access it here: https://master.d16zgbgmy9fzgx.amplifyapp.com/
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/structure/building-blocks-summary/global-styles

Example of how to perform an HTTP GET request to query the documentation dynamically using the `ask` query parameter.

```http
GET https://docs.scandipwa.com/structure/building-blocks-summary/global-styles.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/developing-with-scandi/developer-tools

Example of how to perform an HTTP GET request to query the documentation dynamically with the 'ask' query parameter.

```http
GET https://docs.scandipwa.com/developing-with-scandi/developer-tools.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/structure/code-style

Example of how to perform an HTTP GET request to query the documentation dynamically with the 'ask' query parameter.

```HTTP
GET https://docs.scandipwa.com/structure/code-style.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/about/technical-information

Example of how to perform an HTTP GET request to query the documentation dynamically with the 'ask' query parameter.

```http
GET https://docs.scandipwa.com/about/technical-information.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/developing-with-scandi/working-with-magento/magento-troubleshooting

Example of how to perform an HTTP GET request to query documentation dynamically with the 'ask' query parameter.

```http
GET https://docs.scandipwa.com/developing-with-scandi/working-with-magento/magento-troubleshooting.md?ask=<question>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.scandipwa.com/tutorials/scandipwa-social-share/step-5-creating-extension-base-redux-store

Demonstrates how to perform an HTTP GET request to a documentation page with the 'ask' query parameter to get dynamic answers.

```HTTP
GET https://docs.scandipwa.com/tutorials/scandipwa-social-share/step-5-creating-extension-base-redux-store.md?ask=<question>
```

--------------------------------

### Querying Documentation Example

Source: https://docs.scandipwa.com/tutorials/customizing-your-theme/styling/overriding-a-components-styles

Example of how to query the documentation dynamically using the `ask` query parameter.

```http
GET https://docs.scandipwa.com/tutorials/customizing-your-theme/styling/overriding-a-components-styles.md?ask=<question>
```

--------------------------------

### Create Component Example

Source: https://docs.scandipwa.com/developing-with-scandi/developer-tools/scandipwa-cli

Example of creating a new component using the ScandiPWA CLI.

```bash
scandipwa create component HugeTitle
```

--------------------------------

### Create Query Example

Source: https://docs.scandipwa.com/developing-with-scandi/developer-tools/scandipwa-cli

Example of creating a new query helper using the ScandiPWA CLI.

```bash
scandipwa create query Weather
```

--------------------------------

### HTTP GET Request Example

Source: https://docs.scandipwa.com/developing-with-scandi/working-with-magento/graphql-query-compexity

Example of how to perform an HTTP GET request to query the documentation dynamically.

```http
GET https://docs.scandipwa.com/developing-with-scandi/working-with-magento/graphql-query-compexity.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/developing-with-scandi/override-mechanism

This example shows how to make an HTTP GET request to the documentation with an 'ask' query parameter to get dynamic information.

```HTTP
GET https://docs.scandipwa.com/developing-with-scandi/override-mechanism.md?ask=<question>
```

--------------------------------

### Deploy the App

Source: https://docs.scandipwa.com/quick-start-guide

This command deploys the Scandi app.

```bash
scandipwa deploy
```

--------------------------------

### Querying documentation dynamically

Source: https://docs.scandipwa.com/tutorials/customizing-your-theme/customizing-javascript/creating-a-new-redux-store

Example of how to perform an HTTP GET request with an 'ask' query parameter to get dynamic documentation answers.

```http
GET https://docs.scandipwa.com/tutorials/customizing-your-theme/customizing-javascript/creating-a-new-redux-store.md?ask=<question>
```

--------------------------------

### Querying Documentation

Source: https://docs.scandipwa.com/tutorials

Perform an HTTP GET request on the current page URL with the `ask` query parameter to ask a question about the documentation.

```http
GET https://docs.scandipwa.com/tutorials.md?ask=<question>
```

--------------------------------

### Runtime Executable Configuration

Source: https://docs.scandipwa.com/developing-with-scandi/developer-tools/debugging-in-chrome

Example of specifying the runtimeExecutable for the Chrome debugger when a different Chrome variant is installed.

```json
{
    "configurations": [
        {
            // [...]
            "runtimeExecutable": "/snap/bin/chromium"
        }
    ]
}
```

--------------------------------

### JSX Element Declaration

Source: https://docs.scandipwa.com/tutorials/video-tutorials/lets-talk-theory

This example shows how to declare a constant that gets assigned a JSX tag.

```javascript
const element = <h1>Hello, world!</h1>;
```

--------------------------------

### Querying Documentation

Source: https://docs.scandipwa.com/developing-with-scandi/working-with-magento/working-with-granular-cache

Example of how to query the documentation dynamically using the 'ask' query parameter.

```http
GET https://docs.scandipwa.com/developing-with-scandi/working-with-magento/working-with-granular-cache.md?ask=<question>
```

--------------------------------

### Querying Documentation

Source: https://docs.scandipwa.com/about/contributing/publishing-scandipwa

Example of how to query the documentation dynamically using an HTTP GET request with the 'ask' query parameter.

```http
GET https://docs.scandipwa.com/about/contributing/publishing-scandipwa.md?ask=<question>
```

--------------------------------

### Dynamic Documentation Query

Source: https://docs.scandipwa.com/structure/building-blocks-summary/constructing-graphql-queries

This example shows how to perform an HTTP GET request to dynamically query the documentation with a question.

```http
GET https://docs.scandipwa.com/structure/building-blocks-summary/constructing-graphql-queries.md?ask=<question>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.scandipwa.com/tutorials/deploying-native-apps

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation.

```http
GET https://docs.scandipwa.com/tutorials/deploying-native-apps.md?ask=<question>
```

--------------------------------

### Querying Documentation

Source: https://docs.scandipwa.com/tutorials/product-3d-model-extension/part-3-scandi-frontend

Example of how to query the documentation dynamically using the `ask` query parameter.

```http
GET https://docs.scandipwa.com/tutorials/product-3d-model-extension/part-3-scandi-frontend.md?ask=<question>
```

--------------------------------

### Create a 3D Model Component

Source: https://docs.scandipwa.com/tutorials/product-3d-model-extension/part-3-scandi-frontend

Command to create a new component named Product3DViewer.

```bash
scandipwa create component Product3DViewer
```

--------------------------------

### Querying documentation dynamically

Source: https://docs.scandipwa.com/structure/building-blocks-summary/components

Example of how to perform an HTTP GET request to query the documentation dynamically with an 'ask' query parameter.

```http
GET https://docs.scandipwa.com/structure/building-blocks-summary/components.md?ask=<question>
```

--------------------------------

### Querying Documentation with 'ask' Parameter

Source: https://docs.scandipwa.com/tutorials/scandipwa-social-share/step-6-extension-plugins

Demonstrates how to perform an HTTP GET request to a documentation URL with the 'ask' query parameter to get dynamic answers.

```HTTP
GET https://docs.scandipwa.com/tutorials/scandipwa-social-share/step-6-extension-plugins.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/tutorials/video-tutorials

This section explains how to query the documentation dynamically using an HTTP GET request with the 'ask' query parameter to get additional information not directly present on the page.

```HTTP
GET https://docs.scandipwa.com/tutorials/video-tutorials.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/introduction/cma-csa-and-scandipwa

Example of how to perform an HTTP GET request to query the documentation dynamically with the 'ask' query parameter.

```HTTP
GET https://docs.scandipwa.com/introduction/cma-csa-and-scandipwa.md?ask=<question>
```

--------------------------------

### Querying Documentation

Source: https://docs.scandipwa.com/developing-with-scandi/override-mechanism/extending-javascript/overriding-classes

This example shows how to perform an HTTP GET request to query the documentation dynamically with the `ask` query parameter.

```http
GET https://docs.scandipwa.com/developing-with-scandi/override-mechanism/extending-javascript/overriding-classes.md?ask=<question>
```

--------------------------------

### Querying Documentation

Source: https://docs.scandipwa.com/tutorials/accessing-magento-2-controllers/step-5-creating-plugin-and-axios-request

Example of how to query the documentation dynamically using the 'ask' query parameter.

```http
GET https://docs.scandipwa.com/tutorials/accessing-magento-2-controllers/step-5-creating-plugin-and-axios-request.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/about/data-analytics

Example of how to perform an HTTP GET request to query the documentation dynamically using the 'ask' query parameter.

```http
GET https://docs.scandipwa.com/about/data-analytics.md?ask=<question>
```

--------------------------------

### Cloning the Forked Repository

Source: https://docs.scandipwa.com/about/contributing/installation-from-fork

Clones your forked ScandiPWA repository and navigates into the directory.

```bash
# clone your fork - replace <your-username> with your github username
git clone https://github.com/<your-username>/scandipwa
cd scandipwa # move into the directory you cloned
```

--------------------------------

### WKWebView Configuration

Source: https://docs.scandipwa.com/tutorials/deploying-native-apps

Example of creating and configuring a WKWebView instance for PWA integration.

```swift
lazy var webView: WKWebView = {
        let wv = WKWebView(frame: .zero, configuration: createWebViewConfiguration())

```

--------------------------------

### Ask a question via documentation index

Source: https://docs.scandipwa.com/dev-environment/proxying-requests-to-server

Example of an HTTP GET request to the documentation index with an 'ask' parameter to query for information.

```http
GET https://docs.scandipwa.com/getting-started-1/storefront-mode/proxying-requests-to-server.md?ask=<question>
```

--------------------------------

### Querying Documentation

Source: https://docs.scandipwa.com/about

This example shows how to query the documentation dynamically by asking a question using an HTTP GET request with the 'ask' query parameter.

```HTTP
GET https://docs.scandipwa.com/about.md?ask=<question>
```

--------------------------------

### Querying Documentation

Source: https://docs.scandipwa.com/tutorials/customizing-your-theme/customizing-javascript/adding-a-section-in-my-account

Example of how to query the documentation dynamically using the 'ask' query parameter.

```http
GET https://docs.scandipwa.com/tutorials/customizing-your-theme/customizing-javascript/adding-a-section-in-my-account.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/tutorials/customizing-your-theme/customizing-javascript/adding-a-tab-on-the-product-page

Demonstrates how to perform an HTTP GET request to query the documentation dynamically with the `ask` query parameter.

```HTTP
GET https://docs.scandipwa.com/tutorials/customizing-your-theme/customizing-javascript/adding-a-tab-on-the-product-page.md?ask=<question>
```

--------------------------------

### Configuration object example

Source: https://docs.scandipwa.com/about/release-notes

Illustrates the transition from individual constants to an object-based configuration for field types.

```jsx
// FROM
const FIELD_TEXT = ...
const FIELD_FILE = ...
...

// TO
const FIELD_TYPE = {
	text: ...,
	file: ...,
  ....
};
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/roadmap

Instructions on how to query the documentation dynamically using the 'ask' query parameter.

```HTTP
GET https://docs.scandipwa.com/roadmap.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.scandipwa.com/structure/building-blocks-summary/the-util-directory

An example of how to perform an HTTP GET request to query the documentation dynamically using the `ask` query parameter.

```http
GET https://docs.scandipwa.com/structure/building-blocks-summary/the-util-directory.md?ask=<question>
```
Tokens:
Raw