@pinegrow/headless-wordpress

Pinegrow Headless Wordpress Plugin

Headless Wordpress plugin for Pinegrow ⚡️

Pinegrow Headless Wordpress Plugin provides customized visual controls, automatic data fetching from Wordpress REST API and other rich visual features customized for your Wordpress experience.

Note:

• This plugin is generally used in conjunction with the Pinegrow Vite Plugin or with the meta-framework specific Pinegrow modules for Nuxt, Quasar, Iles and Astro.
• To use Wordpress in Pinegrow apps, you require an active Wordpress Addon subscription.
•  Learn more about Vue Designer

Features

• 🎨  Visually live-design your Vite-powered Wordpress apps (Vue, Nuxt, Quasar, Iles, Astro, etc)
• ⚙️  Smartly integrates into your Vite workflow in dev-mode only
• ✨  Clean code 😃, No lock-in - You are in control of your projects and development workflow ❤️

Quick Setup

• Install: Add @pinegrow/headless-wordpress to your project

# Using npm
npm install -D @pinegrow/headless-wordpress

# Using pnpm
pnpm add -D @pinegrow/headless-wordpress

• Configure: Add wordpress along with an optional dataPath as options to liveDesigner in your config.

//vite.config.[js,ts]

export default defineConfig({
	plugins: [
		liveDesigner({
			// For options, refer to https://www.npmjs.com/package/@pinegrow/vite-plugin
			//...
			wordpress: {
				/* PinegrowWordpressModuleOptions (for more details, refer to Options section below) */
				/* Please ensure that you update the filenames and paths to accurately match those used in your project. */
				// dataPath: false, // Set to false to turn off addition of data fetching composable(s) to the project. To customize the path, set to an absolute or relative path, default is 'data/pg-wordpress/query.ts'.
			},
		}),
		//...
	],
	//...
})

//nuxt.config.ts

export default defineNuxtConfig({
	modules: [
		'@pinegrow/nuxt-module',
		//...
	],
	pinegrow: {
		liveDesigner: {
			// For options, refer to https://www.npmjs.com/package/@pinegrow/vite-plugin
			//...
			wordpress: {
				/* PinegrowWordpressModuleOptions (for more details, refer to Options section below) */
				/* Please ensure that you update the filenames and paths to accurately match those used in your project. */
				// dataPath: false, // Set to false to turn off addition of data fetching composable(s) to the project. To customize the path, set to an absolute or relative path, default is 'data/pg-wordpress/query.ts'.
			},
		},
	},
	//...
})

//iles.config.ts

import type { LiveDesignerOptions } from '@pinegrow/vite-plugin'
export default defineConfig({
  modules: [
    [
      '@pinegrow/iles-module',
      {
        liveDesigner: {
          // For options, refer to https://www.npmjs.com/package/@pinegrow/vite-plugin
          //...
          wordpress: {
            /* PinegrowWordpressModuleOptions (for more details, refer to Options section below) */
            /* Please ensure that you update the filenames and paths to accurately match those used in your project. */
			// dataPath: false, // Set to false to turn off addition of data fetching composable(s) to the project. To customize the path, set to an absolute or relative path, default is 'data/pg-wordpress/query.ts'.

          },
        } as LiveDesignerOptions,
      },
    ],
    //...
  ],
  //...
})

//astro.config.[mjs]

import { defineConfig } from 'astro/config'
import vue from '@astrojs/vue'
import Pinegrow from '@pinegrow/astro-module'

export default defineConfig({
	integrations: [
		vue(),
		Pinegrow({
			liveDesigner: {
				// For options, refer to https://www.npmjs.com/package/@pinegrow/vite-plugin
				//...
				wordpress: {
					/* PinegrowWordpressModuleOptions (for more details, refer to Options section below) */
					/* Please ensure that you update the filenames and paths to accurately match those used in your project. */
					// dataPath: false, // Set to false to turn off addition of data fetching composable(s) to the project. To customize the path, set to an absolute or relative path, default is 'data/pg-wordpress/query.ts'.
				},
			},
		}),
		//...
	],
	//...
})

• Now, open your project in your Pinegrow app (currently only Vue Designer). ✨

• Data Fetching - Pinegrow Headless Wordpress addon adds data fetching composable(s) at the location specified by the dataPath option (default: data/pg-wordpress/query.ts).

Options

interface PinegrowWordpressModuleOptions {
	/**
	 * Absolute or relative path.
	 * @default 'data/pg-wordpress/query.ts'
	 * Set to false to turn off addition of data fetching composable(s) to the project
	 */
	dataPath?: string | boolean
}

interface PinegrowWordpressModule {
	/**
	 * Pinegrow Headless Wordpress Plugin Options, added within liveDesigner in vite/nuxt/quasar/iles/astro config files
	 */
	wordpress: PinegrowWordpressModuleOptions
}

License

MIT License

Copyright (c) Pinegrow