index

Functions

studioCMSDevApps()

function studioCMSDevApps(opts?: {
  appsConfig: {
     libSQLViewer:   | boolean
        | {
        endpoint: string;
       };
     wpImporter:   | boolean
        | {
        endpoint: string;
       };
    };
  endpoint: string;
  verbose: boolean;
 }): AstroIntegration

Defined in: studiocms/packages/studiocms_devapps/src/index.ts:43

Integrates StudioCMS development applications with Astro.

Parameters

opts?

Optional configuration options for StudioCMS DevApps.

appsConfig?

{ libSQLViewer: | boolean | { endpoint: string; }; wpImporter: | boolean | { endpoint: string; }; } = AppsConfigSchema

appsConfig.libSQLViewer

| boolean | { endpoint: string; } = ...

Astro DB LibSQL Viewer App Config

appsConfig.wpImporter

| boolean | { endpoint: string; } = ...

StudioCMS WP API Importer App Config

endpoint?

string = ...

verbose?

boolean = ...

Returns

AstroIntegration

The Astro integration object for StudioCMS DevApps.

Remarks

This function sets up the StudioCMS development applications for use in an Astro project. It parses the provided options, sets up virtual imports, and adds development toolbar apps based on the configuration.

The integration is enforced to run only in development mode.

Example

import { studioCMSDevApps } from '@studiocms/devapps';

export default {
  integrations: [
    studioCMSDevApps({
      endpoint: '/api',
      appsConfig: {
        wpImporter: {
          enabled: true,
          endpoint: '/wp-import',
        },
        libSQLViewer: {
          enabled: true,
        },
      },
      verbose: true,
    }),
  ],
};

References

default

Renames and re-exports studioCMSDevApps